babylon.module.d.ts 6.6 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050155051155052155053155054155055155056155057155058155059155060155061155062155063155064155065155066155067155068155069155070155071155072155073155074155075155076155077155078155079155080155081155082155083155084155085155086155087155088155089155090155091155092155093155094155095155096155097155098155099155100155101155102155103155104155105155106155107155108155109155110155111155112155113155114155115155116155117155118155119155120155121155122155123155124155125155126155127155128155129155130155131155132155133155134155135155136155137155138155139155140155141155142155143155144155145155146155147155148155149155150155151155152155153155154155155155156155157155158155159155160155161155162155163155164155165155166155167155168155169155170155171155172155173155174155175155176155177155178155179155180155181155182155183155184155185155186155187155188155189155190155191155192155193155194155195155196155197155198155199155200155201155202155203155204155205155206155207155208155209155210155211155212155213155214155215155216155217155218155219155220155221155222155223155224155225155226155227155228155229155230155231155232155233155234155235155236155237155238155239155240155241155242155243155244155245155246155247155248155249155250155251155252155253155254155255155256155257155258155259155260155261155262155263155264155265155266155267155268155269155270155271155272155273155274155275155276155277155278155279155280155281155282155283155284155285155286155287155288155289155290155291155292155293155294155295155296155297155298155299155300155301155302155303155304155305155306155307155308155309155310155311155312155313155314155315155316155317155318155319155320155321155322155323155324155325155326155327155328155329155330155331155332155333155334155335155336155337155338155339155340155341155342155343155344155345155346155347155348155349155350155351155352155353155354155355155356155357155358155359155360155361155362155363155364155365155366155367155368155369155370155371155372155373155374155375155376155377155378155379155380155381155382155383155384155385155386155387155388155389155390155391155392155393155394155395155396155397155398155399155400155401155402155403155404155405155406155407155408155409155410155411155412155413155414155415155416155417155418155419155420155421155422155423155424155425155426155427155428155429155430155431155432155433155434155435155436155437155438155439155440155441155442155443155444155445155446155447155448155449155450155451155452155453155454155455155456155457155458155459155460155461155462155463155464155465155466155467155468155469155470155471155472155473155474155475155476155477155478155479155480155481155482155483155484155485155486155487155488155489155490155491155492155493155494155495155496155497155498155499155500155501155502155503155504155505155506155507155508155509155510155511155512155513155514155515155516155517155518155519155520155521155522155523155524155525155526155527155528155529155530155531155532155533155534155535155536155537155538155539155540155541155542155543155544155545155546155547155548155549155550155551155552155553155554155555155556155557155558155559155560155561155562155563155564155565155566155567155568155569155570155571155572155573155574155575155576155577155578155579155580155581155582155583155584155585155586155587155588155589155590155591155592155593155594155595155596155597155598155599155600155601155602155603155604155605155606155607155608155609155610155611155612155613155614155615155616155617155618155619155620155621155622155623155624155625155626155627155628155629155630155631155632155633155634155635155636155637155638155639155640155641155642155643155644155645155646155647155648155649155650155651155652155653155654155655155656155657155658155659155660155661155662155663155664155665155666155667155668155669155670155671155672155673155674155675155676155677155678155679155680155681155682155683155684155685155686155687155688155689155690155691155692155693155694155695155696155697155698155699155700155701155702155703155704155705155706155707155708155709155710155711155712155713155714155715155716155717155718155719155720155721155722155723155724155725155726155727155728155729155730155731155732155733155734155735155736155737155738155739155740155741155742155743155744155745155746155747155748155749155750155751155752155753155754155755
  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. private _time;
  64906. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  64907. brightness: number;
  64908. /** Defines the number of octaves to process */
  64909. octaves: number;
  64910. /** Defines the level of persistence (0.8 by default) */
  64911. persistence: number;
  64912. /** Gets or sets animation speed factor (default is 1) */
  64913. animationSpeedFactor: number;
  64914. /**
  64915. * Creates a new NoiseProceduralTexture
  64916. * @param name defines the name fo the texture
  64917. * @param size defines the size of the texture (default is 256)
  64918. * @param scene defines the hosting scene
  64919. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  64920. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  64921. */
  64922. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64923. private _updateShaderUniforms;
  64924. protected _getDefines(): string;
  64925. /** Generate the current state of the procedural texture */
  64926. render(useCameraPostProcess?: boolean): void;
  64927. /**
  64928. * Serializes this noise procedural texture
  64929. * @returns a serialized noise procedural texture object
  64930. */
  64931. serialize(): any;
  64932. /**
  64933. * Clone the texture.
  64934. * @returns the cloned texture
  64935. */
  64936. clone(): NoiseProceduralTexture;
  64937. /**
  64938. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  64939. * @param parsedTexture defines parsed texture data
  64940. * @param scene defines the current scene
  64941. * @param rootUrl defines the root URL containing noise procedural texture information
  64942. * @returns a parsed NoiseProceduralTexture
  64943. */
  64944. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  64945. }
  64946. }
  64947. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  64948. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  64949. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  64950. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64951. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  64952. }
  64953. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  64954. import { Nullable } from "babylonjs/types";
  64955. import { Scene } from "babylonjs/scene";
  64956. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  64957. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64958. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  64959. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64960. /**
  64961. * Raw cube texture where the raw buffers are passed in
  64962. */
  64963. export class RawCubeTexture extends CubeTexture {
  64964. /**
  64965. * Creates a cube texture where the raw buffers are passed in.
  64966. * @param scene defines the scene the texture is attached to
  64967. * @param data defines the array of data to use to create each face
  64968. * @param size defines the size of the textures
  64969. * @param format defines the format of the data
  64970. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  64971. * @param generateMipMaps defines if the engine should generate the mip levels
  64972. * @param invertY defines if data must be stored with Y axis inverted
  64973. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  64974. * @param compression defines the compression used (null by default)
  64975. */
  64976. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  64977. /**
  64978. * Updates the raw cube texture.
  64979. * @param data defines the data to store
  64980. * @param format defines the data format
  64981. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  64982. * @param invertY defines if data must be stored with Y axis inverted
  64983. * @param compression defines the compression used (null by default)
  64984. * @param level defines which level of the texture to update
  64985. */
  64986. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  64987. /**
  64988. * Updates a raw cube texture with RGBD encoded data.
  64989. * @param data defines the array of data [mipmap][face] to use to create each face
  64990. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  64991. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  64992. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  64993. * @returns a promsie that resolves when the operation is complete
  64994. */
  64995. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  64996. /**
  64997. * Clones the raw cube texture.
  64998. * @return a new cube texture
  64999. */
  65000. clone(): CubeTexture;
  65001. /** @hidden */
  65002. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  65003. }
  65004. }
  65005. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  65006. import { Scene } from "babylonjs/scene";
  65007. import { Texture } from "babylonjs/Materials/Textures/texture";
  65008. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65009. /**
  65010. * Class used to store 2D array textures containing user data
  65011. */
  65012. export class RawTexture2DArray extends Texture {
  65013. /** Gets or sets the texture format to use */
  65014. format: number;
  65015. /**
  65016. * Create a new RawTexture2DArray
  65017. * @param data defines the data of the texture
  65018. * @param width defines the width of the texture
  65019. * @param height defines the height of the texture
  65020. * @param depth defines the number of layers of the texture
  65021. * @param format defines the texture format to use
  65022. * @param scene defines the hosting scene
  65023. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65024. * @param invertY defines if texture must be stored with Y axis inverted
  65025. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65026. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65027. */
  65028. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65029. /** Gets or sets the texture format to use */
  65030. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65031. /**
  65032. * Update the texture with new data
  65033. * @param data defines the data to store in the texture
  65034. */
  65035. update(data: ArrayBufferView): void;
  65036. }
  65037. }
  65038. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  65039. import { Scene } from "babylonjs/scene";
  65040. import { Texture } from "babylonjs/Materials/Textures/texture";
  65041. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65042. /**
  65043. * Class used to store 3D textures containing user data
  65044. */
  65045. export class RawTexture3D extends Texture {
  65046. /** Gets or sets the texture format to use */
  65047. format: number;
  65048. /**
  65049. * Create a new RawTexture3D
  65050. * @param data defines the data of the texture
  65051. * @param width defines the width of the texture
  65052. * @param height defines the height of the texture
  65053. * @param depth defines the depth of the texture
  65054. * @param format defines the texture format to use
  65055. * @param scene defines the hosting scene
  65056. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65057. * @param invertY defines if texture must be stored with Y axis inverted
  65058. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65059. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65060. */
  65061. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65062. /** Gets or sets the texture format to use */
  65063. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65064. /**
  65065. * Update the texture with new data
  65066. * @param data defines the data to store in the texture
  65067. */
  65068. update(data: ArrayBufferView): void;
  65069. }
  65070. }
  65071. declare module "babylonjs/Materials/Textures/refractionTexture" {
  65072. import { Scene } from "babylonjs/scene";
  65073. import { Plane } from "babylonjs/Maths/math.plane";
  65074. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65075. /**
  65076. * Creates a refraction texture used by refraction channel of the standard material.
  65077. * It is like a mirror but to see through a material.
  65078. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65079. */
  65080. export class RefractionTexture extends RenderTargetTexture {
  65081. /**
  65082. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  65083. * 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.
  65084. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65085. */
  65086. refractionPlane: Plane;
  65087. /**
  65088. * Define how deep under the surface we should see.
  65089. */
  65090. depth: number;
  65091. /**
  65092. * Creates a refraction texture used by refraction channel of the standard material.
  65093. * It is like a mirror but to see through a material.
  65094. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65095. * @param name Define the texture name
  65096. * @param size Define the size of the underlying texture
  65097. * @param scene Define the scene the refraction belongs to
  65098. * @param generateMipMaps Define if we need to generate mips level for the refraction
  65099. */
  65100. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  65101. /**
  65102. * Clone the refraction texture.
  65103. * @returns the cloned texture
  65104. */
  65105. clone(): RefractionTexture;
  65106. /**
  65107. * Serialize the texture to a JSON representation you could use in Parse later on
  65108. * @returns the serialized JSON representation
  65109. */
  65110. serialize(): any;
  65111. }
  65112. }
  65113. declare module "babylonjs/Materials/Textures/index" {
  65114. export * from "babylonjs/Materials/Textures/baseTexture";
  65115. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  65116. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  65117. export * from "babylonjs/Materials/Textures/cubeTexture";
  65118. export * from "babylonjs/Materials/Textures/dynamicTexture";
  65119. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  65120. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  65121. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  65122. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  65123. export * from "babylonjs/Materials/Textures/internalTexture";
  65124. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  65125. export * from "babylonjs/Materials/Textures/Loaders/index";
  65126. export * from "babylonjs/Materials/Textures/mirrorTexture";
  65127. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  65128. export * from "babylonjs/Materials/Textures/Packer/index";
  65129. export * from "babylonjs/Materials/Textures/Procedurals/index";
  65130. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  65131. export * from "babylonjs/Materials/Textures/rawTexture";
  65132. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  65133. export * from "babylonjs/Materials/Textures/rawTexture3D";
  65134. export * from "babylonjs/Materials/Textures/refractionTexture";
  65135. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  65136. export * from "babylonjs/Materials/Textures/texture";
  65137. export * from "babylonjs/Materials/Textures/videoTexture";
  65138. }
  65139. declare module "babylonjs/Materials/Node/Enums/index" {
  65140. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  65141. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  65142. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  65143. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  65144. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  65145. }
  65146. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  65147. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65148. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65149. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65150. import { Mesh } from "babylonjs/Meshes/mesh";
  65151. import { Effect } from "babylonjs/Materials/effect";
  65152. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65153. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65154. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65155. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65156. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  65157. /**
  65158. * Block used to add support for vertex skinning (bones)
  65159. */
  65160. export class BonesBlock extends NodeMaterialBlock {
  65161. /**
  65162. * Creates a new BonesBlock
  65163. * @param name defines the block name
  65164. */
  65165. constructor(name: string);
  65166. /**
  65167. * Initialize the block and prepare the context for build
  65168. * @param state defines the state that will be used for the build
  65169. */
  65170. initialize(state: NodeMaterialBuildState): void;
  65171. /**
  65172. * Gets the current class name
  65173. * @returns the class name
  65174. */
  65175. getClassName(): string;
  65176. /**
  65177. * Gets the matrix indices input component
  65178. */
  65179. get matricesIndices(): NodeMaterialConnectionPoint;
  65180. /**
  65181. * Gets the matrix weights input component
  65182. */
  65183. get matricesWeights(): NodeMaterialConnectionPoint;
  65184. /**
  65185. * Gets the extra matrix indices input component
  65186. */
  65187. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  65188. /**
  65189. * Gets the extra matrix weights input component
  65190. */
  65191. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  65192. /**
  65193. * Gets the world input component
  65194. */
  65195. get world(): NodeMaterialConnectionPoint;
  65196. /**
  65197. * Gets the output component
  65198. */
  65199. get output(): NodeMaterialConnectionPoint;
  65200. autoConfigure(material: NodeMaterial): void;
  65201. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  65202. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65203. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65204. protected _buildBlock(state: NodeMaterialBuildState): this;
  65205. }
  65206. }
  65207. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  65208. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65209. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65210. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65211. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65212. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65213. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65214. /**
  65215. * Block used to add support for instances
  65216. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  65217. */
  65218. export class InstancesBlock extends NodeMaterialBlock {
  65219. /**
  65220. * Creates a new InstancesBlock
  65221. * @param name defines the block name
  65222. */
  65223. constructor(name: string);
  65224. /**
  65225. * Gets the current class name
  65226. * @returns the class name
  65227. */
  65228. getClassName(): string;
  65229. /**
  65230. * Gets the first world row input component
  65231. */
  65232. get world0(): NodeMaterialConnectionPoint;
  65233. /**
  65234. * Gets the second world row input component
  65235. */
  65236. get world1(): NodeMaterialConnectionPoint;
  65237. /**
  65238. * Gets the third world row input component
  65239. */
  65240. get world2(): NodeMaterialConnectionPoint;
  65241. /**
  65242. * Gets the forth world row input component
  65243. */
  65244. get world3(): NodeMaterialConnectionPoint;
  65245. /**
  65246. * Gets the world input component
  65247. */
  65248. get world(): NodeMaterialConnectionPoint;
  65249. /**
  65250. * Gets the output component
  65251. */
  65252. get output(): NodeMaterialConnectionPoint;
  65253. /**
  65254. * Gets the isntanceID component
  65255. */
  65256. get instanceID(): NodeMaterialConnectionPoint;
  65257. autoConfigure(material: NodeMaterial): void;
  65258. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  65259. protected _buildBlock(state: NodeMaterialBuildState): this;
  65260. }
  65261. }
  65262. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  65263. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65264. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65265. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65266. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65267. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65268. import { Effect } from "babylonjs/Materials/effect";
  65269. import { Mesh } from "babylonjs/Meshes/mesh";
  65270. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65271. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65272. /**
  65273. * Block used to add morph targets support to vertex shader
  65274. */
  65275. export class MorphTargetsBlock extends NodeMaterialBlock {
  65276. private _repeatableContentAnchor;
  65277. /**
  65278. * Create a new MorphTargetsBlock
  65279. * @param name defines the block name
  65280. */
  65281. constructor(name: string);
  65282. /**
  65283. * Gets the current class name
  65284. * @returns the class name
  65285. */
  65286. getClassName(): string;
  65287. /**
  65288. * Gets the position input component
  65289. */
  65290. get position(): NodeMaterialConnectionPoint;
  65291. /**
  65292. * Gets the normal input component
  65293. */
  65294. get normal(): NodeMaterialConnectionPoint;
  65295. /**
  65296. * Gets the tangent input component
  65297. */
  65298. get tangent(): NodeMaterialConnectionPoint;
  65299. /**
  65300. * Gets the tangent input component
  65301. */
  65302. get uv(): NodeMaterialConnectionPoint;
  65303. /**
  65304. * Gets the position output component
  65305. */
  65306. get positionOutput(): NodeMaterialConnectionPoint;
  65307. /**
  65308. * Gets the normal output component
  65309. */
  65310. get normalOutput(): NodeMaterialConnectionPoint;
  65311. /**
  65312. * Gets the tangent output component
  65313. */
  65314. get tangentOutput(): NodeMaterialConnectionPoint;
  65315. /**
  65316. * Gets the tangent output component
  65317. */
  65318. get uvOutput(): NodeMaterialConnectionPoint;
  65319. initialize(state: NodeMaterialBuildState): void;
  65320. autoConfigure(material: NodeMaterial): void;
  65321. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65322. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65323. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  65324. protected _buildBlock(state: NodeMaterialBuildState): this;
  65325. }
  65326. }
  65327. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  65328. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65329. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65330. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65331. import { Nullable } from "babylonjs/types";
  65332. import { Scene } from "babylonjs/scene";
  65333. import { Effect } from "babylonjs/Materials/effect";
  65334. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65335. import { Mesh } from "babylonjs/Meshes/mesh";
  65336. import { Light } from "babylonjs/Lights/light";
  65337. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65338. /**
  65339. * Block used to get data information from a light
  65340. */
  65341. export class LightInformationBlock extends NodeMaterialBlock {
  65342. private _lightDataUniformName;
  65343. private _lightColorUniformName;
  65344. private _lightTypeDefineName;
  65345. /**
  65346. * Gets or sets the light associated with this block
  65347. */
  65348. light: Nullable<Light>;
  65349. /**
  65350. * Creates a new LightInformationBlock
  65351. * @param name defines the block name
  65352. */
  65353. constructor(name: string);
  65354. /**
  65355. * Gets the current class name
  65356. * @returns the class name
  65357. */
  65358. getClassName(): string;
  65359. /**
  65360. * Gets the world position input component
  65361. */
  65362. get worldPosition(): NodeMaterialConnectionPoint;
  65363. /**
  65364. * Gets the direction output component
  65365. */
  65366. get direction(): NodeMaterialConnectionPoint;
  65367. /**
  65368. * Gets the direction output component
  65369. */
  65370. get color(): NodeMaterialConnectionPoint;
  65371. /**
  65372. * Gets the direction output component
  65373. */
  65374. get intensity(): NodeMaterialConnectionPoint;
  65375. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65376. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65377. protected _buildBlock(state: NodeMaterialBuildState): this;
  65378. serialize(): any;
  65379. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65380. }
  65381. }
  65382. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  65383. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  65384. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  65385. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  65386. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  65387. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  65388. }
  65389. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  65390. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65391. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65392. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65393. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65394. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65395. import { Effect } from "babylonjs/Materials/effect";
  65396. import { Mesh } from "babylonjs/Meshes/mesh";
  65397. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65398. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  65399. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  65400. /**
  65401. * Block used to add image processing support to fragment shader
  65402. */
  65403. export class ImageProcessingBlock extends NodeMaterialBlock {
  65404. /**
  65405. * Create a new ImageProcessingBlock
  65406. * @param name defines the block name
  65407. */
  65408. constructor(name: string);
  65409. /**
  65410. * Gets the current class name
  65411. * @returns the class name
  65412. */
  65413. getClassName(): string;
  65414. /**
  65415. * Gets the color input component
  65416. */
  65417. get color(): NodeMaterialConnectionPoint;
  65418. /**
  65419. * Gets the output component
  65420. */
  65421. get output(): NodeMaterialConnectionPoint;
  65422. /**
  65423. * Initialize the block and prepare the context for build
  65424. * @param state defines the state that will be used for the build
  65425. */
  65426. initialize(state: NodeMaterialBuildState): void;
  65427. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  65428. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65429. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65430. protected _buildBlock(state: NodeMaterialBuildState): this;
  65431. }
  65432. }
  65433. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  65434. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65435. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65436. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65437. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65438. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65439. import { Effect } from "babylonjs/Materials/effect";
  65440. import { Mesh } from "babylonjs/Meshes/mesh";
  65441. import { Scene } from "babylonjs/scene";
  65442. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  65443. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  65444. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  65445. /**
  65446. * Block used to pertub normals based on a normal map
  65447. */
  65448. export class PerturbNormalBlock extends NodeMaterialBlock {
  65449. private _tangentSpaceParameterName;
  65450. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  65451. invertX: boolean;
  65452. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  65453. invertY: boolean;
  65454. /**
  65455. * Create a new PerturbNormalBlock
  65456. * @param name defines the block name
  65457. */
  65458. constructor(name: string);
  65459. /**
  65460. * Gets the current class name
  65461. * @returns the class name
  65462. */
  65463. getClassName(): string;
  65464. /**
  65465. * Gets the world position input component
  65466. */
  65467. get worldPosition(): NodeMaterialConnectionPoint;
  65468. /**
  65469. * Gets the world normal input component
  65470. */
  65471. get worldNormal(): NodeMaterialConnectionPoint;
  65472. /**
  65473. * Gets the world tangent input component
  65474. */
  65475. get worldTangent(): NodeMaterialConnectionPoint;
  65476. /**
  65477. * Gets the uv input component
  65478. */
  65479. get uv(): NodeMaterialConnectionPoint;
  65480. /**
  65481. * Gets the normal map color input component
  65482. */
  65483. get normalMapColor(): NodeMaterialConnectionPoint;
  65484. /**
  65485. * Gets the strength input component
  65486. */
  65487. get strength(): NodeMaterialConnectionPoint;
  65488. /**
  65489. * Gets the output component
  65490. */
  65491. get output(): NodeMaterialConnectionPoint;
  65492. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65493. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65494. autoConfigure(material: NodeMaterial): void;
  65495. protected _buildBlock(state: NodeMaterialBuildState): this;
  65496. protected _dumpPropertiesCode(): string;
  65497. serialize(): any;
  65498. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65499. }
  65500. }
  65501. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  65502. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65503. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65504. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65505. /**
  65506. * Block used to discard a pixel if a value is smaller than a cutoff
  65507. */
  65508. export class DiscardBlock extends NodeMaterialBlock {
  65509. /**
  65510. * Create a new DiscardBlock
  65511. * @param name defines the block name
  65512. */
  65513. constructor(name: string);
  65514. /**
  65515. * Gets the current class name
  65516. * @returns the class name
  65517. */
  65518. getClassName(): string;
  65519. /**
  65520. * Gets the color input component
  65521. */
  65522. get value(): NodeMaterialConnectionPoint;
  65523. /**
  65524. * Gets the cutoff input component
  65525. */
  65526. get cutoff(): NodeMaterialConnectionPoint;
  65527. protected _buildBlock(state: NodeMaterialBuildState): this;
  65528. }
  65529. }
  65530. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  65531. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65532. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65533. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65534. /**
  65535. * Block used to test if the fragment shader is front facing
  65536. */
  65537. export class FrontFacingBlock extends NodeMaterialBlock {
  65538. /**
  65539. * Creates a new FrontFacingBlock
  65540. * @param name defines the block name
  65541. */
  65542. constructor(name: string);
  65543. /**
  65544. * Gets the current class name
  65545. * @returns the class name
  65546. */
  65547. getClassName(): string;
  65548. /**
  65549. * Gets the output component
  65550. */
  65551. get output(): NodeMaterialConnectionPoint;
  65552. protected _buildBlock(state: NodeMaterialBuildState): this;
  65553. }
  65554. }
  65555. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  65556. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65557. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65558. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65559. /**
  65560. * Block used to get the derivative value on x and y of a given input
  65561. */
  65562. export class DerivativeBlock extends NodeMaterialBlock {
  65563. /**
  65564. * Create a new DerivativeBlock
  65565. * @param name defines the block name
  65566. */
  65567. constructor(name: string);
  65568. /**
  65569. * Gets the current class name
  65570. * @returns the class name
  65571. */
  65572. getClassName(): string;
  65573. /**
  65574. * Gets the input component
  65575. */
  65576. get input(): NodeMaterialConnectionPoint;
  65577. /**
  65578. * Gets the derivative output on x
  65579. */
  65580. get dx(): NodeMaterialConnectionPoint;
  65581. /**
  65582. * Gets the derivative output on y
  65583. */
  65584. get dy(): NodeMaterialConnectionPoint;
  65585. protected _buildBlock(state: NodeMaterialBuildState): this;
  65586. }
  65587. }
  65588. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  65589. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65590. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65591. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65592. /**
  65593. * Block used to make gl_FragCoord available
  65594. */
  65595. export class FragCoordBlock extends NodeMaterialBlock {
  65596. /**
  65597. * Creates a new FragCoordBlock
  65598. * @param name defines the block name
  65599. */
  65600. constructor(name: string);
  65601. /**
  65602. * Gets the current class name
  65603. * @returns the class name
  65604. */
  65605. getClassName(): string;
  65606. /**
  65607. * Gets the xy component
  65608. */
  65609. get xy(): NodeMaterialConnectionPoint;
  65610. /**
  65611. * Gets the xyz component
  65612. */
  65613. get xyz(): NodeMaterialConnectionPoint;
  65614. /**
  65615. * Gets the xyzw component
  65616. */
  65617. get xyzw(): NodeMaterialConnectionPoint;
  65618. /**
  65619. * Gets the x component
  65620. */
  65621. get x(): NodeMaterialConnectionPoint;
  65622. /**
  65623. * Gets the y component
  65624. */
  65625. get y(): NodeMaterialConnectionPoint;
  65626. /**
  65627. * Gets the z component
  65628. */
  65629. get z(): NodeMaterialConnectionPoint;
  65630. /**
  65631. * Gets the w component
  65632. */
  65633. get output(): NodeMaterialConnectionPoint;
  65634. protected writeOutputs(state: NodeMaterialBuildState): string;
  65635. protected _buildBlock(state: NodeMaterialBuildState): this;
  65636. }
  65637. }
  65638. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  65639. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65640. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65641. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65642. import { Effect } from "babylonjs/Materials/effect";
  65643. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65644. import { Mesh } from "babylonjs/Meshes/mesh";
  65645. /**
  65646. * Block used to get the screen sizes
  65647. */
  65648. export class ScreenSizeBlock extends NodeMaterialBlock {
  65649. private _varName;
  65650. private _scene;
  65651. /**
  65652. * Creates a new ScreenSizeBlock
  65653. * @param name defines the block name
  65654. */
  65655. constructor(name: string);
  65656. /**
  65657. * Gets the current class name
  65658. * @returns the class name
  65659. */
  65660. getClassName(): string;
  65661. /**
  65662. * Gets the xy component
  65663. */
  65664. get xy(): NodeMaterialConnectionPoint;
  65665. /**
  65666. * Gets the x component
  65667. */
  65668. get x(): NodeMaterialConnectionPoint;
  65669. /**
  65670. * Gets the y component
  65671. */
  65672. get y(): NodeMaterialConnectionPoint;
  65673. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65674. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  65675. protected _buildBlock(state: NodeMaterialBuildState): this;
  65676. }
  65677. }
  65678. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  65679. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  65680. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  65681. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  65682. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  65683. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  65684. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  65685. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  65686. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  65687. }
  65688. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  65689. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65690. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65691. import { Mesh } from "babylonjs/Meshes/mesh";
  65692. import { Effect } from "babylonjs/Materials/effect";
  65693. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65694. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65695. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65696. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  65697. /**
  65698. * Block used to add support for scene fog
  65699. */
  65700. export class FogBlock extends NodeMaterialBlock {
  65701. private _fogDistanceName;
  65702. private _fogParameters;
  65703. /**
  65704. * Create a new FogBlock
  65705. * @param name defines the block name
  65706. */
  65707. constructor(name: string);
  65708. /**
  65709. * Gets the current class name
  65710. * @returns the class name
  65711. */
  65712. getClassName(): string;
  65713. /**
  65714. * Gets the world position input component
  65715. */
  65716. get worldPosition(): NodeMaterialConnectionPoint;
  65717. /**
  65718. * Gets the view input component
  65719. */
  65720. get view(): NodeMaterialConnectionPoint;
  65721. /**
  65722. * Gets the color input component
  65723. */
  65724. get input(): NodeMaterialConnectionPoint;
  65725. /**
  65726. * Gets the fog color input component
  65727. */
  65728. get fogColor(): NodeMaterialConnectionPoint;
  65729. /**
  65730. * Gets the output component
  65731. */
  65732. get output(): NodeMaterialConnectionPoint;
  65733. autoConfigure(material: NodeMaterial): void;
  65734. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65735. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65736. protected _buildBlock(state: NodeMaterialBuildState): this;
  65737. }
  65738. }
  65739. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  65740. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65741. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65742. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65743. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65744. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65745. import { Effect } from "babylonjs/Materials/effect";
  65746. import { Mesh } from "babylonjs/Meshes/mesh";
  65747. import { Light } from "babylonjs/Lights/light";
  65748. import { Nullable } from "babylonjs/types";
  65749. import { Scene } from "babylonjs/scene";
  65750. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  65751. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  65752. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  65753. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65754. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  65755. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  65756. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  65757. /**
  65758. * Block used to add light in the fragment shader
  65759. */
  65760. export class LightBlock extends NodeMaterialBlock {
  65761. private _lightId;
  65762. /**
  65763. * Gets or sets the light associated with this block
  65764. */
  65765. light: Nullable<Light>;
  65766. /**
  65767. * Create a new LightBlock
  65768. * @param name defines the block name
  65769. */
  65770. constructor(name: string);
  65771. /**
  65772. * Gets the current class name
  65773. * @returns the class name
  65774. */
  65775. getClassName(): string;
  65776. /**
  65777. * Gets the world position input component
  65778. */
  65779. get worldPosition(): NodeMaterialConnectionPoint;
  65780. /**
  65781. * Gets the world normal input component
  65782. */
  65783. get worldNormal(): NodeMaterialConnectionPoint;
  65784. /**
  65785. * Gets the camera (or eye) position component
  65786. */
  65787. get cameraPosition(): NodeMaterialConnectionPoint;
  65788. /**
  65789. * Gets the glossiness component
  65790. */
  65791. get glossiness(): NodeMaterialConnectionPoint;
  65792. /**
  65793. * Gets the glossinness power component
  65794. */
  65795. get glossPower(): NodeMaterialConnectionPoint;
  65796. /**
  65797. * Gets the diffuse color component
  65798. */
  65799. get diffuseColor(): NodeMaterialConnectionPoint;
  65800. /**
  65801. * Gets the specular color component
  65802. */
  65803. get specularColor(): NodeMaterialConnectionPoint;
  65804. /**
  65805. * Gets the diffuse output component
  65806. */
  65807. get diffuseOutput(): NodeMaterialConnectionPoint;
  65808. /**
  65809. * Gets the specular output component
  65810. */
  65811. get specularOutput(): NodeMaterialConnectionPoint;
  65812. /**
  65813. * Gets the shadow output component
  65814. */
  65815. get shadow(): NodeMaterialConnectionPoint;
  65816. autoConfigure(material: NodeMaterial): void;
  65817. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65818. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  65819. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65820. private _injectVertexCode;
  65821. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65822. serialize(): any;
  65823. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65824. }
  65825. }
  65826. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  65827. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65828. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65829. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65830. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  65831. /**
  65832. * Block used to read a reflection texture from a sampler
  65833. */
  65834. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  65835. /**
  65836. * Create a new ReflectionTextureBlock
  65837. * @param name defines the block name
  65838. */
  65839. constructor(name: string);
  65840. /**
  65841. * Gets the current class name
  65842. * @returns the class name
  65843. */
  65844. getClassName(): string;
  65845. /**
  65846. * Gets the world position input component
  65847. */
  65848. get position(): NodeMaterialConnectionPoint;
  65849. /**
  65850. * Gets the world position input component
  65851. */
  65852. get worldPosition(): NodeMaterialConnectionPoint;
  65853. /**
  65854. * Gets the world normal input component
  65855. */
  65856. get worldNormal(): NodeMaterialConnectionPoint;
  65857. /**
  65858. * Gets the world input component
  65859. */
  65860. get world(): NodeMaterialConnectionPoint;
  65861. /**
  65862. * Gets the camera (or eye) position component
  65863. */
  65864. get cameraPosition(): NodeMaterialConnectionPoint;
  65865. /**
  65866. * Gets the view input component
  65867. */
  65868. get view(): NodeMaterialConnectionPoint;
  65869. /**
  65870. * Gets the rgb output component
  65871. */
  65872. get rgb(): NodeMaterialConnectionPoint;
  65873. /**
  65874. * Gets the rgba output component
  65875. */
  65876. get rgba(): NodeMaterialConnectionPoint;
  65877. /**
  65878. * Gets the r output component
  65879. */
  65880. get r(): NodeMaterialConnectionPoint;
  65881. /**
  65882. * Gets the g output component
  65883. */
  65884. get g(): NodeMaterialConnectionPoint;
  65885. /**
  65886. * Gets the b output component
  65887. */
  65888. get b(): NodeMaterialConnectionPoint;
  65889. /**
  65890. * Gets the a output component
  65891. */
  65892. get a(): NodeMaterialConnectionPoint;
  65893. autoConfigure(material: NodeMaterial): void;
  65894. protected _buildBlock(state: NodeMaterialBuildState): this;
  65895. }
  65896. }
  65897. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  65898. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  65899. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  65900. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  65901. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  65902. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  65903. }
  65904. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  65905. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  65906. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  65907. }
  65908. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  65909. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65910. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65911. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65912. /**
  65913. * Block used to add 2 vectors
  65914. */
  65915. export class AddBlock extends NodeMaterialBlock {
  65916. /**
  65917. * Creates a new AddBlock
  65918. * @param name defines the block name
  65919. */
  65920. constructor(name: string);
  65921. /**
  65922. * Gets the current class name
  65923. * @returns the class name
  65924. */
  65925. getClassName(): string;
  65926. /**
  65927. * Gets the left operand input component
  65928. */
  65929. get left(): NodeMaterialConnectionPoint;
  65930. /**
  65931. * Gets the right operand input component
  65932. */
  65933. get right(): NodeMaterialConnectionPoint;
  65934. /**
  65935. * Gets the output component
  65936. */
  65937. get output(): NodeMaterialConnectionPoint;
  65938. protected _buildBlock(state: NodeMaterialBuildState): this;
  65939. }
  65940. }
  65941. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  65942. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65943. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65944. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65945. /**
  65946. * Block used to scale a vector by a float
  65947. */
  65948. export class ScaleBlock extends NodeMaterialBlock {
  65949. /**
  65950. * Creates a new ScaleBlock
  65951. * @param name defines the block name
  65952. */
  65953. constructor(name: string);
  65954. /**
  65955. * Gets the current class name
  65956. * @returns the class name
  65957. */
  65958. getClassName(): string;
  65959. /**
  65960. * Gets the input component
  65961. */
  65962. get input(): NodeMaterialConnectionPoint;
  65963. /**
  65964. * Gets the factor input component
  65965. */
  65966. get factor(): NodeMaterialConnectionPoint;
  65967. /**
  65968. * Gets the output component
  65969. */
  65970. get output(): NodeMaterialConnectionPoint;
  65971. protected _buildBlock(state: NodeMaterialBuildState): this;
  65972. }
  65973. }
  65974. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  65975. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65976. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65977. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65978. import { Scene } from "babylonjs/scene";
  65979. /**
  65980. * Block used to clamp a float
  65981. */
  65982. export class ClampBlock extends NodeMaterialBlock {
  65983. /** Gets or sets the minimum range */
  65984. minimum: number;
  65985. /** Gets or sets the maximum range */
  65986. maximum: number;
  65987. /**
  65988. * Creates a new ClampBlock
  65989. * @param name defines the block name
  65990. */
  65991. constructor(name: string);
  65992. /**
  65993. * Gets the current class name
  65994. * @returns the class name
  65995. */
  65996. getClassName(): string;
  65997. /**
  65998. * Gets the value input component
  65999. */
  66000. get value(): NodeMaterialConnectionPoint;
  66001. /**
  66002. * Gets the output component
  66003. */
  66004. get output(): NodeMaterialConnectionPoint;
  66005. protected _buildBlock(state: NodeMaterialBuildState): this;
  66006. protected _dumpPropertiesCode(): string;
  66007. serialize(): any;
  66008. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66009. }
  66010. }
  66011. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  66012. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66013. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66014. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66015. /**
  66016. * Block used to apply a cross product between 2 vectors
  66017. */
  66018. export class CrossBlock extends NodeMaterialBlock {
  66019. /**
  66020. * Creates a new CrossBlock
  66021. * @param name defines the block name
  66022. */
  66023. constructor(name: string);
  66024. /**
  66025. * Gets the current class name
  66026. * @returns the class name
  66027. */
  66028. getClassName(): string;
  66029. /**
  66030. * Gets the left operand input component
  66031. */
  66032. get left(): NodeMaterialConnectionPoint;
  66033. /**
  66034. * Gets the right operand input component
  66035. */
  66036. get right(): NodeMaterialConnectionPoint;
  66037. /**
  66038. * Gets the output component
  66039. */
  66040. get output(): NodeMaterialConnectionPoint;
  66041. protected _buildBlock(state: NodeMaterialBuildState): this;
  66042. }
  66043. }
  66044. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  66045. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66046. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66047. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66048. /**
  66049. * Block used to apply a dot product between 2 vectors
  66050. */
  66051. export class DotBlock extends NodeMaterialBlock {
  66052. /**
  66053. * Creates a new DotBlock
  66054. * @param name defines the block name
  66055. */
  66056. constructor(name: string);
  66057. /**
  66058. * Gets the current class name
  66059. * @returns the class name
  66060. */
  66061. getClassName(): string;
  66062. /**
  66063. * Gets the left operand input component
  66064. */
  66065. get left(): NodeMaterialConnectionPoint;
  66066. /**
  66067. * Gets the right operand input component
  66068. */
  66069. get right(): NodeMaterialConnectionPoint;
  66070. /**
  66071. * Gets the output component
  66072. */
  66073. get output(): NodeMaterialConnectionPoint;
  66074. protected _buildBlock(state: NodeMaterialBuildState): this;
  66075. }
  66076. }
  66077. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  66078. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66079. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66080. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66081. /**
  66082. * Block used to normalize a vector
  66083. */
  66084. export class NormalizeBlock extends NodeMaterialBlock {
  66085. /**
  66086. * Creates a new NormalizeBlock
  66087. * @param name defines the block name
  66088. */
  66089. constructor(name: string);
  66090. /**
  66091. * Gets the current class name
  66092. * @returns the class name
  66093. */
  66094. getClassName(): string;
  66095. /**
  66096. * Gets the input component
  66097. */
  66098. get input(): NodeMaterialConnectionPoint;
  66099. /**
  66100. * Gets the output component
  66101. */
  66102. get output(): NodeMaterialConnectionPoint;
  66103. protected _buildBlock(state: NodeMaterialBuildState): this;
  66104. }
  66105. }
  66106. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  66107. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66108. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66109. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66110. import { Scene } from "babylonjs/scene";
  66111. /**
  66112. * Operations supported by the Trigonometry block
  66113. */
  66114. export enum TrigonometryBlockOperations {
  66115. /** Cos */
  66116. Cos = 0,
  66117. /** Sin */
  66118. Sin = 1,
  66119. /** Abs */
  66120. Abs = 2,
  66121. /** Exp */
  66122. Exp = 3,
  66123. /** Exp2 */
  66124. Exp2 = 4,
  66125. /** Round */
  66126. Round = 5,
  66127. /** Floor */
  66128. Floor = 6,
  66129. /** Ceiling */
  66130. Ceiling = 7,
  66131. /** Square root */
  66132. Sqrt = 8,
  66133. /** Log */
  66134. Log = 9,
  66135. /** Tangent */
  66136. Tan = 10,
  66137. /** Arc tangent */
  66138. ArcTan = 11,
  66139. /** Arc cosinus */
  66140. ArcCos = 12,
  66141. /** Arc sinus */
  66142. ArcSin = 13,
  66143. /** Fraction */
  66144. Fract = 14,
  66145. /** Sign */
  66146. Sign = 15,
  66147. /** To radians (from degrees) */
  66148. Radians = 16,
  66149. /** To degrees (from radians) */
  66150. Degrees = 17
  66151. }
  66152. /**
  66153. * Block used to apply trigonometry operation to floats
  66154. */
  66155. export class TrigonometryBlock extends NodeMaterialBlock {
  66156. /**
  66157. * Gets or sets the operation applied by the block
  66158. */
  66159. operation: TrigonometryBlockOperations;
  66160. /**
  66161. * Creates a new TrigonometryBlock
  66162. * @param name defines the block name
  66163. */
  66164. constructor(name: string);
  66165. /**
  66166. * Gets the current class name
  66167. * @returns the class name
  66168. */
  66169. getClassName(): string;
  66170. /**
  66171. * Gets the input component
  66172. */
  66173. get input(): NodeMaterialConnectionPoint;
  66174. /**
  66175. * Gets the output component
  66176. */
  66177. get output(): NodeMaterialConnectionPoint;
  66178. protected _buildBlock(state: NodeMaterialBuildState): this;
  66179. serialize(): any;
  66180. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66181. protected _dumpPropertiesCode(): string;
  66182. }
  66183. }
  66184. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  66185. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66186. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66187. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66188. /**
  66189. * Block used to create a Color3/4 out of individual inputs (one for each component)
  66190. */
  66191. export class ColorMergerBlock extends NodeMaterialBlock {
  66192. /**
  66193. * Create a new ColorMergerBlock
  66194. * @param name defines the block name
  66195. */
  66196. constructor(name: string);
  66197. /**
  66198. * Gets the current class name
  66199. * @returns the class name
  66200. */
  66201. getClassName(): string;
  66202. /**
  66203. * Gets the rgb component (input)
  66204. */
  66205. get rgbIn(): NodeMaterialConnectionPoint;
  66206. /**
  66207. * Gets the r component (input)
  66208. */
  66209. get r(): NodeMaterialConnectionPoint;
  66210. /**
  66211. * Gets the g component (input)
  66212. */
  66213. get g(): NodeMaterialConnectionPoint;
  66214. /**
  66215. * Gets the b component (input)
  66216. */
  66217. get b(): NodeMaterialConnectionPoint;
  66218. /**
  66219. * Gets the a component (input)
  66220. */
  66221. get a(): NodeMaterialConnectionPoint;
  66222. /**
  66223. * Gets the rgba component (output)
  66224. */
  66225. get rgba(): NodeMaterialConnectionPoint;
  66226. /**
  66227. * Gets the rgb component (output)
  66228. */
  66229. get rgbOut(): NodeMaterialConnectionPoint;
  66230. /**
  66231. * Gets the rgb component (output)
  66232. * @deprecated Please use rgbOut instead.
  66233. */
  66234. get rgb(): NodeMaterialConnectionPoint;
  66235. protected _buildBlock(state: NodeMaterialBuildState): this;
  66236. }
  66237. }
  66238. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  66239. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66240. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66241. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66242. /**
  66243. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  66244. */
  66245. export class VectorSplitterBlock extends NodeMaterialBlock {
  66246. /**
  66247. * Create a new VectorSplitterBlock
  66248. * @param name defines the block name
  66249. */
  66250. constructor(name: string);
  66251. /**
  66252. * Gets the current class name
  66253. * @returns the class name
  66254. */
  66255. getClassName(): string;
  66256. /**
  66257. * Gets the xyzw component (input)
  66258. */
  66259. get xyzw(): NodeMaterialConnectionPoint;
  66260. /**
  66261. * Gets the xyz component (input)
  66262. */
  66263. get xyzIn(): NodeMaterialConnectionPoint;
  66264. /**
  66265. * Gets the xy component (input)
  66266. */
  66267. get xyIn(): NodeMaterialConnectionPoint;
  66268. /**
  66269. * Gets the xyz component (output)
  66270. */
  66271. get xyzOut(): NodeMaterialConnectionPoint;
  66272. /**
  66273. * Gets the xy component (output)
  66274. */
  66275. get xyOut(): NodeMaterialConnectionPoint;
  66276. /**
  66277. * Gets the x component (output)
  66278. */
  66279. get x(): NodeMaterialConnectionPoint;
  66280. /**
  66281. * Gets the y component (output)
  66282. */
  66283. get y(): NodeMaterialConnectionPoint;
  66284. /**
  66285. * Gets the z component (output)
  66286. */
  66287. get z(): NodeMaterialConnectionPoint;
  66288. /**
  66289. * Gets the w component (output)
  66290. */
  66291. get w(): NodeMaterialConnectionPoint;
  66292. protected _inputRename(name: string): string;
  66293. protected _outputRename(name: string): string;
  66294. protected _buildBlock(state: NodeMaterialBuildState): this;
  66295. }
  66296. }
  66297. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  66298. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66299. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66300. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66301. /**
  66302. * Block used to lerp between 2 values
  66303. */
  66304. export class LerpBlock extends NodeMaterialBlock {
  66305. /**
  66306. * Creates a new LerpBlock
  66307. * @param name defines the block name
  66308. */
  66309. constructor(name: string);
  66310. /**
  66311. * Gets the current class name
  66312. * @returns the class name
  66313. */
  66314. getClassName(): string;
  66315. /**
  66316. * Gets the left operand input component
  66317. */
  66318. get left(): NodeMaterialConnectionPoint;
  66319. /**
  66320. * Gets the right operand input component
  66321. */
  66322. get right(): NodeMaterialConnectionPoint;
  66323. /**
  66324. * Gets the gradient operand input component
  66325. */
  66326. get gradient(): NodeMaterialConnectionPoint;
  66327. /**
  66328. * Gets the output component
  66329. */
  66330. get output(): NodeMaterialConnectionPoint;
  66331. protected _buildBlock(state: NodeMaterialBuildState): this;
  66332. }
  66333. }
  66334. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  66335. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66336. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66337. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66338. /**
  66339. * Block used to divide 2 vectors
  66340. */
  66341. export class DivideBlock extends NodeMaterialBlock {
  66342. /**
  66343. * Creates a new DivideBlock
  66344. * @param name defines the block name
  66345. */
  66346. constructor(name: string);
  66347. /**
  66348. * Gets the current class name
  66349. * @returns the class name
  66350. */
  66351. getClassName(): string;
  66352. /**
  66353. * Gets the left operand input component
  66354. */
  66355. get left(): NodeMaterialConnectionPoint;
  66356. /**
  66357. * Gets the right operand input component
  66358. */
  66359. get right(): NodeMaterialConnectionPoint;
  66360. /**
  66361. * Gets the output component
  66362. */
  66363. get output(): NodeMaterialConnectionPoint;
  66364. protected _buildBlock(state: NodeMaterialBuildState): this;
  66365. }
  66366. }
  66367. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  66368. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66369. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66370. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66371. /**
  66372. * Block used to subtract 2 vectors
  66373. */
  66374. export class SubtractBlock extends NodeMaterialBlock {
  66375. /**
  66376. * Creates a new SubtractBlock
  66377. * @param name defines the block name
  66378. */
  66379. constructor(name: string);
  66380. /**
  66381. * Gets the current class name
  66382. * @returns the class name
  66383. */
  66384. getClassName(): string;
  66385. /**
  66386. * Gets the left operand input component
  66387. */
  66388. get left(): NodeMaterialConnectionPoint;
  66389. /**
  66390. * Gets the right operand input component
  66391. */
  66392. get right(): NodeMaterialConnectionPoint;
  66393. /**
  66394. * Gets the output component
  66395. */
  66396. get output(): NodeMaterialConnectionPoint;
  66397. protected _buildBlock(state: NodeMaterialBuildState): this;
  66398. }
  66399. }
  66400. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  66401. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66402. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66403. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66404. /**
  66405. * Block used to step a value
  66406. */
  66407. export class StepBlock extends NodeMaterialBlock {
  66408. /**
  66409. * Creates a new StepBlock
  66410. * @param name defines the block name
  66411. */
  66412. constructor(name: string);
  66413. /**
  66414. * Gets the current class name
  66415. * @returns the class name
  66416. */
  66417. getClassName(): string;
  66418. /**
  66419. * Gets the value operand input component
  66420. */
  66421. get value(): NodeMaterialConnectionPoint;
  66422. /**
  66423. * Gets the edge operand input component
  66424. */
  66425. get edge(): NodeMaterialConnectionPoint;
  66426. /**
  66427. * Gets the output component
  66428. */
  66429. get output(): NodeMaterialConnectionPoint;
  66430. protected _buildBlock(state: NodeMaterialBuildState): this;
  66431. }
  66432. }
  66433. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  66434. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66435. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66436. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66437. /**
  66438. * Block used to get the opposite (1 - x) of a value
  66439. */
  66440. export class OneMinusBlock extends NodeMaterialBlock {
  66441. /**
  66442. * Creates a new OneMinusBlock
  66443. * @param name defines the block name
  66444. */
  66445. constructor(name: string);
  66446. /**
  66447. * Gets the current class name
  66448. * @returns the class name
  66449. */
  66450. getClassName(): string;
  66451. /**
  66452. * Gets the input component
  66453. */
  66454. get input(): NodeMaterialConnectionPoint;
  66455. /**
  66456. * Gets the output component
  66457. */
  66458. get output(): NodeMaterialConnectionPoint;
  66459. protected _buildBlock(state: NodeMaterialBuildState): this;
  66460. }
  66461. }
  66462. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  66463. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66464. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66465. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66466. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66467. /**
  66468. * Block used to get the view direction
  66469. */
  66470. export class ViewDirectionBlock extends NodeMaterialBlock {
  66471. /**
  66472. * Creates a new ViewDirectionBlock
  66473. * @param name defines the block name
  66474. */
  66475. constructor(name: string);
  66476. /**
  66477. * Gets the current class name
  66478. * @returns the class name
  66479. */
  66480. getClassName(): string;
  66481. /**
  66482. * Gets the world position component
  66483. */
  66484. get worldPosition(): NodeMaterialConnectionPoint;
  66485. /**
  66486. * Gets the camera position component
  66487. */
  66488. get cameraPosition(): NodeMaterialConnectionPoint;
  66489. /**
  66490. * Gets the output component
  66491. */
  66492. get output(): NodeMaterialConnectionPoint;
  66493. autoConfigure(material: NodeMaterial): void;
  66494. protected _buildBlock(state: NodeMaterialBuildState): this;
  66495. }
  66496. }
  66497. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  66498. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66499. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66500. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66501. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66502. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  66503. /**
  66504. * Block used to compute fresnel value
  66505. */
  66506. export class FresnelBlock extends NodeMaterialBlock {
  66507. /**
  66508. * Create a new FresnelBlock
  66509. * @param name defines the block name
  66510. */
  66511. constructor(name: string);
  66512. /**
  66513. * Gets the current class name
  66514. * @returns the class name
  66515. */
  66516. getClassName(): string;
  66517. /**
  66518. * Gets the world normal input component
  66519. */
  66520. get worldNormal(): NodeMaterialConnectionPoint;
  66521. /**
  66522. * Gets the view direction input component
  66523. */
  66524. get viewDirection(): NodeMaterialConnectionPoint;
  66525. /**
  66526. * Gets the bias input component
  66527. */
  66528. get bias(): NodeMaterialConnectionPoint;
  66529. /**
  66530. * Gets the camera (or eye) position component
  66531. */
  66532. get power(): NodeMaterialConnectionPoint;
  66533. /**
  66534. * Gets the fresnel output component
  66535. */
  66536. get fresnel(): NodeMaterialConnectionPoint;
  66537. autoConfigure(material: NodeMaterial): void;
  66538. protected _buildBlock(state: NodeMaterialBuildState): this;
  66539. }
  66540. }
  66541. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  66542. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66543. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66544. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66545. /**
  66546. * Block used to get the max of 2 values
  66547. */
  66548. export class MaxBlock extends NodeMaterialBlock {
  66549. /**
  66550. * Creates a new MaxBlock
  66551. * @param name defines the block name
  66552. */
  66553. constructor(name: string);
  66554. /**
  66555. * Gets the current class name
  66556. * @returns the class name
  66557. */
  66558. getClassName(): string;
  66559. /**
  66560. * Gets the left operand input component
  66561. */
  66562. get left(): NodeMaterialConnectionPoint;
  66563. /**
  66564. * Gets the right operand input component
  66565. */
  66566. get right(): NodeMaterialConnectionPoint;
  66567. /**
  66568. * Gets the output component
  66569. */
  66570. get output(): NodeMaterialConnectionPoint;
  66571. protected _buildBlock(state: NodeMaterialBuildState): this;
  66572. }
  66573. }
  66574. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  66575. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66576. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66577. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66578. /**
  66579. * Block used to get the min of 2 values
  66580. */
  66581. export class MinBlock extends NodeMaterialBlock {
  66582. /**
  66583. * Creates a new MinBlock
  66584. * @param name defines the block name
  66585. */
  66586. constructor(name: string);
  66587. /**
  66588. * Gets the current class name
  66589. * @returns the class name
  66590. */
  66591. getClassName(): string;
  66592. /**
  66593. * Gets the left operand input component
  66594. */
  66595. get left(): NodeMaterialConnectionPoint;
  66596. /**
  66597. * Gets the right operand input component
  66598. */
  66599. get right(): NodeMaterialConnectionPoint;
  66600. /**
  66601. * Gets the output component
  66602. */
  66603. get output(): NodeMaterialConnectionPoint;
  66604. protected _buildBlock(state: NodeMaterialBuildState): this;
  66605. }
  66606. }
  66607. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  66608. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66609. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66610. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66611. /**
  66612. * Block used to get the distance between 2 values
  66613. */
  66614. export class DistanceBlock extends NodeMaterialBlock {
  66615. /**
  66616. * Creates a new DistanceBlock
  66617. * @param name defines the block name
  66618. */
  66619. constructor(name: string);
  66620. /**
  66621. * Gets the current class name
  66622. * @returns the class name
  66623. */
  66624. getClassName(): string;
  66625. /**
  66626. * Gets the left operand input component
  66627. */
  66628. get left(): NodeMaterialConnectionPoint;
  66629. /**
  66630. * Gets the right operand input component
  66631. */
  66632. get right(): NodeMaterialConnectionPoint;
  66633. /**
  66634. * Gets the output component
  66635. */
  66636. get output(): NodeMaterialConnectionPoint;
  66637. protected _buildBlock(state: NodeMaterialBuildState): this;
  66638. }
  66639. }
  66640. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  66641. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66642. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66643. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66644. /**
  66645. * Block used to get the length of a vector
  66646. */
  66647. export class LengthBlock extends NodeMaterialBlock {
  66648. /**
  66649. * Creates a new LengthBlock
  66650. * @param name defines the block name
  66651. */
  66652. constructor(name: string);
  66653. /**
  66654. * Gets the current class name
  66655. * @returns the class name
  66656. */
  66657. getClassName(): string;
  66658. /**
  66659. * Gets the value input component
  66660. */
  66661. get value(): NodeMaterialConnectionPoint;
  66662. /**
  66663. * Gets the output component
  66664. */
  66665. get output(): NodeMaterialConnectionPoint;
  66666. protected _buildBlock(state: NodeMaterialBuildState): this;
  66667. }
  66668. }
  66669. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  66670. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66671. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66672. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66673. /**
  66674. * Block used to get negative version of a value (i.e. x * -1)
  66675. */
  66676. export class NegateBlock extends NodeMaterialBlock {
  66677. /**
  66678. * Creates a new NegateBlock
  66679. * @param name defines the block name
  66680. */
  66681. constructor(name: string);
  66682. /**
  66683. * Gets the current class name
  66684. * @returns the class name
  66685. */
  66686. getClassName(): string;
  66687. /**
  66688. * Gets the value input component
  66689. */
  66690. get value(): NodeMaterialConnectionPoint;
  66691. /**
  66692. * Gets the output component
  66693. */
  66694. get output(): NodeMaterialConnectionPoint;
  66695. protected _buildBlock(state: NodeMaterialBuildState): this;
  66696. }
  66697. }
  66698. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  66699. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66700. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66701. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66702. /**
  66703. * Block used to get the value of the first parameter raised to the power of the second
  66704. */
  66705. export class PowBlock extends NodeMaterialBlock {
  66706. /**
  66707. * Creates a new PowBlock
  66708. * @param name defines the block name
  66709. */
  66710. constructor(name: string);
  66711. /**
  66712. * Gets the current class name
  66713. * @returns the class name
  66714. */
  66715. getClassName(): string;
  66716. /**
  66717. * Gets the value operand input component
  66718. */
  66719. get value(): NodeMaterialConnectionPoint;
  66720. /**
  66721. * Gets the power operand input component
  66722. */
  66723. get power(): NodeMaterialConnectionPoint;
  66724. /**
  66725. * Gets the output component
  66726. */
  66727. get output(): NodeMaterialConnectionPoint;
  66728. protected _buildBlock(state: NodeMaterialBuildState): this;
  66729. }
  66730. }
  66731. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  66732. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66733. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66734. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66735. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66736. /**
  66737. * Block used to get a random number
  66738. */
  66739. export class RandomNumberBlock extends NodeMaterialBlock {
  66740. /**
  66741. * Creates a new RandomNumberBlock
  66742. * @param name defines the block name
  66743. */
  66744. constructor(name: string);
  66745. /**
  66746. * Gets the current class name
  66747. * @returns the class name
  66748. */
  66749. getClassName(): string;
  66750. /**
  66751. * Gets the seed input component
  66752. */
  66753. get seed(): NodeMaterialConnectionPoint;
  66754. /**
  66755. * Gets the output component
  66756. */
  66757. get output(): NodeMaterialConnectionPoint;
  66758. protected _buildBlock(state: NodeMaterialBuildState): this;
  66759. }
  66760. }
  66761. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  66762. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66763. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66764. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66765. /**
  66766. * Block used to compute arc tangent of 2 values
  66767. */
  66768. export class ArcTan2Block extends NodeMaterialBlock {
  66769. /**
  66770. * Creates a new ArcTan2Block
  66771. * @param name defines the block name
  66772. */
  66773. constructor(name: string);
  66774. /**
  66775. * Gets the current class name
  66776. * @returns the class name
  66777. */
  66778. getClassName(): string;
  66779. /**
  66780. * Gets the x operand input component
  66781. */
  66782. get x(): NodeMaterialConnectionPoint;
  66783. /**
  66784. * Gets the y operand input component
  66785. */
  66786. get y(): NodeMaterialConnectionPoint;
  66787. /**
  66788. * Gets the output component
  66789. */
  66790. get output(): NodeMaterialConnectionPoint;
  66791. protected _buildBlock(state: NodeMaterialBuildState): this;
  66792. }
  66793. }
  66794. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  66795. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66796. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66797. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66798. /**
  66799. * Block used to smooth step a value
  66800. */
  66801. export class SmoothStepBlock extends NodeMaterialBlock {
  66802. /**
  66803. * Creates a new SmoothStepBlock
  66804. * @param name defines the block name
  66805. */
  66806. constructor(name: string);
  66807. /**
  66808. * Gets the current class name
  66809. * @returns the class name
  66810. */
  66811. getClassName(): string;
  66812. /**
  66813. * Gets the value operand input component
  66814. */
  66815. get value(): NodeMaterialConnectionPoint;
  66816. /**
  66817. * Gets the first edge operand input component
  66818. */
  66819. get edge0(): NodeMaterialConnectionPoint;
  66820. /**
  66821. * Gets the second edge operand input component
  66822. */
  66823. get edge1(): NodeMaterialConnectionPoint;
  66824. /**
  66825. * Gets the output component
  66826. */
  66827. get output(): NodeMaterialConnectionPoint;
  66828. protected _buildBlock(state: NodeMaterialBuildState): this;
  66829. }
  66830. }
  66831. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  66832. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66833. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66834. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66835. /**
  66836. * Block used to get the reciprocal (1 / x) of a value
  66837. */
  66838. export class ReciprocalBlock extends NodeMaterialBlock {
  66839. /**
  66840. * Creates a new ReciprocalBlock
  66841. * @param name defines the block name
  66842. */
  66843. constructor(name: string);
  66844. /**
  66845. * Gets the current class name
  66846. * @returns the class name
  66847. */
  66848. getClassName(): string;
  66849. /**
  66850. * Gets the input component
  66851. */
  66852. get input(): NodeMaterialConnectionPoint;
  66853. /**
  66854. * Gets the output component
  66855. */
  66856. get output(): NodeMaterialConnectionPoint;
  66857. protected _buildBlock(state: NodeMaterialBuildState): this;
  66858. }
  66859. }
  66860. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  66861. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66862. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66863. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66864. /**
  66865. * Block used to replace a color by another one
  66866. */
  66867. export class ReplaceColorBlock extends NodeMaterialBlock {
  66868. /**
  66869. * Creates a new ReplaceColorBlock
  66870. * @param name defines the block name
  66871. */
  66872. constructor(name: string);
  66873. /**
  66874. * Gets the current class name
  66875. * @returns the class name
  66876. */
  66877. getClassName(): string;
  66878. /**
  66879. * Gets the value input component
  66880. */
  66881. get value(): NodeMaterialConnectionPoint;
  66882. /**
  66883. * Gets the reference input component
  66884. */
  66885. get reference(): NodeMaterialConnectionPoint;
  66886. /**
  66887. * Gets the distance input component
  66888. */
  66889. get distance(): NodeMaterialConnectionPoint;
  66890. /**
  66891. * Gets the replacement input component
  66892. */
  66893. get replacement(): NodeMaterialConnectionPoint;
  66894. /**
  66895. * Gets the output component
  66896. */
  66897. get output(): NodeMaterialConnectionPoint;
  66898. protected _buildBlock(state: NodeMaterialBuildState): this;
  66899. }
  66900. }
  66901. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  66902. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66903. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66904. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66905. /**
  66906. * Block used to posterize a value
  66907. * @see https://en.wikipedia.org/wiki/Posterization
  66908. */
  66909. export class PosterizeBlock extends NodeMaterialBlock {
  66910. /**
  66911. * Creates a new PosterizeBlock
  66912. * @param name defines the block name
  66913. */
  66914. constructor(name: string);
  66915. /**
  66916. * Gets the current class name
  66917. * @returns the class name
  66918. */
  66919. getClassName(): string;
  66920. /**
  66921. * Gets the value input component
  66922. */
  66923. get value(): NodeMaterialConnectionPoint;
  66924. /**
  66925. * Gets the steps input component
  66926. */
  66927. get steps(): NodeMaterialConnectionPoint;
  66928. /**
  66929. * Gets the output component
  66930. */
  66931. get output(): NodeMaterialConnectionPoint;
  66932. protected _buildBlock(state: NodeMaterialBuildState): this;
  66933. }
  66934. }
  66935. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  66936. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66937. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66938. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66939. import { Scene } from "babylonjs/scene";
  66940. /**
  66941. * Operations supported by the Wave block
  66942. */
  66943. export enum WaveBlockKind {
  66944. /** SawTooth */
  66945. SawTooth = 0,
  66946. /** Square */
  66947. Square = 1,
  66948. /** Triangle */
  66949. Triangle = 2
  66950. }
  66951. /**
  66952. * Block used to apply wave operation to floats
  66953. */
  66954. export class WaveBlock extends NodeMaterialBlock {
  66955. /**
  66956. * Gets or sets the kibnd of wave to be applied by the block
  66957. */
  66958. kind: WaveBlockKind;
  66959. /**
  66960. * Creates a new WaveBlock
  66961. * @param name defines the block name
  66962. */
  66963. constructor(name: string);
  66964. /**
  66965. * Gets the current class name
  66966. * @returns the class name
  66967. */
  66968. getClassName(): string;
  66969. /**
  66970. * Gets the input component
  66971. */
  66972. get input(): NodeMaterialConnectionPoint;
  66973. /**
  66974. * Gets the output component
  66975. */
  66976. get output(): NodeMaterialConnectionPoint;
  66977. protected _buildBlock(state: NodeMaterialBuildState): this;
  66978. serialize(): any;
  66979. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66980. }
  66981. }
  66982. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  66983. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66984. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66985. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66986. import { Color3 } from "babylonjs/Maths/math.color";
  66987. import { Scene } from "babylonjs/scene";
  66988. /**
  66989. * Class used to store a color step for the GradientBlock
  66990. */
  66991. export class GradientBlockColorStep {
  66992. /**
  66993. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66994. */
  66995. step: number;
  66996. /**
  66997. * Gets or sets the color associated with this step
  66998. */
  66999. color: Color3;
  67000. /**
  67001. * Creates a new GradientBlockColorStep
  67002. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  67003. * @param color defines the color associated with this step
  67004. */
  67005. constructor(
  67006. /**
  67007. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  67008. */
  67009. step: number,
  67010. /**
  67011. * Gets or sets the color associated with this step
  67012. */
  67013. color: Color3);
  67014. }
  67015. /**
  67016. * Block used to return a color from a gradient based on an input value between 0 and 1
  67017. */
  67018. export class GradientBlock extends NodeMaterialBlock {
  67019. /**
  67020. * Gets or sets the list of color steps
  67021. */
  67022. colorSteps: GradientBlockColorStep[];
  67023. /**
  67024. * Creates a new GradientBlock
  67025. * @param name defines the block name
  67026. */
  67027. constructor(name: string);
  67028. /**
  67029. * Gets the current class name
  67030. * @returns the class name
  67031. */
  67032. getClassName(): string;
  67033. /**
  67034. * Gets the gradient input component
  67035. */
  67036. get gradient(): NodeMaterialConnectionPoint;
  67037. /**
  67038. * Gets the output component
  67039. */
  67040. get output(): NodeMaterialConnectionPoint;
  67041. private _writeColorConstant;
  67042. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67043. serialize(): any;
  67044. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67045. protected _dumpPropertiesCode(): string;
  67046. }
  67047. }
  67048. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  67049. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67050. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67051. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67052. /**
  67053. * Block used to normalize lerp between 2 values
  67054. */
  67055. export class NLerpBlock extends NodeMaterialBlock {
  67056. /**
  67057. * Creates a new NLerpBlock
  67058. * @param name defines the block name
  67059. */
  67060. constructor(name: string);
  67061. /**
  67062. * Gets the current class name
  67063. * @returns the class name
  67064. */
  67065. getClassName(): string;
  67066. /**
  67067. * Gets the left operand input component
  67068. */
  67069. get left(): NodeMaterialConnectionPoint;
  67070. /**
  67071. * Gets the right operand input component
  67072. */
  67073. get right(): NodeMaterialConnectionPoint;
  67074. /**
  67075. * Gets the gradient operand input component
  67076. */
  67077. get gradient(): NodeMaterialConnectionPoint;
  67078. /**
  67079. * Gets the output component
  67080. */
  67081. get output(): NodeMaterialConnectionPoint;
  67082. protected _buildBlock(state: NodeMaterialBuildState): this;
  67083. }
  67084. }
  67085. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  67086. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67087. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67088. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67089. import { Scene } from "babylonjs/scene";
  67090. /**
  67091. * block used to Generate a Worley Noise 3D Noise Pattern
  67092. */
  67093. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  67094. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  67095. manhattanDistance: boolean;
  67096. /**
  67097. * Creates a new WorleyNoise3DBlock
  67098. * @param name defines the block name
  67099. */
  67100. constructor(name: string);
  67101. /**
  67102. * Gets the current class name
  67103. * @returns the class name
  67104. */
  67105. getClassName(): string;
  67106. /**
  67107. * Gets the seed input component
  67108. */
  67109. get seed(): NodeMaterialConnectionPoint;
  67110. /**
  67111. * Gets the jitter input component
  67112. */
  67113. get jitter(): NodeMaterialConnectionPoint;
  67114. /**
  67115. * Gets the output component
  67116. */
  67117. get output(): NodeMaterialConnectionPoint;
  67118. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67119. /**
  67120. * Exposes the properties to the UI?
  67121. */
  67122. protected _dumpPropertiesCode(): string;
  67123. /**
  67124. * Exposes the properties to the Seralize?
  67125. */
  67126. serialize(): any;
  67127. /**
  67128. * Exposes the properties to the deseralize?
  67129. */
  67130. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67131. }
  67132. }
  67133. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  67134. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67135. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67136. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67137. /**
  67138. * block used to Generate a Simplex Perlin 3d Noise Pattern
  67139. */
  67140. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  67141. /**
  67142. * Creates a new SimplexPerlin3DBlock
  67143. * @param name defines the block name
  67144. */
  67145. constructor(name: string);
  67146. /**
  67147. * Gets the current class name
  67148. * @returns the class name
  67149. */
  67150. getClassName(): string;
  67151. /**
  67152. * Gets the seed operand input component
  67153. */
  67154. get seed(): NodeMaterialConnectionPoint;
  67155. /**
  67156. * Gets the output component
  67157. */
  67158. get output(): NodeMaterialConnectionPoint;
  67159. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67160. }
  67161. }
  67162. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  67163. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67164. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67165. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67166. /**
  67167. * Block used to blend normals
  67168. */
  67169. export class NormalBlendBlock extends NodeMaterialBlock {
  67170. /**
  67171. * Creates a new NormalBlendBlock
  67172. * @param name defines the block name
  67173. */
  67174. constructor(name: string);
  67175. /**
  67176. * Gets the current class name
  67177. * @returns the class name
  67178. */
  67179. getClassName(): string;
  67180. /**
  67181. * Gets the first input component
  67182. */
  67183. get normalMap0(): NodeMaterialConnectionPoint;
  67184. /**
  67185. * Gets the second input component
  67186. */
  67187. get normalMap1(): NodeMaterialConnectionPoint;
  67188. /**
  67189. * Gets the output component
  67190. */
  67191. get output(): NodeMaterialConnectionPoint;
  67192. protected _buildBlock(state: NodeMaterialBuildState): this;
  67193. }
  67194. }
  67195. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  67196. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67197. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67198. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67199. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  67200. /**
  67201. * Block used to rotate a 2d vector by a given angle
  67202. */
  67203. export class Rotate2dBlock extends NodeMaterialBlock {
  67204. /**
  67205. * Creates a new Rotate2dBlock
  67206. * @param name defines the block name
  67207. */
  67208. constructor(name: string);
  67209. /**
  67210. * Gets the current class name
  67211. * @returns the class name
  67212. */
  67213. getClassName(): string;
  67214. /**
  67215. * Gets the input vector
  67216. */
  67217. get input(): NodeMaterialConnectionPoint;
  67218. /**
  67219. * Gets the input angle
  67220. */
  67221. get angle(): NodeMaterialConnectionPoint;
  67222. /**
  67223. * Gets the output component
  67224. */
  67225. get output(): NodeMaterialConnectionPoint;
  67226. autoConfigure(material: NodeMaterial): void;
  67227. protected _buildBlock(state: NodeMaterialBuildState): this;
  67228. }
  67229. }
  67230. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  67231. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67232. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67233. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67234. /**
  67235. * Block used to get the reflected vector from a direction and a normal
  67236. */
  67237. export class ReflectBlock extends NodeMaterialBlock {
  67238. /**
  67239. * Creates a new ReflectBlock
  67240. * @param name defines the block name
  67241. */
  67242. constructor(name: string);
  67243. /**
  67244. * Gets the current class name
  67245. * @returns the class name
  67246. */
  67247. getClassName(): string;
  67248. /**
  67249. * Gets the incident component
  67250. */
  67251. get incident(): NodeMaterialConnectionPoint;
  67252. /**
  67253. * Gets the normal component
  67254. */
  67255. get normal(): NodeMaterialConnectionPoint;
  67256. /**
  67257. * Gets the output component
  67258. */
  67259. get output(): NodeMaterialConnectionPoint;
  67260. protected _buildBlock(state: NodeMaterialBuildState): this;
  67261. }
  67262. }
  67263. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  67264. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67265. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67266. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67267. /**
  67268. * Block used to get the refracted vector from a direction and a normal
  67269. */
  67270. export class RefractBlock extends NodeMaterialBlock {
  67271. /**
  67272. * Creates a new RefractBlock
  67273. * @param name defines the block name
  67274. */
  67275. constructor(name: string);
  67276. /**
  67277. * Gets the current class name
  67278. * @returns the class name
  67279. */
  67280. getClassName(): string;
  67281. /**
  67282. * Gets the incident component
  67283. */
  67284. get incident(): NodeMaterialConnectionPoint;
  67285. /**
  67286. * Gets the normal component
  67287. */
  67288. get normal(): NodeMaterialConnectionPoint;
  67289. /**
  67290. * Gets the index of refraction component
  67291. */
  67292. get ior(): NodeMaterialConnectionPoint;
  67293. /**
  67294. * Gets the output component
  67295. */
  67296. get output(): NodeMaterialConnectionPoint;
  67297. protected _buildBlock(state: NodeMaterialBuildState): this;
  67298. }
  67299. }
  67300. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  67301. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67302. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67303. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67304. /**
  67305. * Block used to desaturate a color
  67306. */
  67307. export class DesaturateBlock extends NodeMaterialBlock {
  67308. /**
  67309. * Creates a new DesaturateBlock
  67310. * @param name defines the block name
  67311. */
  67312. constructor(name: string);
  67313. /**
  67314. * Gets the current class name
  67315. * @returns the class name
  67316. */
  67317. getClassName(): string;
  67318. /**
  67319. * Gets the color operand input component
  67320. */
  67321. get color(): NodeMaterialConnectionPoint;
  67322. /**
  67323. * Gets the level operand input component
  67324. */
  67325. get level(): NodeMaterialConnectionPoint;
  67326. /**
  67327. * Gets the output component
  67328. */
  67329. get output(): NodeMaterialConnectionPoint;
  67330. protected _buildBlock(state: NodeMaterialBuildState): this;
  67331. }
  67332. }
  67333. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  67334. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67335. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67336. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67337. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67338. import { Nullable } from "babylonjs/types";
  67339. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67340. import { Scene } from "babylonjs/scene";
  67341. /**
  67342. * Block used to implement the ambient occlusion module of the PBR material
  67343. */
  67344. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  67345. /**
  67346. * Create a new AmbientOcclusionBlock
  67347. * @param name defines the block name
  67348. */
  67349. constructor(name: string);
  67350. /**
  67351. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  67352. */
  67353. useAmbientInGrayScale: boolean;
  67354. /**
  67355. * Initialize the block and prepare the context for build
  67356. * @param state defines the state that will be used for the build
  67357. */
  67358. initialize(state: NodeMaterialBuildState): void;
  67359. /**
  67360. * Gets the current class name
  67361. * @returns the class name
  67362. */
  67363. getClassName(): string;
  67364. /**
  67365. * Gets the texture input component
  67366. */
  67367. get texture(): NodeMaterialConnectionPoint;
  67368. /**
  67369. * Gets the texture intensity component
  67370. */
  67371. get intensity(): NodeMaterialConnectionPoint;
  67372. /**
  67373. * Gets the direct light intensity input component
  67374. */
  67375. get directLightIntensity(): NodeMaterialConnectionPoint;
  67376. /**
  67377. * Gets the ambient occlusion object output component
  67378. */
  67379. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67380. /**
  67381. * Gets the main code of the block (fragment side)
  67382. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  67383. * @returns the shader code
  67384. */
  67385. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  67386. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67387. protected _buildBlock(state: NodeMaterialBuildState): this;
  67388. protected _dumpPropertiesCode(): string;
  67389. serialize(): any;
  67390. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67391. }
  67392. }
  67393. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  67394. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67395. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67396. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67397. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  67398. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67399. import { Nullable } from "babylonjs/types";
  67400. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  67401. import { Mesh } from "babylonjs/Meshes/mesh";
  67402. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67403. import { Effect } from "babylonjs/Materials/effect";
  67404. import { Scene } from "babylonjs/scene";
  67405. /**
  67406. * Block used to implement the reflection module of the PBR material
  67407. */
  67408. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  67409. /** @hidden */
  67410. _defineLODReflectionAlpha: string;
  67411. /** @hidden */
  67412. _defineLinearSpecularReflection: string;
  67413. private _vEnvironmentIrradianceName;
  67414. /** @hidden */
  67415. _vReflectionMicrosurfaceInfosName: string;
  67416. /** @hidden */
  67417. _vReflectionInfosName: string;
  67418. /** @hidden */
  67419. _vReflectionFilteringInfoName: string;
  67420. private _scene;
  67421. /**
  67422. * The three properties below are set by the main PBR block prior to calling methods of this class.
  67423. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67424. * It's less burden on the user side in the editor part.
  67425. */
  67426. /** @hidden */
  67427. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67428. /** @hidden */
  67429. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67430. /** @hidden */
  67431. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  67432. /**
  67433. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  67434. * diffuse part of the IBL.
  67435. */
  67436. useSphericalHarmonics: boolean;
  67437. /**
  67438. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  67439. */
  67440. forceIrradianceInFragment: boolean;
  67441. /**
  67442. * Create a new ReflectionBlock
  67443. * @param name defines the block name
  67444. */
  67445. constructor(name: string);
  67446. /**
  67447. * Gets the current class name
  67448. * @returns the class name
  67449. */
  67450. getClassName(): string;
  67451. /**
  67452. * Gets the position input component
  67453. */
  67454. get position(): NodeMaterialConnectionPoint;
  67455. /**
  67456. * Gets the world position input component
  67457. */
  67458. get worldPosition(): NodeMaterialConnectionPoint;
  67459. /**
  67460. * Gets the world normal input component
  67461. */
  67462. get worldNormal(): NodeMaterialConnectionPoint;
  67463. /**
  67464. * Gets the world input component
  67465. */
  67466. get world(): NodeMaterialConnectionPoint;
  67467. /**
  67468. * Gets the camera (or eye) position component
  67469. */
  67470. get cameraPosition(): NodeMaterialConnectionPoint;
  67471. /**
  67472. * Gets the view input component
  67473. */
  67474. get view(): NodeMaterialConnectionPoint;
  67475. /**
  67476. * Gets the color input component
  67477. */
  67478. get color(): NodeMaterialConnectionPoint;
  67479. /**
  67480. * Gets the reflection object output component
  67481. */
  67482. get reflection(): NodeMaterialConnectionPoint;
  67483. /**
  67484. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  67485. */
  67486. get hasTexture(): boolean;
  67487. /**
  67488. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  67489. */
  67490. get reflectionColor(): string;
  67491. protected _getTexture(): Nullable<BaseTexture>;
  67492. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67493. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67494. /**
  67495. * Gets the code to inject in the vertex shader
  67496. * @param state current state of the node material building
  67497. * @returns the shader code
  67498. */
  67499. handleVertexSide(state: NodeMaterialBuildState): string;
  67500. /**
  67501. * Gets the main code of the block (fragment side)
  67502. * @param state current state of the node material building
  67503. * @param normalVarName name of the existing variable corresponding to the normal
  67504. * @returns the shader code
  67505. */
  67506. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  67507. protected _buildBlock(state: NodeMaterialBuildState): this;
  67508. protected _dumpPropertiesCode(): string;
  67509. serialize(): any;
  67510. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67511. }
  67512. }
  67513. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  67514. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67515. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67516. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67517. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67518. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67519. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67520. import { Scene } from "babylonjs/scene";
  67521. import { Nullable } from "babylonjs/types";
  67522. /**
  67523. * Block used to implement the sheen module of the PBR material
  67524. */
  67525. export class SheenBlock extends NodeMaterialBlock {
  67526. /**
  67527. * Create a new SheenBlock
  67528. * @param name defines the block name
  67529. */
  67530. constructor(name: string);
  67531. /**
  67532. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  67533. * It allows the strength of the sheen effect to not depend on the base color of the material,
  67534. * making it easier to setup and tweak the effect
  67535. */
  67536. albedoScaling: boolean;
  67537. /**
  67538. * Defines if the sheen is linked to the sheen color.
  67539. */
  67540. linkSheenWithAlbedo: boolean;
  67541. /**
  67542. * Initialize the block and prepare the context for build
  67543. * @param state defines the state that will be used for the build
  67544. */
  67545. initialize(state: NodeMaterialBuildState): void;
  67546. /**
  67547. * Gets the current class name
  67548. * @returns the class name
  67549. */
  67550. getClassName(): string;
  67551. /**
  67552. * Gets the intensity input component
  67553. */
  67554. get intensity(): NodeMaterialConnectionPoint;
  67555. /**
  67556. * Gets the color input component
  67557. */
  67558. get color(): NodeMaterialConnectionPoint;
  67559. /**
  67560. * Gets the roughness input component
  67561. */
  67562. get roughness(): NodeMaterialConnectionPoint;
  67563. /**
  67564. * Gets the sheen object output component
  67565. */
  67566. get sheen(): NodeMaterialConnectionPoint;
  67567. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67568. /**
  67569. * Gets the main code of the block (fragment side)
  67570. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67571. * @returns the shader code
  67572. */
  67573. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  67574. protected _buildBlock(state: NodeMaterialBuildState): this;
  67575. protected _dumpPropertiesCode(): string;
  67576. serialize(): any;
  67577. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67578. }
  67579. }
  67580. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  67581. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67582. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67583. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67584. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67585. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67586. import { Scene } from "babylonjs/scene";
  67587. import { Nullable } from "babylonjs/types";
  67588. import { Mesh } from "babylonjs/Meshes/mesh";
  67589. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67590. import { Effect } from "babylonjs/Materials/effect";
  67591. /**
  67592. * Block used to implement the reflectivity module of the PBR material
  67593. */
  67594. export class ReflectivityBlock extends NodeMaterialBlock {
  67595. private _metallicReflectanceColor;
  67596. private _metallicF0Factor;
  67597. /** @hidden */
  67598. _vMetallicReflectanceFactorsName: string;
  67599. /**
  67600. * The property below is set by the main PBR block prior to calling methods of this class.
  67601. */
  67602. /** @hidden */
  67603. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  67604. /**
  67605. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  67606. */
  67607. useAmbientOcclusionFromMetallicTextureRed: boolean;
  67608. /**
  67609. * Specifies if the metallic texture contains the metallness information in its blue channel.
  67610. */
  67611. useMetallnessFromMetallicTextureBlue: boolean;
  67612. /**
  67613. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  67614. */
  67615. useRoughnessFromMetallicTextureAlpha: boolean;
  67616. /**
  67617. * Specifies if the metallic texture contains the roughness information in its green channel.
  67618. */
  67619. useRoughnessFromMetallicTextureGreen: boolean;
  67620. /**
  67621. * Create a new ReflectivityBlock
  67622. * @param name defines the block name
  67623. */
  67624. constructor(name: string);
  67625. /**
  67626. * Initialize the block and prepare the context for build
  67627. * @param state defines the state that will be used for the build
  67628. */
  67629. initialize(state: NodeMaterialBuildState): void;
  67630. /**
  67631. * Gets the current class name
  67632. * @returns the class name
  67633. */
  67634. getClassName(): string;
  67635. /**
  67636. * Gets the metallic input component
  67637. */
  67638. get metallic(): NodeMaterialConnectionPoint;
  67639. /**
  67640. * Gets the roughness input component
  67641. */
  67642. get roughness(): NodeMaterialConnectionPoint;
  67643. /**
  67644. * Gets the texture input component
  67645. */
  67646. get texture(): NodeMaterialConnectionPoint;
  67647. /**
  67648. * Gets the reflectivity object output component
  67649. */
  67650. get reflectivity(): NodeMaterialConnectionPoint;
  67651. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67652. /**
  67653. * Gets the main code of the block (fragment side)
  67654. * @param state current state of the node material building
  67655. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  67656. * @returns the shader code
  67657. */
  67658. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  67659. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67660. protected _buildBlock(state: NodeMaterialBuildState): this;
  67661. protected _dumpPropertiesCode(): string;
  67662. serialize(): any;
  67663. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67664. }
  67665. }
  67666. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  67667. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67668. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67669. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67670. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67671. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67672. /**
  67673. * Block used to implement the anisotropy module of the PBR material
  67674. */
  67675. export class AnisotropyBlock extends NodeMaterialBlock {
  67676. /**
  67677. * The two properties below are set by the main PBR block prior to calling methods of this class.
  67678. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67679. * It's less burden on the user side in the editor part.
  67680. */
  67681. /** @hidden */
  67682. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67683. /** @hidden */
  67684. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67685. /**
  67686. * Create a new AnisotropyBlock
  67687. * @param name defines the block name
  67688. */
  67689. constructor(name: string);
  67690. /**
  67691. * Initialize the block and prepare the context for build
  67692. * @param state defines the state that will be used for the build
  67693. */
  67694. initialize(state: NodeMaterialBuildState): void;
  67695. /**
  67696. * Gets the current class name
  67697. * @returns the class name
  67698. */
  67699. getClassName(): string;
  67700. /**
  67701. * Gets the intensity input component
  67702. */
  67703. get intensity(): NodeMaterialConnectionPoint;
  67704. /**
  67705. * Gets the direction input component
  67706. */
  67707. get direction(): NodeMaterialConnectionPoint;
  67708. /**
  67709. * Gets the texture input component
  67710. */
  67711. get texture(): NodeMaterialConnectionPoint;
  67712. /**
  67713. * Gets the uv input component
  67714. */
  67715. get uv(): NodeMaterialConnectionPoint;
  67716. /**
  67717. * Gets the worldTangent input component
  67718. */
  67719. get worldTangent(): NodeMaterialConnectionPoint;
  67720. /**
  67721. * Gets the anisotropy object output component
  67722. */
  67723. get anisotropy(): NodeMaterialConnectionPoint;
  67724. private _generateTBNSpace;
  67725. /**
  67726. * Gets the main code of the block (fragment side)
  67727. * @param state current state of the node material building
  67728. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67729. * @returns the shader code
  67730. */
  67731. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  67732. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67733. protected _buildBlock(state: NodeMaterialBuildState): this;
  67734. }
  67735. }
  67736. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  67737. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67738. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67739. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67740. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67741. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67742. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67743. import { Nullable } from "babylonjs/types";
  67744. import { Mesh } from "babylonjs/Meshes/mesh";
  67745. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67746. import { Effect } from "babylonjs/Materials/effect";
  67747. /**
  67748. * Block used to implement the clear coat module of the PBR material
  67749. */
  67750. export class ClearCoatBlock extends NodeMaterialBlock {
  67751. private _scene;
  67752. /**
  67753. * Create a new ClearCoatBlock
  67754. * @param name defines the block name
  67755. */
  67756. constructor(name: string);
  67757. /**
  67758. * Initialize the block and prepare the context for build
  67759. * @param state defines the state that will be used for the build
  67760. */
  67761. initialize(state: NodeMaterialBuildState): void;
  67762. /**
  67763. * Gets the current class name
  67764. * @returns the class name
  67765. */
  67766. getClassName(): string;
  67767. /**
  67768. * Gets the intensity input component
  67769. */
  67770. get intensity(): NodeMaterialConnectionPoint;
  67771. /**
  67772. * Gets the roughness input component
  67773. */
  67774. get roughness(): NodeMaterialConnectionPoint;
  67775. /**
  67776. * Gets the ior input component
  67777. */
  67778. get ior(): NodeMaterialConnectionPoint;
  67779. /**
  67780. * Gets the texture input component
  67781. */
  67782. get texture(): NodeMaterialConnectionPoint;
  67783. /**
  67784. * Gets the bump texture input component
  67785. */
  67786. get bumpTexture(): NodeMaterialConnectionPoint;
  67787. /**
  67788. * Gets the uv input component
  67789. */
  67790. get uv(): NodeMaterialConnectionPoint;
  67791. /**
  67792. * Gets the tint color input component
  67793. */
  67794. get tintColor(): NodeMaterialConnectionPoint;
  67795. /**
  67796. * Gets the tint "at distance" input component
  67797. */
  67798. get tintAtDistance(): NodeMaterialConnectionPoint;
  67799. /**
  67800. * Gets the tint thickness input component
  67801. */
  67802. get tintThickness(): NodeMaterialConnectionPoint;
  67803. /**
  67804. * Gets the world tangent input component
  67805. */
  67806. get worldTangent(): NodeMaterialConnectionPoint;
  67807. /**
  67808. * Gets the clear coat object output component
  67809. */
  67810. get clearcoat(): NodeMaterialConnectionPoint;
  67811. autoConfigure(material: NodeMaterial): void;
  67812. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67813. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67814. private _generateTBNSpace;
  67815. /**
  67816. * Gets the main code of the block (fragment side)
  67817. * @param state current state of the node material building
  67818. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  67819. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67820. * @param worldPosVarName name of the variable holding the world position
  67821. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67822. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  67823. * @param worldNormalVarName name of the variable holding the world normal
  67824. * @returns the shader code
  67825. */
  67826. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  67827. protected _buildBlock(state: NodeMaterialBuildState): this;
  67828. }
  67829. }
  67830. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  67831. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67832. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67833. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67834. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67835. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67836. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67837. import { Nullable } from "babylonjs/types";
  67838. /**
  67839. * Block used to implement the sub surface module of the PBR material
  67840. */
  67841. export class SubSurfaceBlock extends NodeMaterialBlock {
  67842. /**
  67843. * Create a new SubSurfaceBlock
  67844. * @param name defines the block name
  67845. */
  67846. constructor(name: string);
  67847. /**
  67848. * Stores the intensity of the different subsurface effects in the thickness texture.
  67849. * * the green channel is the translucency intensity.
  67850. * * the blue channel is the scattering intensity.
  67851. * * the alpha channel is the refraction intensity.
  67852. */
  67853. useMaskFromThicknessTexture: boolean;
  67854. /**
  67855. * Initialize the block and prepare the context for build
  67856. * @param state defines the state that will be used for the build
  67857. */
  67858. initialize(state: NodeMaterialBuildState): void;
  67859. /**
  67860. * Gets the current class name
  67861. * @returns the class name
  67862. */
  67863. getClassName(): string;
  67864. /**
  67865. * Gets the min thickness input component
  67866. */
  67867. get minThickness(): NodeMaterialConnectionPoint;
  67868. /**
  67869. * Gets the max thickness input component
  67870. */
  67871. get maxThickness(): NodeMaterialConnectionPoint;
  67872. /**
  67873. * Gets the thickness texture component
  67874. */
  67875. get thicknessTexture(): NodeMaterialConnectionPoint;
  67876. /**
  67877. * Gets the tint color input component
  67878. */
  67879. get tintColor(): NodeMaterialConnectionPoint;
  67880. /**
  67881. * Gets the translucency intensity input component
  67882. */
  67883. get translucencyIntensity(): NodeMaterialConnectionPoint;
  67884. /**
  67885. * Gets the translucency diffusion distance input component
  67886. */
  67887. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  67888. /**
  67889. * Gets the refraction object parameters
  67890. */
  67891. get refraction(): NodeMaterialConnectionPoint;
  67892. /**
  67893. * Gets the sub surface object output component
  67894. */
  67895. get subsurface(): NodeMaterialConnectionPoint;
  67896. autoConfigure(material: NodeMaterial): void;
  67897. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67898. /**
  67899. * Gets the main code of the block (fragment side)
  67900. * @param state current state of the node material building
  67901. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  67902. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67903. * @param worldPosVarName name of the variable holding the world position
  67904. * @returns the shader code
  67905. */
  67906. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  67907. protected _buildBlock(state: NodeMaterialBuildState): this;
  67908. }
  67909. }
  67910. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  67911. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67912. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67913. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67914. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67915. import { Light } from "babylonjs/Lights/light";
  67916. import { Nullable } from "babylonjs/types";
  67917. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67918. import { Effect } from "babylonjs/Materials/effect";
  67919. import { Mesh } from "babylonjs/Meshes/mesh";
  67920. import { Scene } from "babylonjs/scene";
  67921. /**
  67922. * Block used to implement the PBR metallic/roughness model
  67923. */
  67924. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  67925. /**
  67926. * Gets or sets the light associated with this block
  67927. */
  67928. light: Nullable<Light>;
  67929. private _lightId;
  67930. private _scene;
  67931. private _environmentBRDFTexture;
  67932. private _environmentBrdfSamplerName;
  67933. private _vNormalWName;
  67934. private _invertNormalName;
  67935. /**
  67936. * Create a new ReflectionBlock
  67937. * @param name defines the block name
  67938. */
  67939. constructor(name: string);
  67940. /**
  67941. * Intensity of the direct lights e.g. the four lights available in your scene.
  67942. * This impacts both the direct diffuse and specular highlights.
  67943. */
  67944. directIntensity: number;
  67945. /**
  67946. * Intensity of the environment e.g. how much the environment will light the object
  67947. * either through harmonics for rough material or through the refelction for shiny ones.
  67948. */
  67949. environmentIntensity: number;
  67950. /**
  67951. * This is a special control allowing the reduction of the specular highlights coming from the
  67952. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  67953. */
  67954. specularIntensity: number;
  67955. /**
  67956. * Defines the falloff type used in this material.
  67957. * It by default is Physical.
  67958. */
  67959. lightFalloff: number;
  67960. /**
  67961. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  67962. */
  67963. useAlphaFromAlbedoTexture: boolean;
  67964. /**
  67965. * Specifies that alpha test should be used
  67966. */
  67967. useAlphaTest: boolean;
  67968. /**
  67969. * Defines the alpha limits in alpha test mode.
  67970. */
  67971. alphaTestCutoff: number;
  67972. /**
  67973. * Specifies that alpha blending should be used
  67974. */
  67975. useAlphaBlending: boolean;
  67976. /**
  67977. * Defines if the alpha value should be determined via the rgb values.
  67978. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  67979. */
  67980. opacityRGB: boolean;
  67981. /**
  67982. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  67983. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  67984. */
  67985. useRadianceOverAlpha: boolean;
  67986. /**
  67987. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  67988. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  67989. */
  67990. useSpecularOverAlpha: boolean;
  67991. /**
  67992. * Enables specular anti aliasing in the PBR shader.
  67993. * It will both interacts on the Geometry for analytical and IBL lighting.
  67994. * It also prefilter the roughness map based on the bump values.
  67995. */
  67996. enableSpecularAntiAliasing: boolean;
  67997. /**
  67998. * Enables realtime filtering on the texture.
  67999. */
  68000. realTimeFiltering: boolean;
  68001. /**
  68002. * Quality switch for realtime filtering
  68003. */
  68004. realTimeFilteringQuality: number;
  68005. /**
  68006. * Defines if the material uses energy conservation.
  68007. */
  68008. useEnergyConservation: boolean;
  68009. /**
  68010. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  68011. * too much the area relying on ambient texture to define their ambient occlusion.
  68012. */
  68013. useRadianceOcclusion: boolean;
  68014. /**
  68015. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  68016. * makes the reflect vector face the model (under horizon).
  68017. */
  68018. useHorizonOcclusion: boolean;
  68019. /**
  68020. * If set to true, no lighting calculations will be applied.
  68021. */
  68022. unlit: boolean;
  68023. /**
  68024. * Force normal to face away from face.
  68025. */
  68026. forceNormalForward: boolean;
  68027. /**
  68028. * Defines the material debug mode.
  68029. * It helps seeing only some components of the material while troubleshooting.
  68030. */
  68031. debugMode: number;
  68032. /**
  68033. * Specify from where on screen the debug mode should start.
  68034. * The value goes from -1 (full screen) to 1 (not visible)
  68035. * It helps with side by side comparison against the final render
  68036. * This defaults to 0
  68037. */
  68038. debugLimit: number;
  68039. /**
  68040. * As the default viewing range might not be enough (if the ambient is really small for instance)
  68041. * You can use the factor to better multiply the final value.
  68042. */
  68043. debugFactor: number;
  68044. /**
  68045. * Initialize the block and prepare the context for build
  68046. * @param state defines the state that will be used for the build
  68047. */
  68048. initialize(state: NodeMaterialBuildState): void;
  68049. /**
  68050. * Gets the current class name
  68051. * @returns the class name
  68052. */
  68053. getClassName(): string;
  68054. /**
  68055. * Gets the world position input component
  68056. */
  68057. get worldPosition(): NodeMaterialConnectionPoint;
  68058. /**
  68059. * Gets the world normal input component
  68060. */
  68061. get worldNormal(): NodeMaterialConnectionPoint;
  68062. /**
  68063. * Gets the perturbed normal input component
  68064. */
  68065. get perturbedNormal(): NodeMaterialConnectionPoint;
  68066. /**
  68067. * Gets the camera position input component
  68068. */
  68069. get cameraPosition(): NodeMaterialConnectionPoint;
  68070. /**
  68071. * Gets the base color input component
  68072. */
  68073. get baseColor(): NodeMaterialConnectionPoint;
  68074. /**
  68075. * Gets the opacity texture input component
  68076. */
  68077. get opacityTexture(): NodeMaterialConnectionPoint;
  68078. /**
  68079. * Gets the ambient color input component
  68080. */
  68081. get ambientColor(): NodeMaterialConnectionPoint;
  68082. /**
  68083. * Gets the reflectivity object parameters
  68084. */
  68085. get reflectivity(): NodeMaterialConnectionPoint;
  68086. /**
  68087. * Gets the ambient occlusion object parameters
  68088. */
  68089. get ambientOcclusion(): NodeMaterialConnectionPoint;
  68090. /**
  68091. * Gets the reflection object parameters
  68092. */
  68093. get reflection(): NodeMaterialConnectionPoint;
  68094. /**
  68095. * Gets the sheen object parameters
  68096. */
  68097. get sheen(): NodeMaterialConnectionPoint;
  68098. /**
  68099. * Gets the clear coat object parameters
  68100. */
  68101. get clearcoat(): NodeMaterialConnectionPoint;
  68102. /**
  68103. * Gets the sub surface object parameters
  68104. */
  68105. get subsurface(): NodeMaterialConnectionPoint;
  68106. /**
  68107. * Gets the anisotropy object parameters
  68108. */
  68109. get anisotropy(): NodeMaterialConnectionPoint;
  68110. /**
  68111. * Gets the ambient output component
  68112. */
  68113. get ambient(): NodeMaterialConnectionPoint;
  68114. /**
  68115. * Gets the diffuse output component
  68116. */
  68117. get diffuse(): NodeMaterialConnectionPoint;
  68118. /**
  68119. * Gets the specular output component
  68120. */
  68121. get specular(): NodeMaterialConnectionPoint;
  68122. /**
  68123. * Gets the sheen output component
  68124. */
  68125. get sheenDir(): NodeMaterialConnectionPoint;
  68126. /**
  68127. * Gets the clear coat output component
  68128. */
  68129. get clearcoatDir(): NodeMaterialConnectionPoint;
  68130. /**
  68131. * Gets the indirect diffuse output component
  68132. */
  68133. get diffuseIndirect(): NodeMaterialConnectionPoint;
  68134. /**
  68135. * Gets the indirect specular output component
  68136. */
  68137. get specularIndirect(): NodeMaterialConnectionPoint;
  68138. /**
  68139. * Gets the indirect sheen output component
  68140. */
  68141. get sheenIndirect(): NodeMaterialConnectionPoint;
  68142. /**
  68143. * Gets the indirect clear coat output component
  68144. */
  68145. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  68146. /**
  68147. * Gets the refraction output component
  68148. */
  68149. get refraction(): NodeMaterialConnectionPoint;
  68150. /**
  68151. * Gets the global lighting output component
  68152. */
  68153. get lighting(): NodeMaterialConnectionPoint;
  68154. /**
  68155. * Gets the shadow output component
  68156. */
  68157. get shadow(): NodeMaterialConnectionPoint;
  68158. /**
  68159. * Gets the alpha output component
  68160. */
  68161. get alpha(): NodeMaterialConnectionPoint;
  68162. autoConfigure(material: NodeMaterial): void;
  68163. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68164. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  68165. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  68166. private _injectVertexCode;
  68167. /**
  68168. * Gets the code corresponding to the albedo/opacity module
  68169. * @returns the shader code
  68170. */
  68171. getAlbedoOpacityCode(): string;
  68172. protected _buildBlock(state: NodeMaterialBuildState): this;
  68173. protected _dumpPropertiesCode(): string;
  68174. serialize(): any;
  68175. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68176. }
  68177. }
  68178. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  68179. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  68180. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  68181. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  68182. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  68183. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  68184. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68185. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  68186. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  68187. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  68188. }
  68189. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  68190. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  68191. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  68192. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  68193. }
  68194. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  68195. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68196. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68197. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68198. /**
  68199. * Block used to compute value of one parameter modulo another
  68200. */
  68201. export class ModBlock extends NodeMaterialBlock {
  68202. /**
  68203. * Creates a new ModBlock
  68204. * @param name defines the block name
  68205. */
  68206. constructor(name: string);
  68207. /**
  68208. * Gets the current class name
  68209. * @returns the class name
  68210. */
  68211. getClassName(): string;
  68212. /**
  68213. * Gets the left operand input component
  68214. */
  68215. get left(): NodeMaterialConnectionPoint;
  68216. /**
  68217. * Gets the right operand input component
  68218. */
  68219. get right(): NodeMaterialConnectionPoint;
  68220. /**
  68221. * Gets the output component
  68222. */
  68223. get output(): NodeMaterialConnectionPoint;
  68224. protected _buildBlock(state: NodeMaterialBuildState): this;
  68225. }
  68226. }
  68227. declare module "babylonjs/Materials/Node/Blocks/index" {
  68228. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  68229. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  68230. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  68231. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  68232. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  68233. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  68234. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  68235. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  68236. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  68237. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  68238. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  68239. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  68240. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  68241. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  68242. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  68243. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  68244. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  68245. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  68246. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  68247. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  68248. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  68249. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  68250. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  68251. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  68252. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  68253. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  68254. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  68255. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  68256. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  68257. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  68258. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  68259. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  68260. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  68261. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  68262. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  68263. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  68264. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  68265. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  68266. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  68267. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  68268. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  68269. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  68270. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  68271. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  68272. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  68273. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  68274. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  68275. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  68276. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  68277. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  68278. }
  68279. declare module "babylonjs/Materials/Node/Optimizers/index" {
  68280. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  68281. }
  68282. declare module "babylonjs/Materials/Node/index" {
  68283. export * from "babylonjs/Materials/Node/Enums/index";
  68284. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68285. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  68286. export * from "babylonjs/Materials/Node/nodeMaterial";
  68287. export * from "babylonjs/Materials/Node/Blocks/index";
  68288. export * from "babylonjs/Materials/Node/Optimizers/index";
  68289. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  68290. }
  68291. declare module "babylonjs/Materials/index" {
  68292. export * from "babylonjs/Materials/Background/index";
  68293. export * from "babylonjs/Materials/colorCurves";
  68294. export * from "babylonjs/Materials/iEffectFallbacks";
  68295. export * from "babylonjs/Materials/effectFallbacks";
  68296. export * from "babylonjs/Materials/effect";
  68297. export * from "babylonjs/Materials/fresnelParameters";
  68298. export * from "babylonjs/Materials/imageProcessingConfiguration";
  68299. export * from "babylonjs/Materials/material";
  68300. export * from "babylonjs/Materials/materialDefines";
  68301. export * from "babylonjs/Materials/thinMaterialHelper";
  68302. export * from "babylonjs/Materials/materialHelper";
  68303. export * from "babylonjs/Materials/multiMaterial";
  68304. export * from "babylonjs/Materials/PBR/index";
  68305. export * from "babylonjs/Materials/pushMaterial";
  68306. export * from "babylonjs/Materials/shaderMaterial";
  68307. export * from "babylonjs/Materials/standardMaterial";
  68308. export * from "babylonjs/Materials/Textures/index";
  68309. export * from "babylonjs/Materials/uniformBuffer";
  68310. export * from "babylonjs/Materials/materialFlags";
  68311. export * from "babylonjs/Materials/Node/index";
  68312. export * from "babylonjs/Materials/effectRenderer";
  68313. export * from "babylonjs/Materials/shadowDepthWrapper";
  68314. }
  68315. declare module "babylonjs/Maths/index" {
  68316. export * from "babylonjs/Maths/math.scalar";
  68317. export * from "babylonjs/Maths/math";
  68318. export * from "babylonjs/Maths/sphericalPolynomial";
  68319. }
  68320. declare module "babylonjs/Misc/workerPool" {
  68321. import { IDisposable } from "babylonjs/scene";
  68322. /**
  68323. * Helper class to push actions to a pool of workers.
  68324. */
  68325. export class WorkerPool implements IDisposable {
  68326. private _workerInfos;
  68327. private _pendingActions;
  68328. /**
  68329. * Constructor
  68330. * @param workers Array of workers to use for actions
  68331. */
  68332. constructor(workers: Array<Worker>);
  68333. /**
  68334. * Terminates all workers and clears any pending actions.
  68335. */
  68336. dispose(): void;
  68337. /**
  68338. * Pushes an action to the worker pool. If all the workers are active, the action will be
  68339. * pended until a worker has completed its action.
  68340. * @param action The action to perform. Call onComplete when the action is complete.
  68341. */
  68342. push(action: (worker: Worker, onComplete: () => void) => void): void;
  68343. private _execute;
  68344. }
  68345. }
  68346. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  68347. import { IDisposable } from "babylonjs/scene";
  68348. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68349. /**
  68350. * Configuration for Draco compression
  68351. */
  68352. export interface IDracoCompressionConfiguration {
  68353. /**
  68354. * Configuration for the decoder.
  68355. */
  68356. decoder: {
  68357. /**
  68358. * The url to the WebAssembly module.
  68359. */
  68360. wasmUrl?: string;
  68361. /**
  68362. * The url to the WebAssembly binary.
  68363. */
  68364. wasmBinaryUrl?: string;
  68365. /**
  68366. * The url to the fallback JavaScript module.
  68367. */
  68368. fallbackUrl?: string;
  68369. };
  68370. }
  68371. /**
  68372. * Draco compression (https://google.github.io/draco/)
  68373. *
  68374. * This class wraps the Draco module.
  68375. *
  68376. * **Encoder**
  68377. *
  68378. * The encoder is not currently implemented.
  68379. *
  68380. * **Decoder**
  68381. *
  68382. * 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.
  68383. *
  68384. * To update the configuration, use the following code:
  68385. * ```javascript
  68386. * DracoCompression.Configuration = {
  68387. * decoder: {
  68388. * wasmUrl: "<url to the WebAssembly library>",
  68389. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  68390. * fallbackUrl: "<url to the fallback JavaScript library>",
  68391. * }
  68392. * };
  68393. * ```
  68394. *
  68395. * 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.
  68396. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  68397. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  68398. *
  68399. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  68400. * ```javascript
  68401. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  68402. * ```
  68403. *
  68404. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  68405. */
  68406. export class DracoCompression implements IDisposable {
  68407. private _workerPoolPromise?;
  68408. private _decoderModulePromise?;
  68409. /**
  68410. * The configuration. Defaults to the following urls:
  68411. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  68412. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  68413. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  68414. */
  68415. static Configuration: IDracoCompressionConfiguration;
  68416. /**
  68417. * Returns true if the decoder configuration is available.
  68418. */
  68419. static get DecoderAvailable(): boolean;
  68420. /**
  68421. * Default number of workers to create when creating the draco compression object.
  68422. */
  68423. static DefaultNumWorkers: number;
  68424. private static GetDefaultNumWorkers;
  68425. private static _Default;
  68426. /**
  68427. * Default instance for the draco compression object.
  68428. */
  68429. static get Default(): DracoCompression;
  68430. /**
  68431. * Constructor
  68432. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  68433. */
  68434. constructor(numWorkers?: number);
  68435. /**
  68436. * Stop all async operations and release resources.
  68437. */
  68438. dispose(): void;
  68439. /**
  68440. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  68441. * @returns a promise that resolves when ready
  68442. */
  68443. whenReadyAsync(): Promise<void>;
  68444. /**
  68445. * Decode Draco compressed mesh data to vertex data.
  68446. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  68447. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  68448. * @returns A promise that resolves with the decoded vertex data
  68449. */
  68450. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  68451. [kind: string]: number;
  68452. }): Promise<VertexData>;
  68453. }
  68454. }
  68455. declare module "babylonjs/Meshes/Compression/index" {
  68456. export * from "babylonjs/Meshes/Compression/dracoCompression";
  68457. }
  68458. declare module "babylonjs/Meshes/csg" {
  68459. import { Nullable } from "babylonjs/types";
  68460. import { Scene } from "babylonjs/scene";
  68461. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  68462. import { Mesh } from "babylonjs/Meshes/mesh";
  68463. import { Material } from "babylonjs/Materials/material";
  68464. /**
  68465. * Class for building Constructive Solid Geometry
  68466. */
  68467. export class CSG {
  68468. private polygons;
  68469. /**
  68470. * The world matrix
  68471. */
  68472. matrix: Matrix;
  68473. /**
  68474. * Stores the position
  68475. */
  68476. position: Vector3;
  68477. /**
  68478. * Stores the rotation
  68479. */
  68480. rotation: Vector3;
  68481. /**
  68482. * Stores the rotation quaternion
  68483. */
  68484. rotationQuaternion: Nullable<Quaternion>;
  68485. /**
  68486. * Stores the scaling vector
  68487. */
  68488. scaling: Vector3;
  68489. /**
  68490. * Convert the Mesh to CSG
  68491. * @param mesh The Mesh to convert to CSG
  68492. * @returns A new CSG from the Mesh
  68493. */
  68494. static FromMesh(mesh: Mesh): CSG;
  68495. /**
  68496. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  68497. * @param polygons Polygons used to construct a CSG solid
  68498. */
  68499. private static FromPolygons;
  68500. /**
  68501. * Clones, or makes a deep copy, of the CSG
  68502. * @returns A new CSG
  68503. */
  68504. clone(): CSG;
  68505. /**
  68506. * Unions this CSG with another CSG
  68507. * @param csg The CSG to union against this CSG
  68508. * @returns The unioned CSG
  68509. */
  68510. union(csg: CSG): CSG;
  68511. /**
  68512. * Unions this CSG with another CSG in place
  68513. * @param csg The CSG to union against this CSG
  68514. */
  68515. unionInPlace(csg: CSG): void;
  68516. /**
  68517. * Subtracts this CSG with another CSG
  68518. * @param csg The CSG to subtract against this CSG
  68519. * @returns A new CSG
  68520. */
  68521. subtract(csg: CSG): CSG;
  68522. /**
  68523. * Subtracts this CSG with another CSG in place
  68524. * @param csg The CSG to subtact against this CSG
  68525. */
  68526. subtractInPlace(csg: CSG): void;
  68527. /**
  68528. * Intersect this CSG with another CSG
  68529. * @param csg The CSG to intersect against this CSG
  68530. * @returns A new CSG
  68531. */
  68532. intersect(csg: CSG): CSG;
  68533. /**
  68534. * Intersects this CSG with another CSG in place
  68535. * @param csg The CSG to intersect against this CSG
  68536. */
  68537. intersectInPlace(csg: CSG): void;
  68538. /**
  68539. * Return a new CSG solid with solid and empty space switched. This solid is
  68540. * not modified.
  68541. * @returns A new CSG solid with solid and empty space switched
  68542. */
  68543. inverse(): CSG;
  68544. /**
  68545. * Inverses the CSG in place
  68546. */
  68547. inverseInPlace(): void;
  68548. /**
  68549. * This is used to keep meshes transformations so they can be restored
  68550. * when we build back a Babylon Mesh
  68551. * NB : All CSG operations are performed in world coordinates
  68552. * @param csg The CSG to copy the transform attributes from
  68553. * @returns This CSG
  68554. */
  68555. copyTransformAttributes(csg: CSG): CSG;
  68556. /**
  68557. * Build Raw mesh from CSG
  68558. * Coordinates here are in world space
  68559. * @param name The name of the mesh geometry
  68560. * @param scene The Scene
  68561. * @param keepSubMeshes Specifies if the submeshes should be kept
  68562. * @returns A new Mesh
  68563. */
  68564. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68565. /**
  68566. * Build Mesh from CSG taking material and transforms into account
  68567. * @param name The name of the Mesh
  68568. * @param material The material of the Mesh
  68569. * @param scene The Scene
  68570. * @param keepSubMeshes Specifies if submeshes should be kept
  68571. * @returns The new Mesh
  68572. */
  68573. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68574. }
  68575. }
  68576. declare module "babylonjs/Meshes/trailMesh" {
  68577. import { Mesh } from "babylonjs/Meshes/mesh";
  68578. import { Scene } from "babylonjs/scene";
  68579. import { TransformNode } from "babylonjs/Meshes/transformNode";
  68580. /**
  68581. * Class used to create a trail following a mesh
  68582. */
  68583. export class TrailMesh extends Mesh {
  68584. private _generator;
  68585. private _autoStart;
  68586. private _running;
  68587. private _diameter;
  68588. private _length;
  68589. private _sectionPolygonPointsCount;
  68590. private _sectionVectors;
  68591. private _sectionNormalVectors;
  68592. private _beforeRenderObserver;
  68593. /**
  68594. * @constructor
  68595. * @param name The value used by scene.getMeshByName() to do a lookup.
  68596. * @param generator The mesh or transform node to generate a trail.
  68597. * @param scene The scene to add this mesh to.
  68598. * @param diameter Diameter of trailing mesh. Default is 1.
  68599. * @param length Length of trailing mesh. Default is 60.
  68600. * @param autoStart Automatically start trailing mesh. Default true.
  68601. */
  68602. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  68603. /**
  68604. * "TrailMesh"
  68605. * @returns "TrailMesh"
  68606. */
  68607. getClassName(): string;
  68608. private _createMesh;
  68609. /**
  68610. * Start trailing mesh.
  68611. */
  68612. start(): void;
  68613. /**
  68614. * Stop trailing mesh.
  68615. */
  68616. stop(): void;
  68617. /**
  68618. * Update trailing mesh geometry.
  68619. */
  68620. update(): void;
  68621. /**
  68622. * Returns a new TrailMesh object.
  68623. * @param name is a string, the name given to the new mesh
  68624. * @param newGenerator use new generator object for cloned trail mesh
  68625. * @returns a new mesh
  68626. */
  68627. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  68628. /**
  68629. * Serializes this trail mesh
  68630. * @param serializationObject object to write serialization to
  68631. */
  68632. serialize(serializationObject: any): void;
  68633. /**
  68634. * Parses a serialized trail mesh
  68635. * @param parsedMesh the serialized mesh
  68636. * @param scene the scene to create the trail mesh in
  68637. * @returns the created trail mesh
  68638. */
  68639. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  68640. }
  68641. }
  68642. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  68643. import { Nullable } from "babylonjs/types";
  68644. import { Scene } from "babylonjs/scene";
  68645. import { Vector4 } from "babylonjs/Maths/math.vector";
  68646. import { Color4 } from "babylonjs/Maths/math.color";
  68647. import { Mesh } from "babylonjs/Meshes/mesh";
  68648. /**
  68649. * Class containing static functions to help procedurally build meshes
  68650. */
  68651. export class TiledBoxBuilder {
  68652. /**
  68653. * Creates a box mesh
  68654. * 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)
  68655. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68656. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68657. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68658. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68659. * @param name defines the name of the mesh
  68660. * @param options defines the options used to create the mesh
  68661. * @param scene defines the hosting scene
  68662. * @returns the box mesh
  68663. */
  68664. static CreateTiledBox(name: string, options: {
  68665. pattern?: number;
  68666. width?: number;
  68667. height?: number;
  68668. depth?: number;
  68669. tileSize?: number;
  68670. tileWidth?: number;
  68671. tileHeight?: number;
  68672. alignHorizontal?: number;
  68673. alignVertical?: number;
  68674. faceUV?: Vector4[];
  68675. faceColors?: Color4[];
  68676. sideOrientation?: number;
  68677. updatable?: boolean;
  68678. }, scene?: Nullable<Scene>): Mesh;
  68679. }
  68680. }
  68681. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  68682. import { Vector4 } from "babylonjs/Maths/math.vector";
  68683. import { Mesh } from "babylonjs/Meshes/mesh";
  68684. /**
  68685. * Class containing static functions to help procedurally build meshes
  68686. */
  68687. export class TorusKnotBuilder {
  68688. /**
  68689. * Creates a torus knot mesh
  68690. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68691. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68692. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68693. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68694. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68695. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68696. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68697. * @param name defines the name of the mesh
  68698. * @param options defines the options used to create the mesh
  68699. * @param scene defines the hosting scene
  68700. * @returns the torus knot mesh
  68701. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68702. */
  68703. static CreateTorusKnot(name: string, options: {
  68704. radius?: number;
  68705. tube?: number;
  68706. radialSegments?: number;
  68707. tubularSegments?: number;
  68708. p?: number;
  68709. q?: number;
  68710. updatable?: boolean;
  68711. sideOrientation?: number;
  68712. frontUVs?: Vector4;
  68713. backUVs?: Vector4;
  68714. }, scene: any): Mesh;
  68715. }
  68716. }
  68717. declare module "babylonjs/Meshes/polygonMesh" {
  68718. import { Scene } from "babylonjs/scene";
  68719. import { Vector2 } from "babylonjs/Maths/math.vector";
  68720. import { Mesh } from "babylonjs/Meshes/mesh";
  68721. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68722. import { Path2 } from "babylonjs/Maths/math.path";
  68723. /**
  68724. * Polygon
  68725. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  68726. */
  68727. export class Polygon {
  68728. /**
  68729. * Creates a rectangle
  68730. * @param xmin bottom X coord
  68731. * @param ymin bottom Y coord
  68732. * @param xmax top X coord
  68733. * @param ymax top Y coord
  68734. * @returns points that make the resulting rectation
  68735. */
  68736. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  68737. /**
  68738. * Creates a circle
  68739. * @param radius radius of circle
  68740. * @param cx scale in x
  68741. * @param cy scale in y
  68742. * @param numberOfSides number of sides that make up the circle
  68743. * @returns points that make the resulting circle
  68744. */
  68745. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  68746. /**
  68747. * Creates a polygon from input string
  68748. * @param input Input polygon data
  68749. * @returns the parsed points
  68750. */
  68751. static Parse(input: string): Vector2[];
  68752. /**
  68753. * Starts building a polygon from x and y coordinates
  68754. * @param x x coordinate
  68755. * @param y y coordinate
  68756. * @returns the started path2
  68757. */
  68758. static StartingAt(x: number, y: number): Path2;
  68759. }
  68760. /**
  68761. * Builds a polygon
  68762. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  68763. */
  68764. export class PolygonMeshBuilder {
  68765. private _points;
  68766. private _outlinepoints;
  68767. private _holes;
  68768. private _name;
  68769. private _scene;
  68770. private _epoints;
  68771. private _eholes;
  68772. private _addToepoint;
  68773. /**
  68774. * Babylon reference to the earcut plugin.
  68775. */
  68776. bjsEarcut: any;
  68777. /**
  68778. * Creates a PolygonMeshBuilder
  68779. * @param name name of the builder
  68780. * @param contours Path of the polygon
  68781. * @param scene scene to add to when creating the mesh
  68782. * @param earcutInjection can be used to inject your own earcut reference
  68783. */
  68784. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  68785. /**
  68786. * Adds a whole within the polygon
  68787. * @param hole Array of points defining the hole
  68788. * @returns this
  68789. */
  68790. addHole(hole: Vector2[]): PolygonMeshBuilder;
  68791. /**
  68792. * Creates the polygon
  68793. * @param updatable If the mesh should be updatable
  68794. * @param depth The depth of the mesh created
  68795. * @returns the created mesh
  68796. */
  68797. build(updatable?: boolean, depth?: number): Mesh;
  68798. /**
  68799. * Creates the polygon
  68800. * @param depth The depth of the mesh created
  68801. * @returns the created VertexData
  68802. */
  68803. buildVertexData(depth?: number): VertexData;
  68804. /**
  68805. * Adds a side to the polygon
  68806. * @param positions points that make the polygon
  68807. * @param normals normals of the polygon
  68808. * @param uvs uvs of the polygon
  68809. * @param indices indices of the polygon
  68810. * @param bounds bounds of the polygon
  68811. * @param points points of the polygon
  68812. * @param depth depth of the polygon
  68813. * @param flip flip of the polygon
  68814. */
  68815. private addSide;
  68816. }
  68817. }
  68818. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  68819. import { Scene } from "babylonjs/scene";
  68820. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68821. import { Color4 } from "babylonjs/Maths/math.color";
  68822. import { Mesh } from "babylonjs/Meshes/mesh";
  68823. import { Nullable } from "babylonjs/types";
  68824. /**
  68825. * Class containing static functions to help procedurally build meshes
  68826. */
  68827. export class PolygonBuilder {
  68828. /**
  68829. * Creates a polygon mesh
  68830. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  68831. * * 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
  68832. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68833. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68834. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  68835. * * Remember you can only change the shape positions, not their number when updating a polygon
  68836. * @param name defines the name of the mesh
  68837. * @param options defines the options used to create the mesh
  68838. * @param scene defines the hosting scene
  68839. * @param earcutInjection can be used to inject your own earcut reference
  68840. * @returns the polygon mesh
  68841. */
  68842. static CreatePolygon(name: string, options: {
  68843. shape: Vector3[];
  68844. holes?: Vector3[][];
  68845. depth?: number;
  68846. faceUV?: Vector4[];
  68847. faceColors?: Color4[];
  68848. updatable?: boolean;
  68849. sideOrientation?: number;
  68850. frontUVs?: Vector4;
  68851. backUVs?: Vector4;
  68852. wrap?: boolean;
  68853. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68854. /**
  68855. * Creates an extruded polygon mesh, with depth in the Y direction.
  68856. * * 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)
  68857. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68858. * @param name defines the name of the mesh
  68859. * @param options defines the options used to create the mesh
  68860. * @param scene defines the hosting scene
  68861. * @param earcutInjection can be used to inject your own earcut reference
  68862. * @returns the polygon mesh
  68863. */
  68864. static ExtrudePolygon(name: string, options: {
  68865. shape: Vector3[];
  68866. holes?: Vector3[][];
  68867. depth?: number;
  68868. faceUV?: Vector4[];
  68869. faceColors?: Color4[];
  68870. updatable?: boolean;
  68871. sideOrientation?: number;
  68872. frontUVs?: Vector4;
  68873. backUVs?: Vector4;
  68874. wrap?: boolean;
  68875. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68876. }
  68877. }
  68878. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  68879. import { Scene } from "babylonjs/scene";
  68880. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68881. import { Mesh } from "babylonjs/Meshes/mesh";
  68882. import { Nullable } from "babylonjs/types";
  68883. /**
  68884. * Class containing static functions to help procedurally build meshes
  68885. */
  68886. export class LatheBuilder {
  68887. /**
  68888. * Creates lathe mesh.
  68889. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  68890. * * 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
  68891. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  68892. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  68893. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  68894. * * 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
  68895. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  68896. * * 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
  68897. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68898. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68899. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68900. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68901. * @param name defines the name of the mesh
  68902. * @param options defines the options used to create the mesh
  68903. * @param scene defines the hosting scene
  68904. * @returns the lathe mesh
  68905. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  68906. */
  68907. static CreateLathe(name: string, options: {
  68908. shape: Vector3[];
  68909. radius?: number;
  68910. tessellation?: number;
  68911. clip?: number;
  68912. arc?: number;
  68913. closed?: boolean;
  68914. updatable?: boolean;
  68915. sideOrientation?: number;
  68916. frontUVs?: Vector4;
  68917. backUVs?: Vector4;
  68918. cap?: number;
  68919. invertUV?: boolean;
  68920. }, scene?: Nullable<Scene>): Mesh;
  68921. }
  68922. }
  68923. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  68924. import { Nullable } from "babylonjs/types";
  68925. import { Scene } from "babylonjs/scene";
  68926. import { Vector4 } from "babylonjs/Maths/math.vector";
  68927. import { Mesh } from "babylonjs/Meshes/mesh";
  68928. /**
  68929. * Class containing static functions to help procedurally build meshes
  68930. */
  68931. export class TiledPlaneBuilder {
  68932. /**
  68933. * Creates a tiled plane mesh
  68934. * * The parameter `pattern` will, depending on value, do nothing or
  68935. * * * flip (reflect about central vertical) alternate tiles across and up
  68936. * * * flip every tile on alternate rows
  68937. * * * rotate (180 degs) alternate tiles across and up
  68938. * * * rotate every tile on alternate rows
  68939. * * * flip and rotate alternate tiles across and up
  68940. * * * flip and rotate every tile on alternate rows
  68941. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  68942. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  68943. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68944. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68945. * * 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)
  68946. * * 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)
  68947. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  68948. * @param name defines the name of the mesh
  68949. * @param options defines the options used to create the mesh
  68950. * @param scene defines the hosting scene
  68951. * @returns the box mesh
  68952. */
  68953. static CreateTiledPlane(name: string, options: {
  68954. pattern?: number;
  68955. tileSize?: number;
  68956. tileWidth?: number;
  68957. tileHeight?: number;
  68958. size?: number;
  68959. width?: number;
  68960. height?: number;
  68961. alignHorizontal?: number;
  68962. alignVertical?: number;
  68963. sideOrientation?: number;
  68964. frontUVs?: Vector4;
  68965. backUVs?: Vector4;
  68966. updatable?: boolean;
  68967. }, scene?: Nullable<Scene>): Mesh;
  68968. }
  68969. }
  68970. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  68971. import { Nullable } from "babylonjs/types";
  68972. import { Scene } from "babylonjs/scene";
  68973. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68974. import { Mesh } from "babylonjs/Meshes/mesh";
  68975. /**
  68976. * Class containing static functions to help procedurally build meshes
  68977. */
  68978. export class TubeBuilder {
  68979. /**
  68980. * Creates a tube mesh.
  68981. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  68982. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  68983. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  68984. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  68985. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  68986. * * 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)
  68987. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  68988. * * 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
  68989. * * 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
  68990. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68991. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68992. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68993. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68994. * @param name defines the name of the mesh
  68995. * @param options defines the options used to create the mesh
  68996. * @param scene defines the hosting scene
  68997. * @returns the tube mesh
  68998. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68999. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69000. */
  69001. static CreateTube(name: string, options: {
  69002. path: Vector3[];
  69003. radius?: number;
  69004. tessellation?: number;
  69005. radiusFunction?: {
  69006. (i: number, distance: number): number;
  69007. };
  69008. cap?: number;
  69009. arc?: number;
  69010. updatable?: boolean;
  69011. sideOrientation?: number;
  69012. frontUVs?: Vector4;
  69013. backUVs?: Vector4;
  69014. instance?: Mesh;
  69015. invertUV?: boolean;
  69016. }, scene?: Nullable<Scene>): Mesh;
  69017. }
  69018. }
  69019. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  69020. import { Scene } from "babylonjs/scene";
  69021. import { Vector4 } from "babylonjs/Maths/math.vector";
  69022. import { Mesh } from "babylonjs/Meshes/mesh";
  69023. import { Nullable } from "babylonjs/types";
  69024. /**
  69025. * Class containing static functions to help procedurally build meshes
  69026. */
  69027. export class IcoSphereBuilder {
  69028. /**
  69029. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69030. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69031. * * 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`)
  69032. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69033. * * 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
  69034. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69035. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69036. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69037. * @param name defines the name of the mesh
  69038. * @param options defines the options used to create the mesh
  69039. * @param scene defines the hosting scene
  69040. * @returns the icosahedron mesh
  69041. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69042. */
  69043. static CreateIcoSphere(name: string, options: {
  69044. radius?: number;
  69045. radiusX?: number;
  69046. radiusY?: number;
  69047. radiusZ?: number;
  69048. flat?: boolean;
  69049. subdivisions?: number;
  69050. sideOrientation?: number;
  69051. frontUVs?: Vector4;
  69052. backUVs?: Vector4;
  69053. updatable?: boolean;
  69054. }, scene?: Nullable<Scene>): Mesh;
  69055. }
  69056. }
  69057. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  69058. import { Vector3 } from "babylonjs/Maths/math.vector";
  69059. import { Mesh } from "babylonjs/Meshes/mesh";
  69060. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69061. /**
  69062. * Class containing static functions to help procedurally build meshes
  69063. */
  69064. export class DecalBuilder {
  69065. /**
  69066. * Creates a decal mesh.
  69067. * 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
  69068. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69069. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69070. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69071. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69072. * @param name defines the name of the mesh
  69073. * @param sourceMesh defines the mesh where the decal must be applied
  69074. * @param options defines the options used to create the mesh
  69075. * @param scene defines the hosting scene
  69076. * @returns the decal mesh
  69077. * @see https://doc.babylonjs.com/how_to/decals
  69078. */
  69079. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69080. position?: Vector3;
  69081. normal?: Vector3;
  69082. size?: Vector3;
  69083. angle?: number;
  69084. }): Mesh;
  69085. }
  69086. }
  69087. declare module "babylonjs/Meshes/meshBuilder" {
  69088. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  69089. import { Nullable } from "babylonjs/types";
  69090. import { Scene } from "babylonjs/scene";
  69091. import { Mesh } from "babylonjs/Meshes/mesh";
  69092. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  69093. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  69094. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69095. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  69096. import { Plane } from "babylonjs/Maths/math.plane";
  69097. /**
  69098. * Class containing static functions to help procedurally build meshes
  69099. */
  69100. export class MeshBuilder {
  69101. /**
  69102. * Creates a box mesh
  69103. * * The parameter `size` sets the size (float) of each box side (default 1)
  69104. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  69105. * * 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)
  69106. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69107. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69108. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69109. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69110. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69111. * @param name defines the name of the mesh
  69112. * @param options defines the options used to create the mesh
  69113. * @param scene defines the hosting scene
  69114. * @returns the box mesh
  69115. */
  69116. static CreateBox(name: string, options: {
  69117. size?: number;
  69118. width?: number;
  69119. height?: number;
  69120. depth?: number;
  69121. faceUV?: Vector4[];
  69122. faceColors?: Color4[];
  69123. sideOrientation?: number;
  69124. frontUVs?: Vector4;
  69125. backUVs?: Vector4;
  69126. wrap?: boolean;
  69127. topBaseAt?: number;
  69128. bottomBaseAt?: number;
  69129. updatable?: boolean;
  69130. }, scene?: Nullable<Scene>): Mesh;
  69131. /**
  69132. * Creates a tiled box mesh
  69133. * * faceTiles sets the pattern, tile size and number of tiles for a face
  69134. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69135. * @param name defines the name of the mesh
  69136. * @param options defines the options used to create the mesh
  69137. * @param scene defines the hosting scene
  69138. * @returns the tiled box mesh
  69139. */
  69140. static CreateTiledBox(name: string, options: {
  69141. pattern?: number;
  69142. size?: number;
  69143. width?: number;
  69144. height?: number;
  69145. depth: number;
  69146. tileSize?: number;
  69147. tileWidth?: number;
  69148. tileHeight?: number;
  69149. faceUV?: Vector4[];
  69150. faceColors?: Color4[];
  69151. alignHorizontal?: number;
  69152. alignVertical?: number;
  69153. sideOrientation?: number;
  69154. updatable?: boolean;
  69155. }, scene?: Nullable<Scene>): Mesh;
  69156. /**
  69157. * Creates a sphere mesh
  69158. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  69159. * * 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`)
  69160. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  69161. * * 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
  69162. * * 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)
  69163. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69164. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69165. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69166. * @param name defines the name of the mesh
  69167. * @param options defines the options used to create the mesh
  69168. * @param scene defines the hosting scene
  69169. * @returns the sphere mesh
  69170. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  69171. */
  69172. static CreateSphere(name: string, options: {
  69173. segments?: number;
  69174. diameter?: number;
  69175. diameterX?: number;
  69176. diameterY?: number;
  69177. diameterZ?: number;
  69178. arc?: number;
  69179. slice?: number;
  69180. sideOrientation?: number;
  69181. frontUVs?: Vector4;
  69182. backUVs?: Vector4;
  69183. updatable?: boolean;
  69184. }, scene?: Nullable<Scene>): Mesh;
  69185. /**
  69186. * Creates a plane polygonal mesh. By default, this is a disc
  69187. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  69188. * * 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
  69189. * * 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
  69190. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69191. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69192. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69193. * @param name defines the name of the mesh
  69194. * @param options defines the options used to create the mesh
  69195. * @param scene defines the hosting scene
  69196. * @returns the plane polygonal mesh
  69197. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  69198. */
  69199. static CreateDisc(name: string, options: {
  69200. radius?: number;
  69201. tessellation?: number;
  69202. arc?: number;
  69203. updatable?: boolean;
  69204. sideOrientation?: number;
  69205. frontUVs?: Vector4;
  69206. backUVs?: Vector4;
  69207. }, scene?: Nullable<Scene>): Mesh;
  69208. /**
  69209. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69210. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69211. * * 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`)
  69212. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69213. * * 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
  69214. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69215. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69216. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69217. * @param name defines the name of the mesh
  69218. * @param options defines the options used to create the mesh
  69219. * @param scene defines the hosting scene
  69220. * @returns the icosahedron mesh
  69221. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69222. */
  69223. static CreateIcoSphere(name: string, options: {
  69224. radius?: number;
  69225. radiusX?: number;
  69226. radiusY?: number;
  69227. radiusZ?: number;
  69228. flat?: boolean;
  69229. subdivisions?: number;
  69230. sideOrientation?: number;
  69231. frontUVs?: Vector4;
  69232. backUVs?: Vector4;
  69233. updatable?: boolean;
  69234. }, scene?: Nullable<Scene>): Mesh;
  69235. /**
  69236. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69237. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  69238. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  69239. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  69240. * * 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
  69241. * * 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
  69242. * * 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
  69243. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69244. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69245. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69246. * * 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
  69247. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  69248. * * 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
  69249. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  69250. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69251. * @param name defines the name of the mesh
  69252. * @param options defines the options used to create the mesh
  69253. * @param scene defines the hosting scene
  69254. * @returns the ribbon mesh
  69255. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  69256. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69257. */
  69258. static CreateRibbon(name: string, options: {
  69259. pathArray: Vector3[][];
  69260. closeArray?: boolean;
  69261. closePath?: boolean;
  69262. offset?: number;
  69263. updatable?: boolean;
  69264. sideOrientation?: number;
  69265. frontUVs?: Vector4;
  69266. backUVs?: Vector4;
  69267. instance?: Mesh;
  69268. invertUV?: boolean;
  69269. uvs?: Vector2[];
  69270. colors?: Color4[];
  69271. }, scene?: Nullable<Scene>): Mesh;
  69272. /**
  69273. * Creates a cylinder or a cone mesh
  69274. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  69275. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  69276. * * 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.
  69277. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  69278. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  69279. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  69280. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  69281. * * 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).
  69282. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  69283. * * 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).
  69284. * * 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
  69285. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  69286. * * 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
  69287. * * 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.
  69288. * * If `enclose` is false, a ring surface is one element.
  69289. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  69290. * * 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
  69291. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69292. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69293. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69294. * @param name defines the name of the mesh
  69295. * @param options defines the options used to create the mesh
  69296. * @param scene defines the hosting scene
  69297. * @returns the cylinder mesh
  69298. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  69299. */
  69300. static CreateCylinder(name: string, options: {
  69301. height?: number;
  69302. diameterTop?: number;
  69303. diameterBottom?: number;
  69304. diameter?: number;
  69305. tessellation?: number;
  69306. subdivisions?: number;
  69307. arc?: number;
  69308. faceColors?: Color4[];
  69309. faceUV?: Vector4[];
  69310. updatable?: boolean;
  69311. hasRings?: boolean;
  69312. enclose?: boolean;
  69313. cap?: number;
  69314. sideOrientation?: number;
  69315. frontUVs?: Vector4;
  69316. backUVs?: Vector4;
  69317. }, scene?: Nullable<Scene>): Mesh;
  69318. /**
  69319. * Creates a torus mesh
  69320. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  69321. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  69322. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  69323. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69324. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69325. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69326. * @param name defines the name of the mesh
  69327. * @param options defines the options used to create the mesh
  69328. * @param scene defines the hosting scene
  69329. * @returns the torus mesh
  69330. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  69331. */
  69332. static CreateTorus(name: string, options: {
  69333. diameter?: number;
  69334. thickness?: number;
  69335. tessellation?: number;
  69336. updatable?: boolean;
  69337. sideOrientation?: number;
  69338. frontUVs?: Vector4;
  69339. backUVs?: Vector4;
  69340. }, scene?: Nullable<Scene>): Mesh;
  69341. /**
  69342. * Creates a torus knot mesh
  69343. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  69344. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  69345. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  69346. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  69347. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69348. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69349. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69350. * @param name defines the name of the mesh
  69351. * @param options defines the options used to create the mesh
  69352. * @param scene defines the hosting scene
  69353. * @returns the torus knot mesh
  69354. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  69355. */
  69356. static CreateTorusKnot(name: string, options: {
  69357. radius?: number;
  69358. tube?: number;
  69359. radialSegments?: number;
  69360. tubularSegments?: number;
  69361. p?: number;
  69362. q?: number;
  69363. updatable?: boolean;
  69364. sideOrientation?: number;
  69365. frontUVs?: Vector4;
  69366. backUVs?: Vector4;
  69367. }, scene?: Nullable<Scene>): Mesh;
  69368. /**
  69369. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  69370. * * 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
  69371. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  69372. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  69373. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  69374. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  69375. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  69376. * * 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
  69377. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  69378. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69379. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  69380. * @param name defines the name of the new line system
  69381. * @param options defines the options used to create the line system
  69382. * @param scene defines the hosting scene
  69383. * @returns a new line system mesh
  69384. */
  69385. static CreateLineSystem(name: string, options: {
  69386. lines: Vector3[][];
  69387. updatable?: boolean;
  69388. instance?: Nullable<LinesMesh>;
  69389. colors?: Nullable<Color4[][]>;
  69390. useVertexAlpha?: boolean;
  69391. }, scene: Nullable<Scene>): LinesMesh;
  69392. /**
  69393. * Creates a line mesh
  69394. * 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
  69395. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69396. * * The parameter `points` is an array successive Vector3
  69397. * * The optional parameter `instance` is an instance of an existing LineMesh object to be updated with the passed `points` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines
  69398. * * The optional parameter `colors` is an array of successive Color4, one per line point
  69399. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  69400. * * When updating an instance, remember that only point positions can change, not the number of points
  69401. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69402. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  69403. * @param name defines the name of the new line system
  69404. * @param options defines the options used to create the line system
  69405. * @param scene defines the hosting scene
  69406. * @returns a new line mesh
  69407. */
  69408. static CreateLines(name: string, options: {
  69409. points: Vector3[];
  69410. updatable?: boolean;
  69411. instance?: Nullable<LinesMesh>;
  69412. colors?: Color4[];
  69413. useVertexAlpha?: boolean;
  69414. }, scene?: Nullable<Scene>): LinesMesh;
  69415. /**
  69416. * Creates a dashed line mesh
  69417. * * 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
  69418. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69419. * * The parameter `points` is an array successive Vector3
  69420. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  69421. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  69422. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  69423. * * 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
  69424. * * When updating an instance, remember that only point positions can change, not the number of points
  69425. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69426. * @param name defines the name of the mesh
  69427. * @param options defines the options used to create the mesh
  69428. * @param scene defines the hosting scene
  69429. * @returns the dashed line mesh
  69430. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  69431. */
  69432. static CreateDashedLines(name: string, options: {
  69433. points: Vector3[];
  69434. dashSize?: number;
  69435. gapSize?: number;
  69436. dashNb?: number;
  69437. updatable?: boolean;
  69438. instance?: LinesMesh;
  69439. }, scene?: Nullable<Scene>): LinesMesh;
  69440. /**
  69441. * 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.
  69442. * * 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.
  69443. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69444. * * 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.
  69445. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  69446. * * 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
  69447. * * 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
  69448. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  69449. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69450. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69451. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  69452. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69453. * @param name defines the name of the mesh
  69454. * @param options defines the options used to create the mesh
  69455. * @param scene defines the hosting scene
  69456. * @returns the extruded shape mesh
  69457. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69458. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69459. */
  69460. static ExtrudeShape(name: string, options: {
  69461. shape: Vector3[];
  69462. path: Vector3[];
  69463. scale?: number;
  69464. rotation?: number;
  69465. cap?: number;
  69466. updatable?: boolean;
  69467. sideOrientation?: number;
  69468. frontUVs?: Vector4;
  69469. backUVs?: Vector4;
  69470. instance?: Mesh;
  69471. invertUV?: boolean;
  69472. }, scene?: Nullable<Scene>): Mesh;
  69473. /**
  69474. * Creates an custom extruded shape mesh.
  69475. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  69476. * * 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.
  69477. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69478. * * 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
  69479. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  69480. * * 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
  69481. * * It must returns a float value that will be the scale value applied to the shape on each path point
  69482. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  69483. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  69484. * * 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
  69485. * * 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
  69486. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  69487. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69488. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69489. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69490. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69491. * @param name defines the name of the mesh
  69492. * @param options defines the options used to create the mesh
  69493. * @param scene defines the hosting scene
  69494. * @returns the custom extruded shape mesh
  69495. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  69496. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69497. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69498. */
  69499. static ExtrudeShapeCustom(name: string, options: {
  69500. shape: Vector3[];
  69501. path: Vector3[];
  69502. scaleFunction?: any;
  69503. rotationFunction?: any;
  69504. ribbonCloseArray?: boolean;
  69505. ribbonClosePath?: boolean;
  69506. cap?: number;
  69507. updatable?: boolean;
  69508. sideOrientation?: number;
  69509. frontUVs?: Vector4;
  69510. backUVs?: Vector4;
  69511. instance?: Mesh;
  69512. invertUV?: boolean;
  69513. }, scene?: Nullable<Scene>): Mesh;
  69514. /**
  69515. * Creates lathe mesh.
  69516. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69517. * * 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
  69518. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69519. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69520. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69521. * * 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
  69522. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69523. * * 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
  69524. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69525. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69526. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69527. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69528. * @param name defines the name of the mesh
  69529. * @param options defines the options used to create the mesh
  69530. * @param scene defines the hosting scene
  69531. * @returns the lathe mesh
  69532. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69533. */
  69534. static CreateLathe(name: string, options: {
  69535. shape: Vector3[];
  69536. radius?: number;
  69537. tessellation?: number;
  69538. clip?: number;
  69539. arc?: number;
  69540. closed?: boolean;
  69541. updatable?: boolean;
  69542. sideOrientation?: number;
  69543. frontUVs?: Vector4;
  69544. backUVs?: Vector4;
  69545. cap?: number;
  69546. invertUV?: boolean;
  69547. }, scene?: Nullable<Scene>): Mesh;
  69548. /**
  69549. * Creates a tiled plane mesh
  69550. * * You can set a limited pattern arrangement with the tiles
  69551. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69552. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69553. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69554. * @param name defines the name of the mesh
  69555. * @param options defines the options used to create the mesh
  69556. * @param scene defines the hosting scene
  69557. * @returns the plane mesh
  69558. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69559. */
  69560. static CreateTiledPlane(name: string, options: {
  69561. pattern?: number;
  69562. tileSize?: number;
  69563. tileWidth?: number;
  69564. tileHeight?: number;
  69565. size?: number;
  69566. width?: number;
  69567. height?: number;
  69568. alignHorizontal?: number;
  69569. alignVertical?: number;
  69570. sideOrientation?: number;
  69571. frontUVs?: Vector4;
  69572. backUVs?: Vector4;
  69573. updatable?: boolean;
  69574. }, scene?: Nullable<Scene>): Mesh;
  69575. /**
  69576. * Creates a plane mesh
  69577. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  69578. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  69579. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  69580. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69581. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69582. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69583. * @param name defines the name of the mesh
  69584. * @param options defines the options used to create the mesh
  69585. * @param scene defines the hosting scene
  69586. * @returns the plane mesh
  69587. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69588. */
  69589. static CreatePlane(name: string, options: {
  69590. size?: number;
  69591. width?: number;
  69592. height?: number;
  69593. sideOrientation?: number;
  69594. frontUVs?: Vector4;
  69595. backUVs?: Vector4;
  69596. updatable?: boolean;
  69597. sourcePlane?: Plane;
  69598. }, scene?: Nullable<Scene>): Mesh;
  69599. /**
  69600. * Creates a ground mesh
  69601. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  69602. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  69603. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69604. * @param name defines the name of the mesh
  69605. * @param options defines the options used to create the mesh
  69606. * @param scene defines the hosting scene
  69607. * @returns the ground mesh
  69608. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  69609. */
  69610. static CreateGround(name: string, options: {
  69611. width?: number;
  69612. height?: number;
  69613. subdivisions?: number;
  69614. subdivisionsX?: number;
  69615. subdivisionsY?: number;
  69616. updatable?: boolean;
  69617. }, scene?: Nullable<Scene>): Mesh;
  69618. /**
  69619. * Creates a tiled ground mesh
  69620. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  69621. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  69622. * * 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
  69623. * * 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
  69624. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69625. * @param name defines the name of the mesh
  69626. * @param options defines the options used to create the mesh
  69627. * @param scene defines the hosting scene
  69628. * @returns the tiled ground mesh
  69629. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  69630. */
  69631. static CreateTiledGround(name: string, options: {
  69632. xmin: number;
  69633. zmin: number;
  69634. xmax: number;
  69635. zmax: number;
  69636. subdivisions?: {
  69637. w: number;
  69638. h: number;
  69639. };
  69640. precision?: {
  69641. w: number;
  69642. h: number;
  69643. };
  69644. updatable?: boolean;
  69645. }, scene?: Nullable<Scene>): Mesh;
  69646. /**
  69647. * Creates a ground mesh from a height map
  69648. * * The parameter `url` sets the URL of the height map image resource.
  69649. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  69650. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  69651. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  69652. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  69653. * * 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.
  69654. * * 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).
  69655. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  69656. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69657. * @param name defines the name of the mesh
  69658. * @param url defines the url to the height map
  69659. * @param options defines the options used to create the mesh
  69660. * @param scene defines the hosting scene
  69661. * @returns the ground mesh
  69662. * @see https://doc.babylonjs.com/babylon101/height_map
  69663. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  69664. */
  69665. static CreateGroundFromHeightMap(name: string, url: string, options: {
  69666. width?: number;
  69667. height?: number;
  69668. subdivisions?: number;
  69669. minHeight?: number;
  69670. maxHeight?: number;
  69671. colorFilter?: Color3;
  69672. alphaFilter?: number;
  69673. updatable?: boolean;
  69674. onReady?: (mesh: GroundMesh) => void;
  69675. }, scene?: Nullable<Scene>): GroundMesh;
  69676. /**
  69677. * Creates a polygon mesh
  69678. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69679. * * 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
  69680. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69681. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69682. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  69683. * * Remember you can only change the shape positions, not their number when updating a polygon
  69684. * @param name defines the name of the mesh
  69685. * @param options defines the options used to create the mesh
  69686. * @param scene defines the hosting scene
  69687. * @param earcutInjection can be used to inject your own earcut reference
  69688. * @returns the polygon mesh
  69689. */
  69690. static CreatePolygon(name: string, options: {
  69691. shape: Vector3[];
  69692. holes?: Vector3[][];
  69693. depth?: number;
  69694. faceUV?: Vector4[];
  69695. faceColors?: Color4[];
  69696. updatable?: boolean;
  69697. sideOrientation?: number;
  69698. frontUVs?: Vector4;
  69699. backUVs?: Vector4;
  69700. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69701. /**
  69702. * Creates an extruded polygon mesh, with depth in the Y direction.
  69703. * * 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)
  69704. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69705. * @param name defines the name of the mesh
  69706. * @param options defines the options used to create the mesh
  69707. * @param scene defines the hosting scene
  69708. * @param earcutInjection can be used to inject your own earcut reference
  69709. * @returns the polygon mesh
  69710. */
  69711. static ExtrudePolygon(name: string, options: {
  69712. shape: Vector3[];
  69713. holes?: Vector3[][];
  69714. depth?: number;
  69715. faceUV?: Vector4[];
  69716. faceColors?: Color4[];
  69717. updatable?: boolean;
  69718. sideOrientation?: number;
  69719. frontUVs?: Vector4;
  69720. backUVs?: Vector4;
  69721. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69722. /**
  69723. * Creates a tube mesh.
  69724. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69725. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69726. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69727. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69728. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69729. * * 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)
  69730. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69731. * * 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
  69732. * * 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
  69733. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69734. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69735. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69736. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69737. * @param name defines the name of the mesh
  69738. * @param options defines the options used to create the mesh
  69739. * @param scene defines the hosting scene
  69740. * @returns the tube mesh
  69741. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69742. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69743. */
  69744. static CreateTube(name: string, options: {
  69745. path: Vector3[];
  69746. radius?: number;
  69747. tessellation?: number;
  69748. radiusFunction?: {
  69749. (i: number, distance: number): number;
  69750. };
  69751. cap?: number;
  69752. arc?: number;
  69753. updatable?: boolean;
  69754. sideOrientation?: number;
  69755. frontUVs?: Vector4;
  69756. backUVs?: Vector4;
  69757. instance?: Mesh;
  69758. invertUV?: boolean;
  69759. }, scene?: Nullable<Scene>): Mesh;
  69760. /**
  69761. * Creates a polyhedron mesh
  69762. * * 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
  69763. * * The parameter `size` (positive float, default 1) sets the polygon size
  69764. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  69765. * * 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`
  69766. * * 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
  69767. * * 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)`)
  69768. * * 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
  69769. * * 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
  69770. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69771. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69772. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69773. * @param name defines the name of the mesh
  69774. * @param options defines the options used to create the mesh
  69775. * @param scene defines the hosting scene
  69776. * @returns the polyhedron mesh
  69777. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  69778. */
  69779. static CreatePolyhedron(name: string, options: {
  69780. type?: number;
  69781. size?: number;
  69782. sizeX?: number;
  69783. sizeY?: number;
  69784. sizeZ?: number;
  69785. custom?: any;
  69786. faceUV?: Vector4[];
  69787. faceColors?: Color4[];
  69788. flat?: boolean;
  69789. updatable?: boolean;
  69790. sideOrientation?: number;
  69791. frontUVs?: Vector4;
  69792. backUVs?: Vector4;
  69793. }, scene?: Nullable<Scene>): Mesh;
  69794. /**
  69795. * Creates a decal mesh.
  69796. * 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
  69797. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69798. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69799. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69800. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69801. * @param name defines the name of the mesh
  69802. * @param sourceMesh defines the mesh where the decal must be applied
  69803. * @param options defines the options used to create the mesh
  69804. * @param scene defines the hosting scene
  69805. * @returns the decal mesh
  69806. * @see https://doc.babylonjs.com/how_to/decals
  69807. */
  69808. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69809. position?: Vector3;
  69810. normal?: Vector3;
  69811. size?: Vector3;
  69812. angle?: number;
  69813. }): Mesh;
  69814. }
  69815. }
  69816. declare module "babylonjs/Meshes/meshSimplification" {
  69817. import { Mesh } from "babylonjs/Meshes/mesh";
  69818. /**
  69819. * A simplifier interface for future simplification implementations
  69820. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69821. */
  69822. export interface ISimplifier {
  69823. /**
  69824. * Simplification of a given mesh according to the given settings.
  69825. * Since this requires computation, it is assumed that the function runs async.
  69826. * @param settings The settings of the simplification, including quality and distance
  69827. * @param successCallback A callback that will be called after the mesh was simplified.
  69828. * @param errorCallback in case of an error, this callback will be called. optional.
  69829. */
  69830. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  69831. }
  69832. /**
  69833. * Expected simplification settings.
  69834. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  69835. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69836. */
  69837. export interface ISimplificationSettings {
  69838. /**
  69839. * Gets or sets the expected quality
  69840. */
  69841. quality: number;
  69842. /**
  69843. * Gets or sets the distance when this optimized version should be used
  69844. */
  69845. distance: number;
  69846. /**
  69847. * Gets an already optimized mesh
  69848. */
  69849. optimizeMesh?: boolean;
  69850. }
  69851. /**
  69852. * Class used to specify simplification options
  69853. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69854. */
  69855. export class SimplificationSettings implements ISimplificationSettings {
  69856. /** expected quality */
  69857. quality: number;
  69858. /** distance when this optimized version should be used */
  69859. distance: number;
  69860. /** already optimized mesh */
  69861. optimizeMesh?: boolean | undefined;
  69862. /**
  69863. * Creates a SimplificationSettings
  69864. * @param quality expected quality
  69865. * @param distance distance when this optimized version should be used
  69866. * @param optimizeMesh already optimized mesh
  69867. */
  69868. constructor(
  69869. /** expected quality */
  69870. quality: number,
  69871. /** distance when this optimized version should be used */
  69872. distance: number,
  69873. /** already optimized mesh */
  69874. optimizeMesh?: boolean | undefined);
  69875. }
  69876. /**
  69877. * Interface used to define a simplification task
  69878. */
  69879. export interface ISimplificationTask {
  69880. /**
  69881. * Array of settings
  69882. */
  69883. settings: Array<ISimplificationSettings>;
  69884. /**
  69885. * Simplification type
  69886. */
  69887. simplificationType: SimplificationType;
  69888. /**
  69889. * Mesh to simplify
  69890. */
  69891. mesh: Mesh;
  69892. /**
  69893. * Callback called on success
  69894. */
  69895. successCallback?: () => void;
  69896. /**
  69897. * Defines if parallel processing can be used
  69898. */
  69899. parallelProcessing: boolean;
  69900. }
  69901. /**
  69902. * Queue used to order the simplification tasks
  69903. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69904. */
  69905. export class SimplificationQueue {
  69906. private _simplificationArray;
  69907. /**
  69908. * Gets a boolean indicating that the process is still running
  69909. */
  69910. running: boolean;
  69911. /**
  69912. * Creates a new queue
  69913. */
  69914. constructor();
  69915. /**
  69916. * Adds a new simplification task
  69917. * @param task defines a task to add
  69918. */
  69919. addTask(task: ISimplificationTask): void;
  69920. /**
  69921. * Execute next task
  69922. */
  69923. executeNext(): void;
  69924. /**
  69925. * Execute a simplification task
  69926. * @param task defines the task to run
  69927. */
  69928. runSimplification(task: ISimplificationTask): void;
  69929. private getSimplifier;
  69930. }
  69931. /**
  69932. * The implemented types of simplification
  69933. * At the moment only Quadratic Error Decimation is implemented
  69934. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69935. */
  69936. export enum SimplificationType {
  69937. /** Quadratic error decimation */
  69938. QUADRATIC = 0
  69939. }
  69940. /**
  69941. * An implementation of the Quadratic Error simplification algorithm.
  69942. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  69943. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  69944. * @author RaananW
  69945. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69946. */
  69947. export class QuadraticErrorSimplification implements ISimplifier {
  69948. private _mesh;
  69949. private triangles;
  69950. private vertices;
  69951. private references;
  69952. private _reconstructedMesh;
  69953. /** Gets or sets the number pf sync interations */
  69954. syncIterations: number;
  69955. /** Gets or sets the aggressiveness of the simplifier */
  69956. aggressiveness: number;
  69957. /** Gets or sets the number of allowed iterations for decimation */
  69958. decimationIterations: number;
  69959. /** Gets or sets the espilon to use for bounding box computation */
  69960. boundingBoxEpsilon: number;
  69961. /**
  69962. * Creates a new QuadraticErrorSimplification
  69963. * @param _mesh defines the target mesh
  69964. */
  69965. constructor(_mesh: Mesh);
  69966. /**
  69967. * Simplification of a given mesh according to the given settings.
  69968. * Since this requires computation, it is assumed that the function runs async.
  69969. * @param settings The settings of the simplification, including quality and distance
  69970. * @param successCallback A callback that will be called after the mesh was simplified.
  69971. */
  69972. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  69973. private runDecimation;
  69974. private initWithMesh;
  69975. private init;
  69976. private reconstructMesh;
  69977. private initDecimatedMesh;
  69978. private isFlipped;
  69979. private updateTriangles;
  69980. private identifyBorder;
  69981. private updateMesh;
  69982. private vertexError;
  69983. private calculateError;
  69984. }
  69985. }
  69986. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  69987. import { Scene } from "babylonjs/scene";
  69988. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  69989. import { ISceneComponent } from "babylonjs/sceneComponent";
  69990. module "babylonjs/scene" {
  69991. interface Scene {
  69992. /** @hidden (Backing field) */
  69993. _simplificationQueue: SimplificationQueue;
  69994. /**
  69995. * Gets or sets the simplification queue attached to the scene
  69996. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69997. */
  69998. simplificationQueue: SimplificationQueue;
  69999. }
  70000. }
  70001. module "babylonjs/Meshes/mesh" {
  70002. interface Mesh {
  70003. /**
  70004. * Simplify the mesh according to the given array of settings.
  70005. * Function will return immediately and will simplify async
  70006. * @param settings a collection of simplification settings
  70007. * @param parallelProcessing should all levels calculate parallel or one after the other
  70008. * @param simplificationType the type of simplification to run
  70009. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  70010. * @returns the current mesh
  70011. */
  70012. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  70013. }
  70014. }
  70015. /**
  70016. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  70017. * created in a scene
  70018. */
  70019. export class SimplicationQueueSceneComponent implements ISceneComponent {
  70020. /**
  70021. * The component name helpfull to identify the component in the list of scene components.
  70022. */
  70023. readonly name: string;
  70024. /**
  70025. * The scene the component belongs to.
  70026. */
  70027. scene: Scene;
  70028. /**
  70029. * Creates a new instance of the component for the given scene
  70030. * @param scene Defines the scene to register the component in
  70031. */
  70032. constructor(scene: Scene);
  70033. /**
  70034. * Registers the component in a given scene
  70035. */
  70036. register(): void;
  70037. /**
  70038. * Rebuilds the elements related to this component in case of
  70039. * context lost for instance.
  70040. */
  70041. rebuild(): void;
  70042. /**
  70043. * Disposes the component and the associated ressources
  70044. */
  70045. dispose(): void;
  70046. private _beforeCameraUpdate;
  70047. }
  70048. }
  70049. declare module "babylonjs/Meshes/Builders/index" {
  70050. export * from "babylonjs/Meshes/Builders/boxBuilder";
  70051. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  70052. export * from "babylonjs/Meshes/Builders/discBuilder";
  70053. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  70054. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  70055. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  70056. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  70057. export * from "babylonjs/Meshes/Builders/torusBuilder";
  70058. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  70059. export * from "babylonjs/Meshes/Builders/linesBuilder";
  70060. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  70061. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  70062. export * from "babylonjs/Meshes/Builders/latheBuilder";
  70063. export * from "babylonjs/Meshes/Builders/planeBuilder";
  70064. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  70065. export * from "babylonjs/Meshes/Builders/groundBuilder";
  70066. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  70067. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  70068. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70069. export * from "babylonjs/Meshes/Builders/decalBuilder";
  70070. }
  70071. declare module "babylonjs/Meshes/thinInstanceMesh" {
  70072. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  70073. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  70074. import { Matrix } from "babylonjs/Maths/math.vector";
  70075. module "babylonjs/Meshes/mesh" {
  70076. interface Mesh {
  70077. /**
  70078. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  70079. */
  70080. thinInstanceEnablePicking: boolean;
  70081. /**
  70082. * Creates a new thin instance
  70083. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  70084. * @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
  70085. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  70086. */
  70087. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  70088. /**
  70089. * Adds the transformation (matrix) of the current mesh as a thin instance
  70090. * @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
  70091. * @returns the thin instance index number
  70092. */
  70093. thinInstanceAddSelf(refresh: boolean): number;
  70094. /**
  70095. * Registers a custom attribute to be used with thin instances
  70096. * @param kind name of the attribute
  70097. * @param stride size in floats of the attribute
  70098. */
  70099. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  70100. /**
  70101. * Sets the matrix of a thin instance
  70102. * @param index index of the thin instance
  70103. * @param matrix matrix to set
  70104. * @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
  70105. */
  70106. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  70107. /**
  70108. * Sets the value of a custom attribute for a thin instance
  70109. * @param kind name of the attribute
  70110. * @param index index of the thin instance
  70111. * @param value value to set
  70112. * @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
  70113. */
  70114. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  70115. /**
  70116. * 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.
  70117. */
  70118. thinInstanceCount: number;
  70119. /**
  70120. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  70121. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  70122. * @param buffer buffer to set
  70123. * @param stride size in floats of each value of the buffer
  70124. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  70125. */
  70126. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  70127. /**
  70128. * Gets the list of world matrices
  70129. * @return an array containing all the world matrices from the thin instances
  70130. */
  70131. thinInstanceGetWorldMatrices(): Matrix[];
  70132. /**
  70133. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  70134. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70135. */
  70136. thinInstanceBufferUpdated(kind: string): void;
  70137. /**
  70138. * Refreshes the bounding info, taking into account all the thin instances defined
  70139. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  70140. */
  70141. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  70142. /** @hidden */
  70143. _thinInstanceInitializeUserStorage(): void;
  70144. /** @hidden */
  70145. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  70146. /** @hidden */
  70147. _userThinInstanceBuffersStorage: {
  70148. data: {
  70149. [key: string]: Float32Array;
  70150. };
  70151. sizes: {
  70152. [key: string]: number;
  70153. };
  70154. vertexBuffers: {
  70155. [key: string]: Nullable<VertexBuffer>;
  70156. };
  70157. strides: {
  70158. [key: string]: number;
  70159. };
  70160. };
  70161. }
  70162. }
  70163. }
  70164. declare module "babylonjs/Meshes/index" {
  70165. export * from "babylonjs/Meshes/abstractMesh";
  70166. export * from "babylonjs/Meshes/buffer";
  70167. export * from "babylonjs/Meshes/Compression/index";
  70168. export * from "babylonjs/Meshes/csg";
  70169. export * from "babylonjs/Meshes/geometry";
  70170. export * from "babylonjs/Meshes/groundMesh";
  70171. export * from "babylonjs/Meshes/trailMesh";
  70172. export * from "babylonjs/Meshes/instancedMesh";
  70173. export * from "babylonjs/Meshes/linesMesh";
  70174. export * from "babylonjs/Meshes/mesh";
  70175. export * from "babylonjs/Meshes/mesh.vertexData";
  70176. export * from "babylonjs/Meshes/meshBuilder";
  70177. export * from "babylonjs/Meshes/meshSimplification";
  70178. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  70179. export * from "babylonjs/Meshes/polygonMesh";
  70180. export * from "babylonjs/Meshes/subMesh";
  70181. export * from "babylonjs/Meshes/meshLODLevel";
  70182. export * from "babylonjs/Meshes/transformNode";
  70183. export * from "babylonjs/Meshes/Builders/index";
  70184. export * from "babylonjs/Meshes/dataBuffer";
  70185. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  70186. import "babylonjs/Meshes/thinInstanceMesh";
  70187. export * from "babylonjs/Meshes/thinInstanceMesh";
  70188. }
  70189. declare module "babylonjs/Morph/index" {
  70190. export * from "babylonjs/Morph/morphTarget";
  70191. export * from "babylonjs/Morph/morphTargetManager";
  70192. }
  70193. declare module "babylonjs/Navigation/INavigationEngine" {
  70194. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70195. import { Vector3 } from "babylonjs/Maths/math";
  70196. import { Mesh } from "babylonjs/Meshes/mesh";
  70197. import { Scene } from "babylonjs/scene";
  70198. /**
  70199. * Navigation plugin interface to add navigation constrained by a navigation mesh
  70200. */
  70201. export interface INavigationEnginePlugin {
  70202. /**
  70203. * plugin name
  70204. */
  70205. name: string;
  70206. /**
  70207. * Creates a navigation mesh
  70208. * @param meshes array of all the geometry used to compute the navigatio mesh
  70209. * @param parameters bunch of parameters used to filter geometry
  70210. */
  70211. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70212. /**
  70213. * Create a navigation mesh debug mesh
  70214. * @param scene is where the mesh will be added
  70215. * @returns debug display mesh
  70216. */
  70217. createDebugNavMesh(scene: Scene): Mesh;
  70218. /**
  70219. * Get a navigation mesh constrained position, closest to the parameter position
  70220. * @param position world position
  70221. * @returns the closest point to position constrained by the navigation mesh
  70222. */
  70223. getClosestPoint(position: Vector3): Vector3;
  70224. /**
  70225. * Get a navigation mesh constrained position, closest to the parameter position
  70226. * @param position world position
  70227. * @param result output the closest point to position constrained by the navigation mesh
  70228. */
  70229. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70230. /**
  70231. * Get a navigation mesh constrained position, within a particular radius
  70232. * @param position world position
  70233. * @param maxRadius the maximum distance to the constrained world position
  70234. * @returns the closest point to position constrained by the navigation mesh
  70235. */
  70236. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70237. /**
  70238. * Get a navigation mesh constrained position, within a particular radius
  70239. * @param position world position
  70240. * @param maxRadius the maximum distance to the constrained world position
  70241. * @param result output the closest point to position constrained by the navigation mesh
  70242. */
  70243. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70244. /**
  70245. * Compute the final position from a segment made of destination-position
  70246. * @param position world position
  70247. * @param destination world position
  70248. * @returns the resulting point along the navmesh
  70249. */
  70250. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70251. /**
  70252. * Compute the final position from a segment made of destination-position
  70253. * @param position world position
  70254. * @param destination world position
  70255. * @param result output the resulting point along the navmesh
  70256. */
  70257. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70258. /**
  70259. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70260. * @param start world position
  70261. * @param end world position
  70262. * @returns array containing world position composing the path
  70263. */
  70264. computePath(start: Vector3, end: Vector3): Vector3[];
  70265. /**
  70266. * If this plugin is supported
  70267. * @returns true if plugin is supported
  70268. */
  70269. isSupported(): boolean;
  70270. /**
  70271. * Create a new Crowd so you can add agents
  70272. * @param maxAgents the maximum agent count in the crowd
  70273. * @param maxAgentRadius the maximum radius an agent can have
  70274. * @param scene to attach the crowd to
  70275. * @returns the crowd you can add agents to
  70276. */
  70277. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70278. /**
  70279. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70280. * The queries will try to find a solution within those bounds
  70281. * default is (1,1,1)
  70282. * @param extent x,y,z value that define the extent around the queries point of reference
  70283. */
  70284. setDefaultQueryExtent(extent: Vector3): void;
  70285. /**
  70286. * Get the Bounding box extent specified by setDefaultQueryExtent
  70287. * @returns the box extent values
  70288. */
  70289. getDefaultQueryExtent(): Vector3;
  70290. /**
  70291. * build the navmesh from a previously saved state using getNavmeshData
  70292. * @param data the Uint8Array returned by getNavmeshData
  70293. */
  70294. buildFromNavmeshData(data: Uint8Array): void;
  70295. /**
  70296. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70297. * @returns data the Uint8Array that can be saved and reused
  70298. */
  70299. getNavmeshData(): Uint8Array;
  70300. /**
  70301. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70302. * @param result output the box extent values
  70303. */
  70304. getDefaultQueryExtentToRef(result: Vector3): void;
  70305. /**
  70306. * Release all resources
  70307. */
  70308. dispose(): void;
  70309. }
  70310. /**
  70311. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  70312. */
  70313. export interface ICrowd {
  70314. /**
  70315. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70316. * You can attach anything to that node. The node position is updated in the scene update tick.
  70317. * @param pos world position that will be constrained by the navigation mesh
  70318. * @param parameters agent parameters
  70319. * @param transform hooked to the agent that will be update by the scene
  70320. * @returns agent index
  70321. */
  70322. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70323. /**
  70324. * Returns the agent position in world space
  70325. * @param index agent index returned by addAgent
  70326. * @returns world space position
  70327. */
  70328. getAgentPosition(index: number): Vector3;
  70329. /**
  70330. * Gets the agent position result in world space
  70331. * @param index agent index returned by addAgent
  70332. * @param result output world space position
  70333. */
  70334. getAgentPositionToRef(index: number, result: Vector3): void;
  70335. /**
  70336. * Gets the agent velocity in world space
  70337. * @param index agent index returned by addAgent
  70338. * @returns world space velocity
  70339. */
  70340. getAgentVelocity(index: number): Vector3;
  70341. /**
  70342. * Gets the agent velocity result in world space
  70343. * @param index agent index returned by addAgent
  70344. * @param result output world space velocity
  70345. */
  70346. getAgentVelocityToRef(index: number, result: Vector3): void;
  70347. /**
  70348. * remove a particular agent previously created
  70349. * @param index agent index returned by addAgent
  70350. */
  70351. removeAgent(index: number): void;
  70352. /**
  70353. * get the list of all agents attached to this crowd
  70354. * @returns list of agent indices
  70355. */
  70356. getAgents(): number[];
  70357. /**
  70358. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70359. * @param deltaTime in seconds
  70360. */
  70361. update(deltaTime: number): void;
  70362. /**
  70363. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70364. * @param index agent index returned by addAgent
  70365. * @param destination targeted world position
  70366. */
  70367. agentGoto(index: number, destination: Vector3): void;
  70368. /**
  70369. * Teleport the agent to a new position
  70370. * @param index agent index returned by addAgent
  70371. * @param destination targeted world position
  70372. */
  70373. agentTeleport(index: number, destination: Vector3): void;
  70374. /**
  70375. * Update agent parameters
  70376. * @param index agent index returned by addAgent
  70377. * @param parameters agent parameters
  70378. */
  70379. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70380. /**
  70381. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70382. * The queries will try to find a solution within those bounds
  70383. * default is (1,1,1)
  70384. * @param extent x,y,z value that define the extent around the queries point of reference
  70385. */
  70386. setDefaultQueryExtent(extent: Vector3): void;
  70387. /**
  70388. * Get the Bounding box extent specified by setDefaultQueryExtent
  70389. * @returns the box extent values
  70390. */
  70391. getDefaultQueryExtent(): Vector3;
  70392. /**
  70393. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70394. * @param result output the box extent values
  70395. */
  70396. getDefaultQueryExtentToRef(result: Vector3): void;
  70397. /**
  70398. * Release all resources
  70399. */
  70400. dispose(): void;
  70401. }
  70402. /**
  70403. * Configures an agent
  70404. */
  70405. export interface IAgentParameters {
  70406. /**
  70407. * Agent radius. [Limit: >= 0]
  70408. */
  70409. radius: number;
  70410. /**
  70411. * Agent height. [Limit: > 0]
  70412. */
  70413. height: number;
  70414. /**
  70415. * Maximum allowed acceleration. [Limit: >= 0]
  70416. */
  70417. maxAcceleration: number;
  70418. /**
  70419. * Maximum allowed speed. [Limit: >= 0]
  70420. */
  70421. maxSpeed: number;
  70422. /**
  70423. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  70424. */
  70425. collisionQueryRange: number;
  70426. /**
  70427. * The path visibility optimization range. [Limit: > 0]
  70428. */
  70429. pathOptimizationRange: number;
  70430. /**
  70431. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  70432. */
  70433. separationWeight: number;
  70434. }
  70435. /**
  70436. * Configures the navigation mesh creation
  70437. */
  70438. export interface INavMeshParameters {
  70439. /**
  70440. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  70441. */
  70442. cs: number;
  70443. /**
  70444. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  70445. */
  70446. ch: number;
  70447. /**
  70448. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  70449. */
  70450. walkableSlopeAngle: number;
  70451. /**
  70452. * Minimum floor to 'ceiling' height that will still allow the floor area to
  70453. * be considered walkable. [Limit: >= 3] [Units: vx]
  70454. */
  70455. walkableHeight: number;
  70456. /**
  70457. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  70458. */
  70459. walkableClimb: number;
  70460. /**
  70461. * The distance to erode/shrink the walkable area of the heightfield away from
  70462. * obstructions. [Limit: >=0] [Units: vx]
  70463. */
  70464. walkableRadius: number;
  70465. /**
  70466. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  70467. */
  70468. maxEdgeLen: number;
  70469. /**
  70470. * The maximum distance a simplfied contour's border edges should deviate
  70471. * the original raw contour. [Limit: >=0] [Units: vx]
  70472. */
  70473. maxSimplificationError: number;
  70474. /**
  70475. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  70476. */
  70477. minRegionArea: number;
  70478. /**
  70479. * Any regions with a span count smaller than this value will, if possible,
  70480. * be merged with larger regions. [Limit: >=0] [Units: vx]
  70481. */
  70482. mergeRegionArea: number;
  70483. /**
  70484. * The maximum number of vertices allowed for polygons generated during the
  70485. * contour to polygon conversion process. [Limit: >= 3]
  70486. */
  70487. maxVertsPerPoly: number;
  70488. /**
  70489. * Sets the sampling distance to use when generating the detail mesh.
  70490. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  70491. */
  70492. detailSampleDist: number;
  70493. /**
  70494. * The maximum distance the detail mesh surface should deviate from heightfield
  70495. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  70496. */
  70497. detailSampleMaxError: number;
  70498. }
  70499. }
  70500. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  70501. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  70502. import { Mesh } from "babylonjs/Meshes/mesh";
  70503. import { Scene } from "babylonjs/scene";
  70504. import { Vector3 } from "babylonjs/Maths/math";
  70505. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70506. /**
  70507. * RecastJS navigation plugin
  70508. */
  70509. export class RecastJSPlugin implements INavigationEnginePlugin {
  70510. /**
  70511. * Reference to the Recast library
  70512. */
  70513. bjsRECAST: any;
  70514. /**
  70515. * plugin name
  70516. */
  70517. name: string;
  70518. /**
  70519. * the first navmesh created. We might extend this to support multiple navmeshes
  70520. */
  70521. navMesh: any;
  70522. /**
  70523. * Initializes the recastJS plugin
  70524. * @param recastInjection can be used to inject your own recast reference
  70525. */
  70526. constructor(recastInjection?: any);
  70527. /**
  70528. * Creates a navigation mesh
  70529. * @param meshes array of all the geometry used to compute the navigatio mesh
  70530. * @param parameters bunch of parameters used to filter geometry
  70531. */
  70532. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70533. /**
  70534. * Create a navigation mesh debug mesh
  70535. * @param scene is where the mesh will be added
  70536. * @returns debug display mesh
  70537. */
  70538. createDebugNavMesh(scene: Scene): Mesh;
  70539. /**
  70540. * Get a navigation mesh constrained position, closest to the parameter position
  70541. * @param position world position
  70542. * @returns the closest point to position constrained by the navigation mesh
  70543. */
  70544. getClosestPoint(position: Vector3): Vector3;
  70545. /**
  70546. * Get a navigation mesh constrained position, closest to the parameter position
  70547. * @param position world position
  70548. * @param result output the closest point to position constrained by the navigation mesh
  70549. */
  70550. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70551. /**
  70552. * Get a navigation mesh constrained position, within a particular radius
  70553. * @param position world position
  70554. * @param maxRadius the maximum distance to the constrained world position
  70555. * @returns the closest point to position constrained by the navigation mesh
  70556. */
  70557. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70558. /**
  70559. * Get a navigation mesh constrained position, within a particular radius
  70560. * @param position world position
  70561. * @param maxRadius the maximum distance to the constrained world position
  70562. * @param result output the closest point to position constrained by the navigation mesh
  70563. */
  70564. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70565. /**
  70566. * Compute the final position from a segment made of destination-position
  70567. * @param position world position
  70568. * @param destination world position
  70569. * @returns the resulting point along the navmesh
  70570. */
  70571. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70572. /**
  70573. * Compute the final position from a segment made of destination-position
  70574. * @param position world position
  70575. * @param destination world position
  70576. * @param result output the resulting point along the navmesh
  70577. */
  70578. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70579. /**
  70580. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70581. * @param start world position
  70582. * @param end world position
  70583. * @returns array containing world position composing the path
  70584. */
  70585. computePath(start: Vector3, end: Vector3): Vector3[];
  70586. /**
  70587. * Create a new Crowd so you can add agents
  70588. * @param maxAgents the maximum agent count in the crowd
  70589. * @param maxAgentRadius the maximum radius an agent can have
  70590. * @param scene to attach the crowd to
  70591. * @returns the crowd you can add agents to
  70592. */
  70593. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70594. /**
  70595. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70596. * The queries will try to find a solution within those bounds
  70597. * default is (1,1,1)
  70598. * @param extent x,y,z value that define the extent around the queries point of reference
  70599. */
  70600. setDefaultQueryExtent(extent: Vector3): void;
  70601. /**
  70602. * Get the Bounding box extent specified by setDefaultQueryExtent
  70603. * @returns the box extent values
  70604. */
  70605. getDefaultQueryExtent(): Vector3;
  70606. /**
  70607. * build the navmesh from a previously saved state using getNavmeshData
  70608. * @param data the Uint8Array returned by getNavmeshData
  70609. */
  70610. buildFromNavmeshData(data: Uint8Array): void;
  70611. /**
  70612. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70613. * @returns data the Uint8Array that can be saved and reused
  70614. */
  70615. getNavmeshData(): Uint8Array;
  70616. /**
  70617. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70618. * @param result output the box extent values
  70619. */
  70620. getDefaultQueryExtentToRef(result: Vector3): void;
  70621. /**
  70622. * Disposes
  70623. */
  70624. dispose(): void;
  70625. /**
  70626. * If this plugin is supported
  70627. * @returns true if plugin is supported
  70628. */
  70629. isSupported(): boolean;
  70630. }
  70631. /**
  70632. * Recast detour crowd implementation
  70633. */
  70634. export class RecastJSCrowd implements ICrowd {
  70635. /**
  70636. * Recast/detour plugin
  70637. */
  70638. bjsRECASTPlugin: RecastJSPlugin;
  70639. /**
  70640. * Link to the detour crowd
  70641. */
  70642. recastCrowd: any;
  70643. /**
  70644. * One transform per agent
  70645. */
  70646. transforms: TransformNode[];
  70647. /**
  70648. * All agents created
  70649. */
  70650. agents: number[];
  70651. /**
  70652. * Link to the scene is kept to unregister the crowd from the scene
  70653. */
  70654. private _scene;
  70655. /**
  70656. * Observer for crowd updates
  70657. */
  70658. private _onBeforeAnimationsObserver;
  70659. /**
  70660. * Constructor
  70661. * @param plugin recastJS plugin
  70662. * @param maxAgents the maximum agent count in the crowd
  70663. * @param maxAgentRadius the maximum radius an agent can have
  70664. * @param scene to attach the crowd to
  70665. * @returns the crowd you can add agents to
  70666. */
  70667. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  70668. /**
  70669. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70670. * You can attach anything to that node. The node position is updated in the scene update tick.
  70671. * @param pos world position that will be constrained by the navigation mesh
  70672. * @param parameters agent parameters
  70673. * @param transform hooked to the agent that will be update by the scene
  70674. * @returns agent index
  70675. */
  70676. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70677. /**
  70678. * Returns the agent position in world space
  70679. * @param index agent index returned by addAgent
  70680. * @returns world space position
  70681. */
  70682. getAgentPosition(index: number): Vector3;
  70683. /**
  70684. * Returns the agent position result in world space
  70685. * @param index agent index returned by addAgent
  70686. * @param result output world space position
  70687. */
  70688. getAgentPositionToRef(index: number, result: Vector3): void;
  70689. /**
  70690. * Returns the agent velocity in world space
  70691. * @param index agent index returned by addAgent
  70692. * @returns world space velocity
  70693. */
  70694. getAgentVelocity(index: number): Vector3;
  70695. /**
  70696. * Returns the agent velocity result in world space
  70697. * @param index agent index returned by addAgent
  70698. * @param result output world space velocity
  70699. */
  70700. getAgentVelocityToRef(index: number, result: Vector3): void;
  70701. /**
  70702. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70703. * @param index agent index returned by addAgent
  70704. * @param destination targeted world position
  70705. */
  70706. agentGoto(index: number, destination: Vector3): void;
  70707. /**
  70708. * Teleport the agent to a new position
  70709. * @param index agent index returned by addAgent
  70710. * @param destination targeted world position
  70711. */
  70712. agentTeleport(index: number, destination: Vector3): void;
  70713. /**
  70714. * Update agent parameters
  70715. * @param index agent index returned by addAgent
  70716. * @param parameters agent parameters
  70717. */
  70718. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70719. /**
  70720. * remove a particular agent previously created
  70721. * @param index agent index returned by addAgent
  70722. */
  70723. removeAgent(index: number): void;
  70724. /**
  70725. * get the list of all agents attached to this crowd
  70726. * @returns list of agent indices
  70727. */
  70728. getAgents(): number[];
  70729. /**
  70730. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70731. * @param deltaTime in seconds
  70732. */
  70733. update(deltaTime: number): void;
  70734. /**
  70735. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70736. * The queries will try to find a solution within those bounds
  70737. * default is (1,1,1)
  70738. * @param extent x,y,z value that define the extent around the queries point of reference
  70739. */
  70740. setDefaultQueryExtent(extent: Vector3): void;
  70741. /**
  70742. * Get the Bounding box extent specified by setDefaultQueryExtent
  70743. * @returns the box extent values
  70744. */
  70745. getDefaultQueryExtent(): Vector3;
  70746. /**
  70747. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70748. * @param result output the box extent values
  70749. */
  70750. getDefaultQueryExtentToRef(result: Vector3): void;
  70751. /**
  70752. * Release all resources
  70753. */
  70754. dispose(): void;
  70755. }
  70756. }
  70757. declare module "babylonjs/Navigation/Plugins/index" {
  70758. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  70759. }
  70760. declare module "babylonjs/Navigation/index" {
  70761. export * from "babylonjs/Navigation/INavigationEngine";
  70762. export * from "babylonjs/Navigation/Plugins/index";
  70763. }
  70764. declare module "babylonjs/Offline/database" {
  70765. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  70766. /**
  70767. * Class used to enable access to IndexedDB
  70768. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  70769. */
  70770. export class Database implements IOfflineProvider {
  70771. private _callbackManifestChecked;
  70772. private _currentSceneUrl;
  70773. private _db;
  70774. private _enableSceneOffline;
  70775. private _enableTexturesOffline;
  70776. private _manifestVersionFound;
  70777. private _mustUpdateRessources;
  70778. private _hasReachedQuota;
  70779. private _isSupported;
  70780. private _idbFactory;
  70781. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  70782. private static IsUASupportingBlobStorage;
  70783. /**
  70784. * Gets a boolean indicating if Database storate is enabled (off by default)
  70785. */
  70786. static IDBStorageEnabled: boolean;
  70787. /**
  70788. * Gets a boolean indicating if scene must be saved in the database
  70789. */
  70790. get enableSceneOffline(): boolean;
  70791. /**
  70792. * Gets a boolean indicating if textures must be saved in the database
  70793. */
  70794. get enableTexturesOffline(): boolean;
  70795. /**
  70796. * Creates a new Database
  70797. * @param urlToScene defines the url to load the scene
  70798. * @param callbackManifestChecked defines the callback to use when manifest is checked
  70799. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  70800. */
  70801. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  70802. private static _ParseURL;
  70803. private static _ReturnFullUrlLocation;
  70804. private _checkManifestFile;
  70805. /**
  70806. * Open the database and make it available
  70807. * @param successCallback defines the callback to call on success
  70808. * @param errorCallback defines the callback to call on error
  70809. */
  70810. open(successCallback: () => void, errorCallback: () => void): void;
  70811. /**
  70812. * Loads an image from the database
  70813. * @param url defines the url to load from
  70814. * @param image defines the target DOM image
  70815. */
  70816. loadImage(url: string, image: HTMLImageElement): void;
  70817. private _loadImageFromDBAsync;
  70818. private _saveImageIntoDBAsync;
  70819. private _checkVersionFromDB;
  70820. private _loadVersionFromDBAsync;
  70821. private _saveVersionIntoDBAsync;
  70822. /**
  70823. * Loads a file from database
  70824. * @param url defines the URL to load from
  70825. * @param sceneLoaded defines a callback to call on success
  70826. * @param progressCallBack defines a callback to call when progress changed
  70827. * @param errorCallback defines a callback to call on error
  70828. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  70829. */
  70830. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  70831. private _loadFileAsync;
  70832. private _saveFileAsync;
  70833. /**
  70834. * Validates if xhr data is correct
  70835. * @param xhr defines the request to validate
  70836. * @param dataType defines the expected data type
  70837. * @returns true if data is correct
  70838. */
  70839. private static _ValidateXHRData;
  70840. }
  70841. }
  70842. declare module "babylonjs/Offline/index" {
  70843. export * from "babylonjs/Offline/database";
  70844. export * from "babylonjs/Offline/IOfflineProvider";
  70845. }
  70846. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  70847. /** @hidden */
  70848. export var gpuUpdateParticlesPixelShader: {
  70849. name: string;
  70850. shader: string;
  70851. };
  70852. }
  70853. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  70854. /** @hidden */
  70855. export var gpuUpdateParticlesVertexShader: {
  70856. name: string;
  70857. shader: string;
  70858. };
  70859. }
  70860. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  70861. /** @hidden */
  70862. export var clipPlaneFragmentDeclaration2: {
  70863. name: string;
  70864. shader: string;
  70865. };
  70866. }
  70867. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  70868. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  70869. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  70870. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  70871. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  70872. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  70873. /** @hidden */
  70874. export var gpuRenderParticlesPixelShader: {
  70875. name: string;
  70876. shader: string;
  70877. };
  70878. }
  70879. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  70880. /** @hidden */
  70881. export var clipPlaneVertexDeclaration2: {
  70882. name: string;
  70883. shader: string;
  70884. };
  70885. }
  70886. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  70887. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  70888. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  70889. /** @hidden */
  70890. export var gpuRenderParticlesVertexShader: {
  70891. name: string;
  70892. shader: string;
  70893. };
  70894. }
  70895. declare module "babylonjs/Particles/gpuParticleSystem" {
  70896. import { Nullable } from "babylonjs/types";
  70897. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  70898. import { Observable } from "babylonjs/Misc/observable";
  70899. import { Matrix } from "babylonjs/Maths/math.vector";
  70900. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  70901. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70902. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  70903. import { IDisposable } from "babylonjs/scene";
  70904. import { Effect } from "babylonjs/Materials/effect";
  70905. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  70906. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  70907. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  70908. import { Scene } from "babylonjs/scene";
  70909. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  70910. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  70911. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  70912. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  70913. /**
  70914. * This represents a GPU particle system in Babylon
  70915. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  70916. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  70917. */
  70918. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  70919. /**
  70920. * The layer mask we are rendering the particles through.
  70921. */
  70922. layerMask: number;
  70923. private _capacity;
  70924. private _activeCount;
  70925. private _currentActiveCount;
  70926. private _accumulatedCount;
  70927. private _renderEffect;
  70928. private _updateEffect;
  70929. private _buffer0;
  70930. private _buffer1;
  70931. private _spriteBuffer;
  70932. private _updateVAO;
  70933. private _renderVAO;
  70934. private _targetIndex;
  70935. private _sourceBuffer;
  70936. private _targetBuffer;
  70937. private _currentRenderId;
  70938. private _started;
  70939. private _stopped;
  70940. private _timeDelta;
  70941. private _randomTexture;
  70942. private _randomTexture2;
  70943. private _attributesStrideSize;
  70944. private _updateEffectOptions;
  70945. private _randomTextureSize;
  70946. private _actualFrame;
  70947. private _customEffect;
  70948. private readonly _rawTextureWidth;
  70949. /**
  70950. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  70951. */
  70952. static get IsSupported(): boolean;
  70953. /**
  70954. * An event triggered when the system is disposed.
  70955. */
  70956. onDisposeObservable: Observable<IParticleSystem>;
  70957. /**
  70958. * Gets the maximum number of particles active at the same time.
  70959. * @returns The max number of active particles.
  70960. */
  70961. getCapacity(): number;
  70962. /**
  70963. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  70964. * to override the particles.
  70965. */
  70966. forceDepthWrite: boolean;
  70967. /**
  70968. * Gets or set the number of active particles
  70969. */
  70970. get activeParticleCount(): number;
  70971. set activeParticleCount(value: number);
  70972. private _preWarmDone;
  70973. /**
  70974. * Specifies if the particles are updated in emitter local space or world space.
  70975. */
  70976. isLocal: boolean;
  70977. /** Gets or sets a matrix to use to compute projection */
  70978. defaultProjectionMatrix: Matrix;
  70979. /**
  70980. * Is this system ready to be used/rendered
  70981. * @return true if the system is ready
  70982. */
  70983. isReady(): boolean;
  70984. /**
  70985. * Gets if the system has been started. (Note: this will still be true after stop is called)
  70986. * @returns True if it has been started, otherwise false.
  70987. */
  70988. isStarted(): boolean;
  70989. /**
  70990. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  70991. * @returns True if it has been stopped, otherwise false.
  70992. */
  70993. isStopped(): boolean;
  70994. /**
  70995. * Gets a boolean indicating that the system is stopping
  70996. * @returns true if the system is currently stopping
  70997. */
  70998. isStopping(): boolean;
  70999. /**
  71000. * Gets the number of particles active at the same time.
  71001. * @returns The number of active particles.
  71002. */
  71003. getActiveCount(): number;
  71004. /**
  71005. * Starts the particle system and begins to emit
  71006. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  71007. */
  71008. start(delay?: number): void;
  71009. /**
  71010. * Stops the particle system.
  71011. */
  71012. stop(): void;
  71013. /**
  71014. * Remove all active particles
  71015. */
  71016. reset(): void;
  71017. /**
  71018. * Returns the string "GPUParticleSystem"
  71019. * @returns a string containing the class name
  71020. */
  71021. getClassName(): string;
  71022. /**
  71023. * Gets the custom effect used to render the particles
  71024. * @param blendMode Blend mode for which the effect should be retrieved
  71025. * @returns The effect
  71026. */
  71027. getCustomEffect(blendMode?: number): Nullable<Effect>;
  71028. /**
  71029. * Sets the custom effect used to render the particles
  71030. * @param effect The effect to set
  71031. * @param blendMode Blend mode for which the effect should be set
  71032. */
  71033. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  71034. /** @hidden */
  71035. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  71036. /**
  71037. * Observable that will be called just before the particles are drawn
  71038. */
  71039. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  71040. /**
  71041. * Gets the name of the particle vertex shader
  71042. */
  71043. get vertexShaderName(): string;
  71044. private _colorGradientsTexture;
  71045. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  71046. /**
  71047. * Adds a new color gradient
  71048. * @param gradient defines the gradient to use (between 0 and 1)
  71049. * @param color1 defines the color to affect to the specified gradient
  71050. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  71051. * @returns the current particle system
  71052. */
  71053. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  71054. private _refreshColorGradient;
  71055. /** Force the system to rebuild all gradients that need to be resync */
  71056. forceRefreshGradients(): void;
  71057. /**
  71058. * Remove a specific color gradient
  71059. * @param gradient defines the gradient to remove
  71060. * @returns the current particle system
  71061. */
  71062. removeColorGradient(gradient: number): GPUParticleSystem;
  71063. private _angularSpeedGradientsTexture;
  71064. private _sizeGradientsTexture;
  71065. private _velocityGradientsTexture;
  71066. private _limitVelocityGradientsTexture;
  71067. private _dragGradientsTexture;
  71068. private _addFactorGradient;
  71069. /**
  71070. * Adds a new size gradient
  71071. * @param gradient defines the gradient to use (between 0 and 1)
  71072. * @param factor defines the size factor to affect to the specified gradient
  71073. * @returns the current particle system
  71074. */
  71075. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  71076. /**
  71077. * Remove a specific size gradient
  71078. * @param gradient defines the gradient to remove
  71079. * @returns the current particle system
  71080. */
  71081. removeSizeGradient(gradient: number): GPUParticleSystem;
  71082. private _refreshFactorGradient;
  71083. /**
  71084. * Adds a new angular speed gradient
  71085. * @param gradient defines the gradient to use (between 0 and 1)
  71086. * @param factor defines the angular speed to affect to the specified gradient
  71087. * @returns the current particle system
  71088. */
  71089. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  71090. /**
  71091. * Remove a specific angular speed gradient
  71092. * @param gradient defines the gradient to remove
  71093. * @returns the current particle system
  71094. */
  71095. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  71096. /**
  71097. * Adds a new velocity gradient
  71098. * @param gradient defines the gradient to use (between 0 and 1)
  71099. * @param factor defines the velocity to affect to the specified gradient
  71100. * @returns the current particle system
  71101. */
  71102. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71103. /**
  71104. * Remove a specific velocity gradient
  71105. * @param gradient defines the gradient to remove
  71106. * @returns the current particle system
  71107. */
  71108. removeVelocityGradient(gradient: number): GPUParticleSystem;
  71109. /**
  71110. * Adds a new limit velocity gradient
  71111. * @param gradient defines the gradient to use (between 0 and 1)
  71112. * @param factor defines the limit velocity value to affect to the specified gradient
  71113. * @returns the current particle system
  71114. */
  71115. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71116. /**
  71117. * Remove a specific limit velocity gradient
  71118. * @param gradient defines the gradient to remove
  71119. * @returns the current particle system
  71120. */
  71121. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  71122. /**
  71123. * Adds a new drag gradient
  71124. * @param gradient defines the gradient to use (between 0 and 1)
  71125. * @param factor defines the drag value to affect to the specified gradient
  71126. * @returns the current particle system
  71127. */
  71128. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  71129. /**
  71130. * Remove a specific drag gradient
  71131. * @param gradient defines the gradient to remove
  71132. * @returns the current particle system
  71133. */
  71134. removeDragGradient(gradient: number): GPUParticleSystem;
  71135. /**
  71136. * Not supported by GPUParticleSystem
  71137. * @param gradient defines the gradient to use (between 0 and 1)
  71138. * @param factor defines the emit rate value to affect to the specified gradient
  71139. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71140. * @returns the current particle system
  71141. */
  71142. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71143. /**
  71144. * Not supported by GPUParticleSystem
  71145. * @param gradient defines the gradient to remove
  71146. * @returns the current particle system
  71147. */
  71148. removeEmitRateGradient(gradient: number): IParticleSystem;
  71149. /**
  71150. * Not supported by GPUParticleSystem
  71151. * @param gradient defines the gradient to use (between 0 and 1)
  71152. * @param factor defines the start size value to affect to the specified gradient
  71153. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71154. * @returns the current particle system
  71155. */
  71156. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71157. /**
  71158. * Not supported by GPUParticleSystem
  71159. * @param gradient defines the gradient to remove
  71160. * @returns the current particle system
  71161. */
  71162. removeStartSizeGradient(gradient: number): IParticleSystem;
  71163. /**
  71164. * Not supported by GPUParticleSystem
  71165. * @param gradient defines the gradient to use (between 0 and 1)
  71166. * @param min defines the color remap minimal range
  71167. * @param max defines the color remap maximal range
  71168. * @returns the current particle system
  71169. */
  71170. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71171. /**
  71172. * Not supported by GPUParticleSystem
  71173. * @param gradient defines the gradient to remove
  71174. * @returns the current particle system
  71175. */
  71176. removeColorRemapGradient(): IParticleSystem;
  71177. /**
  71178. * Not supported by GPUParticleSystem
  71179. * @param gradient defines the gradient to use (between 0 and 1)
  71180. * @param min defines the alpha remap minimal range
  71181. * @param max defines the alpha remap maximal range
  71182. * @returns the current particle system
  71183. */
  71184. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71185. /**
  71186. * Not supported by GPUParticleSystem
  71187. * @param gradient defines the gradient to remove
  71188. * @returns the current particle system
  71189. */
  71190. removeAlphaRemapGradient(): IParticleSystem;
  71191. /**
  71192. * Not supported by GPUParticleSystem
  71193. * @param gradient defines the gradient to use (between 0 and 1)
  71194. * @param color defines the color to affect to the specified gradient
  71195. * @returns the current particle system
  71196. */
  71197. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  71198. /**
  71199. * Not supported by GPUParticleSystem
  71200. * @param gradient defines the gradient to remove
  71201. * @returns the current particle system
  71202. */
  71203. removeRampGradient(): IParticleSystem;
  71204. /**
  71205. * Not supported by GPUParticleSystem
  71206. * @returns the list of ramp gradients
  71207. */
  71208. getRampGradients(): Nullable<Array<Color3Gradient>>;
  71209. /**
  71210. * Not supported by GPUParticleSystem
  71211. * Gets or sets a boolean indicating that ramp gradients must be used
  71212. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  71213. */
  71214. get useRampGradients(): boolean;
  71215. set useRampGradients(value: boolean);
  71216. /**
  71217. * Not supported by GPUParticleSystem
  71218. * @param gradient defines the gradient to use (between 0 and 1)
  71219. * @param factor defines the life time factor to affect to the specified gradient
  71220. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71221. * @returns the current particle system
  71222. */
  71223. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71224. /**
  71225. * Not supported by GPUParticleSystem
  71226. * @param gradient defines the gradient to remove
  71227. * @returns the current particle system
  71228. */
  71229. removeLifeTimeGradient(gradient: number): IParticleSystem;
  71230. /**
  71231. * Instantiates a GPU particle system.
  71232. * 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.
  71233. * @param name The name of the particle system
  71234. * @param options The options used to create the system
  71235. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  71236. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  71237. * @param customEffect a custom effect used to change the way particles are rendered by default
  71238. */
  71239. constructor(name: string, options: Partial<{
  71240. capacity: number;
  71241. randomTextureSize: number;
  71242. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  71243. protected _reset(): void;
  71244. private _createUpdateVAO;
  71245. private _createRenderVAO;
  71246. private _initialize;
  71247. /** @hidden */
  71248. _recreateUpdateEffect(): void;
  71249. private _getEffect;
  71250. /**
  71251. * Fill the defines array according to the current settings of the particle system
  71252. * @param defines Array to be updated
  71253. * @param blendMode blend mode to take into account when updating the array
  71254. */
  71255. fillDefines(defines: Array<string>, blendMode?: number): void;
  71256. /**
  71257. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  71258. * @param uniforms Uniforms array to fill
  71259. * @param attributes Attributes array to fill
  71260. * @param samplers Samplers array to fill
  71261. */
  71262. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  71263. /** @hidden */
  71264. _recreateRenderEffect(): Effect;
  71265. /**
  71266. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  71267. * @param preWarm defines if we are in the pre-warmimg phase
  71268. */
  71269. animate(preWarm?: boolean): void;
  71270. private _createFactorGradientTexture;
  71271. private _createSizeGradientTexture;
  71272. private _createAngularSpeedGradientTexture;
  71273. private _createVelocityGradientTexture;
  71274. private _createLimitVelocityGradientTexture;
  71275. private _createDragGradientTexture;
  71276. private _createColorGradientTexture;
  71277. /**
  71278. * Renders the particle system in its current state
  71279. * @param preWarm defines if the system should only update the particles but not render them
  71280. * @returns the current number of particles
  71281. */
  71282. render(preWarm?: boolean): number;
  71283. /**
  71284. * Rebuilds the particle system
  71285. */
  71286. rebuild(): void;
  71287. private _releaseBuffers;
  71288. private _releaseVAOs;
  71289. /**
  71290. * Disposes the particle system and free the associated resources
  71291. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  71292. */
  71293. dispose(disposeTexture?: boolean): void;
  71294. /**
  71295. * Clones the particle system.
  71296. * @param name The name of the cloned object
  71297. * @param newEmitter The new emitter to use
  71298. * @returns the cloned particle system
  71299. */
  71300. clone(name: string, newEmitter: any): GPUParticleSystem;
  71301. /**
  71302. * Serializes the particle system to a JSON object
  71303. * @param serializeTexture defines if the texture must be serialized as well
  71304. * @returns the JSON object
  71305. */
  71306. serialize(serializeTexture?: boolean): any;
  71307. /**
  71308. * Parses a JSON object to create a GPU particle system.
  71309. * @param parsedParticleSystem The JSON object to parse
  71310. * @param sceneOrEngine The scene or the engine to create the particle system in
  71311. * @param rootUrl The root url to use to load external dependencies like texture
  71312. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  71313. * @returns the parsed GPU particle system
  71314. */
  71315. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  71316. }
  71317. }
  71318. declare module "babylonjs/Particles/particleSystemSet" {
  71319. import { Nullable } from "babylonjs/types";
  71320. import { Color3 } from "babylonjs/Maths/math.color";
  71321. import { TransformNode } from "babylonjs/Meshes/transformNode";
  71322. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71323. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71324. import { Scene, IDisposable } from "babylonjs/scene";
  71325. /**
  71326. * Represents a set of particle systems working together to create a specific effect
  71327. */
  71328. export class ParticleSystemSet implements IDisposable {
  71329. /**
  71330. * Gets or sets base Assets URL
  71331. */
  71332. static BaseAssetsUrl: string;
  71333. private _emitterCreationOptions;
  71334. private _emitterNode;
  71335. /**
  71336. * Gets the particle system list
  71337. */
  71338. systems: IParticleSystem[];
  71339. /**
  71340. * Gets the emitter node used with this set
  71341. */
  71342. get emitterNode(): Nullable<TransformNode>;
  71343. /**
  71344. * Creates a new emitter mesh as a sphere
  71345. * @param options defines the options used to create the sphere
  71346. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  71347. * @param scene defines the hosting scene
  71348. */
  71349. setEmitterAsSphere(options: {
  71350. diameter: number;
  71351. segments: number;
  71352. color: Color3;
  71353. }, renderingGroupId: number, scene: Scene): void;
  71354. /**
  71355. * Starts all particle systems of the set
  71356. * @param emitter defines an optional mesh to use as emitter for the particle systems
  71357. */
  71358. start(emitter?: AbstractMesh): void;
  71359. /**
  71360. * Release all associated resources
  71361. */
  71362. dispose(): void;
  71363. /**
  71364. * Serialize the set into a JSON compatible object
  71365. * @param serializeTexture defines if the texture must be serialized as well
  71366. * @returns a JSON compatible representation of the set
  71367. */
  71368. serialize(serializeTexture?: boolean): any;
  71369. /**
  71370. * Parse a new ParticleSystemSet from a serialized source
  71371. * @param data defines a JSON compatible representation of the set
  71372. * @param scene defines the hosting scene
  71373. * @param gpu defines if we want GPU particles or CPU particles
  71374. * @returns a new ParticleSystemSet
  71375. */
  71376. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  71377. }
  71378. }
  71379. declare module "babylonjs/Particles/particleHelper" {
  71380. import { Nullable } from "babylonjs/types";
  71381. import { Scene } from "babylonjs/scene";
  71382. import { Vector3 } from "babylonjs/Maths/math.vector";
  71383. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71384. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71385. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  71386. /**
  71387. * This class is made for on one-liner static method to help creating particle system set.
  71388. */
  71389. export class ParticleHelper {
  71390. /**
  71391. * Gets or sets base Assets URL
  71392. */
  71393. static BaseAssetsUrl: string;
  71394. /** Define the Url to load snippets */
  71395. static SnippetUrl: string;
  71396. /**
  71397. * Create a default particle system that you can tweak
  71398. * @param emitter defines the emitter to use
  71399. * @param capacity defines the system capacity (default is 500 particles)
  71400. * @param scene defines the hosting scene
  71401. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  71402. * @returns the new Particle system
  71403. */
  71404. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  71405. /**
  71406. * This is the main static method (one-liner) of this helper to create different particle systems
  71407. * @param type This string represents the type to the particle system to create
  71408. * @param scene The scene where the particle system should live
  71409. * @param gpu If the system will use gpu
  71410. * @returns the ParticleSystemSet created
  71411. */
  71412. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  71413. /**
  71414. * Static function used to export a particle system to a ParticleSystemSet variable.
  71415. * Please note that the emitter shape is not exported
  71416. * @param systems defines the particle systems to export
  71417. * @returns the created particle system set
  71418. */
  71419. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  71420. /**
  71421. * Creates a particle system from a snippet saved in a remote file
  71422. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  71423. * @param url defines the url to load from
  71424. * @param scene defines the hosting scene
  71425. * @param gpu If the system will use gpu
  71426. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71427. * @returns a promise that will resolve to the new particle system
  71428. */
  71429. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71430. /**
  71431. * Creates a particle system from a snippet saved by the particle system editor
  71432. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  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 CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71439. }
  71440. }
  71441. declare module "babylonjs/Particles/particleSystemComponent" {
  71442. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71443. import { Effect } from "babylonjs/Materials/effect";
  71444. import "babylonjs/Shaders/particles.vertex";
  71445. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  71446. module "babylonjs/Engines/engine" {
  71447. interface Engine {
  71448. /**
  71449. * Create an effect to use with particle systems.
  71450. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  71451. * the particle system for which you want to create a custom effect in the last parameter
  71452. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  71453. * @param uniformsNames defines a list of attribute names
  71454. * @param samplers defines an array of string used to represent textures
  71455. * @param defines defines the string containing the defines to use to compile the shaders
  71456. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  71457. * @param onCompiled defines a function to call when the effect creation is successful
  71458. * @param onError defines a function to call when the effect creation has failed
  71459. * @param particleSystem the particle system you want to create the effect for
  71460. * @returns the new Effect
  71461. */
  71462. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  71463. }
  71464. }
  71465. module "babylonjs/Meshes/mesh" {
  71466. interface Mesh {
  71467. /**
  71468. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  71469. * @returns an array of IParticleSystem
  71470. */
  71471. getEmittedParticleSystems(): IParticleSystem[];
  71472. /**
  71473. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  71474. * @returns an array of IParticleSystem
  71475. */
  71476. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  71477. }
  71478. }
  71479. }
  71480. declare module "babylonjs/Particles/pointsCloudSystem" {
  71481. import { Color4 } from "babylonjs/Maths/math";
  71482. import { Mesh } from "babylonjs/Meshes/mesh";
  71483. import { Scene, IDisposable } from "babylonjs/scene";
  71484. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  71485. /** Defines the 4 color options */
  71486. export enum PointColor {
  71487. /** color value */
  71488. Color = 2,
  71489. /** uv value */
  71490. UV = 1,
  71491. /** random value */
  71492. Random = 0,
  71493. /** stated value */
  71494. Stated = 3
  71495. }
  71496. /**
  71497. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  71498. * 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.
  71499. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  71500. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  71501. *
  71502. * Full documentation here : TO BE ENTERED
  71503. */
  71504. export class PointsCloudSystem implements IDisposable {
  71505. /**
  71506. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  71507. * Example : var p = SPS.particles[i];
  71508. */
  71509. particles: CloudPoint[];
  71510. /**
  71511. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  71512. */
  71513. nbParticles: number;
  71514. /**
  71515. * This a counter for your own usage. It's not set by any SPS functions.
  71516. */
  71517. counter: number;
  71518. /**
  71519. * The PCS name. This name is also given to the underlying mesh.
  71520. */
  71521. name: string;
  71522. /**
  71523. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  71524. */
  71525. mesh: Mesh;
  71526. /**
  71527. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  71528. * Please read :
  71529. */
  71530. vars: any;
  71531. /**
  71532. * @hidden
  71533. */
  71534. _size: number;
  71535. private _scene;
  71536. private _promises;
  71537. private _positions;
  71538. private _indices;
  71539. private _normals;
  71540. private _colors;
  71541. private _uvs;
  71542. private _indices32;
  71543. private _positions32;
  71544. private _colors32;
  71545. private _uvs32;
  71546. private _updatable;
  71547. private _isVisibilityBoxLocked;
  71548. private _alwaysVisible;
  71549. private _groups;
  71550. private _groupCounter;
  71551. private _computeParticleColor;
  71552. private _computeParticleTexture;
  71553. private _computeParticleRotation;
  71554. private _computeBoundingBox;
  71555. private _isReady;
  71556. /**
  71557. * Creates a PCS (Points Cloud System) object
  71558. * @param name (String) is the PCS name, this will be the underlying mesh name
  71559. * @param pointSize (number) is the size for each point
  71560. * @param scene (Scene) is the scene in which the PCS is added
  71561. * @param options defines the options of the PCS e.g.
  71562. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  71563. */
  71564. constructor(name: string, pointSize: number, scene: Scene, options?: {
  71565. updatable?: boolean;
  71566. });
  71567. /**
  71568. * Builds the PCS underlying mesh. Returns a standard Mesh.
  71569. * If no points were added to the PCS, the returned mesh is just a single point.
  71570. * @returns a promise for the created mesh
  71571. */
  71572. buildMeshAsync(): Promise<Mesh>;
  71573. /**
  71574. * @hidden
  71575. */
  71576. private _buildMesh;
  71577. private _addParticle;
  71578. private _randomUnitVector;
  71579. private _getColorIndicesForCoord;
  71580. private _setPointsColorOrUV;
  71581. private _colorFromTexture;
  71582. private _calculateDensity;
  71583. /**
  71584. * Adds points to the PCS in random positions within a unit sphere
  71585. * @param nb (positive integer) the number of particles to be created from this model
  71586. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  71587. * @returns the number of groups in the system
  71588. */
  71589. addPoints(nb: number, pointFunction?: any): number;
  71590. /**
  71591. * Adds points to the PCS from the surface of the model shape
  71592. * @param mesh is any Mesh object that will be used as a surface model for the points
  71593. * @param nb (positive integer) the number of particles to be created from this model
  71594. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71595. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71596. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71597. * @returns the number of groups in the system
  71598. */
  71599. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71600. /**
  71601. * Adds points to the PCS inside the model shape
  71602. * @param mesh is any Mesh object that will be used as a surface model for the points
  71603. * @param nb (positive integer) the number of particles to be created from this model
  71604. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71605. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71606. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71607. * @returns the number of groups in the system
  71608. */
  71609. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71610. /**
  71611. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  71612. * This method calls `updateParticle()` for each particle of the SPS.
  71613. * For an animated SPS, it is usually called within the render loop.
  71614. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  71615. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  71616. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  71617. * @returns the PCS.
  71618. */
  71619. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  71620. /**
  71621. * Disposes the PCS.
  71622. */
  71623. dispose(): void;
  71624. /**
  71625. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  71626. * doc :
  71627. * @returns the PCS.
  71628. */
  71629. refreshVisibleSize(): PointsCloudSystem;
  71630. /**
  71631. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  71632. * @param size the size (float) of the visibility box
  71633. * note : this doesn't lock the PCS mesh bounding box.
  71634. * doc :
  71635. */
  71636. setVisibilityBox(size: number): void;
  71637. /**
  71638. * Gets whether the PCS is always visible or not
  71639. * doc :
  71640. */
  71641. get isAlwaysVisible(): boolean;
  71642. /**
  71643. * Sets the PCS as always visible or not
  71644. * doc :
  71645. */
  71646. set isAlwaysVisible(val: boolean);
  71647. /**
  71648. * Tells to `setParticles()` to compute the particle rotations or not
  71649. * Default value : false. The PCS is faster when it's set to false
  71650. * Note : particle rotations are only applied to parent particles
  71651. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  71652. */
  71653. set computeParticleRotation(val: boolean);
  71654. /**
  71655. * Tells to `setParticles()` to compute the particle colors or not.
  71656. * Default value : true. The PCS is faster when it's set to false.
  71657. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71658. */
  71659. set computeParticleColor(val: boolean);
  71660. set computeParticleTexture(val: boolean);
  71661. /**
  71662. * Gets if `setParticles()` computes the particle colors or not.
  71663. * Default value : false. The PCS is faster when it's set to false.
  71664. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71665. */
  71666. get computeParticleColor(): boolean;
  71667. /**
  71668. * Gets if `setParticles()` computes the particle textures or not.
  71669. * Default value : false. The PCS is faster when it's set to false.
  71670. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  71671. */
  71672. get computeParticleTexture(): boolean;
  71673. /**
  71674. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  71675. */
  71676. set computeBoundingBox(val: boolean);
  71677. /**
  71678. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  71679. */
  71680. get computeBoundingBox(): boolean;
  71681. /**
  71682. * This function does nothing. It may be overwritten to set all the particle first values.
  71683. * The PCS doesn't call this function, you may have to call it by your own.
  71684. * doc :
  71685. */
  71686. initParticles(): void;
  71687. /**
  71688. * This function does nothing. It may be overwritten to recycle a particle
  71689. * The PCS doesn't call this function, you can to call it
  71690. * doc :
  71691. * @param particle The particle to recycle
  71692. * @returns the recycled particle
  71693. */
  71694. recycleParticle(particle: CloudPoint): CloudPoint;
  71695. /**
  71696. * Updates a particle : this function should be overwritten by the user.
  71697. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  71698. * doc :
  71699. * @example : just set a particle position or velocity and recycle conditions
  71700. * @param particle The particle to update
  71701. * @returns the updated particle
  71702. */
  71703. updateParticle(particle: CloudPoint): CloudPoint;
  71704. /**
  71705. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  71706. * This does nothing and may be overwritten by the user.
  71707. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71708. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71709. * @param update the boolean update value actually passed to setParticles()
  71710. */
  71711. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71712. /**
  71713. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  71714. * This 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. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71721. }
  71722. }
  71723. declare module "babylonjs/Particles/cloudPoint" {
  71724. import { Nullable } from "babylonjs/types";
  71725. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  71726. import { Mesh } from "babylonjs/Meshes/mesh";
  71727. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  71728. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  71729. /**
  71730. * Represents one particle of a points cloud system.
  71731. */
  71732. export class CloudPoint {
  71733. /**
  71734. * particle global index
  71735. */
  71736. idx: number;
  71737. /**
  71738. * The color of the particle
  71739. */
  71740. color: Nullable<Color4>;
  71741. /**
  71742. * The world space position of the particle.
  71743. */
  71744. position: Vector3;
  71745. /**
  71746. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  71747. */
  71748. rotation: Vector3;
  71749. /**
  71750. * The world space rotation quaternion of the particle.
  71751. */
  71752. rotationQuaternion: Nullable<Quaternion>;
  71753. /**
  71754. * The uv of the particle.
  71755. */
  71756. uv: Nullable<Vector2>;
  71757. /**
  71758. * The current speed of the particle.
  71759. */
  71760. velocity: Vector3;
  71761. /**
  71762. * The pivot point in the particle local space.
  71763. */
  71764. pivot: Vector3;
  71765. /**
  71766. * Must the particle be translated from its pivot point in its local space ?
  71767. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  71768. * Default : false
  71769. */
  71770. translateFromPivot: boolean;
  71771. /**
  71772. * Index of this particle in the global "positions" array (Internal use)
  71773. * @hidden
  71774. */
  71775. _pos: number;
  71776. /**
  71777. * @hidden Index of this particle in the global "indices" array (Internal use)
  71778. */
  71779. _ind: number;
  71780. /**
  71781. * Group this particle belongs to
  71782. */
  71783. _group: PointsGroup;
  71784. /**
  71785. * Group id of this particle
  71786. */
  71787. groupId: number;
  71788. /**
  71789. * Index of the particle in its group id (Internal use)
  71790. */
  71791. idxInGroup: number;
  71792. /**
  71793. * @hidden Particle BoundingInfo object (Internal use)
  71794. */
  71795. _boundingInfo: BoundingInfo;
  71796. /**
  71797. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  71798. */
  71799. _pcs: PointsCloudSystem;
  71800. /**
  71801. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  71802. */
  71803. _stillInvisible: boolean;
  71804. /**
  71805. * @hidden Last computed particle rotation matrix
  71806. */
  71807. _rotationMatrix: number[];
  71808. /**
  71809. * Parent particle Id, if any.
  71810. * Default null.
  71811. */
  71812. parentId: Nullable<number>;
  71813. /**
  71814. * @hidden Internal global position in the PCS.
  71815. */
  71816. _globalPosition: Vector3;
  71817. /**
  71818. * Creates a Point Cloud object.
  71819. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  71820. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  71821. * @param group (PointsGroup) is the group the particle belongs to
  71822. * @param groupId (integer) is the group identifier in the PCS.
  71823. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  71824. * @param pcs defines the PCS it is associated to
  71825. */
  71826. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  71827. /**
  71828. * get point size
  71829. */
  71830. get size(): Vector3;
  71831. /**
  71832. * Set point size
  71833. */
  71834. set size(scale: Vector3);
  71835. /**
  71836. * Legacy support, changed quaternion to rotationQuaternion
  71837. */
  71838. get quaternion(): Nullable<Quaternion>;
  71839. /**
  71840. * Legacy support, changed quaternion to rotationQuaternion
  71841. */
  71842. set quaternion(q: Nullable<Quaternion>);
  71843. /**
  71844. * Returns a boolean. True if the particle intersects a mesh, else false
  71845. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  71846. * @param target is the object (point or mesh) what the intersection is computed against
  71847. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  71848. * @returns true if it intersects
  71849. */
  71850. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  71851. /**
  71852. * get the rotation matrix of the particle
  71853. * @hidden
  71854. */
  71855. getRotationMatrix(m: Matrix): void;
  71856. }
  71857. /**
  71858. * Represents a group of points in a points cloud system
  71859. * * PCS internal tool, don't use it manually.
  71860. */
  71861. export class PointsGroup {
  71862. /**
  71863. * The group id
  71864. * @hidden
  71865. */
  71866. groupID: number;
  71867. /**
  71868. * image data for group (internal use)
  71869. * @hidden
  71870. */
  71871. _groupImageData: Nullable<ArrayBufferView>;
  71872. /**
  71873. * Image Width (internal use)
  71874. * @hidden
  71875. */
  71876. _groupImgWidth: number;
  71877. /**
  71878. * Image Height (internal use)
  71879. * @hidden
  71880. */
  71881. _groupImgHeight: number;
  71882. /**
  71883. * Custom position function (internal use)
  71884. * @hidden
  71885. */
  71886. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  71887. /**
  71888. * density per facet for surface points
  71889. * @hidden
  71890. */
  71891. _groupDensity: number[];
  71892. /**
  71893. * Only when points are colored by texture carries pointer to texture list array
  71894. * @hidden
  71895. */
  71896. _textureNb: number;
  71897. /**
  71898. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  71899. * PCS internal tool, don't use it manually.
  71900. * @hidden
  71901. */
  71902. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  71903. }
  71904. }
  71905. declare module "babylonjs/Particles/index" {
  71906. export * from "babylonjs/Particles/baseParticleSystem";
  71907. export * from "babylonjs/Particles/EmitterTypes/index";
  71908. export * from "babylonjs/Particles/gpuParticleSystem";
  71909. export * from "babylonjs/Particles/IParticleSystem";
  71910. export * from "babylonjs/Particles/particle";
  71911. export * from "babylonjs/Particles/particleHelper";
  71912. export * from "babylonjs/Particles/particleSystem";
  71913. import "babylonjs/Particles/particleSystemComponent";
  71914. export * from "babylonjs/Particles/particleSystemComponent";
  71915. export * from "babylonjs/Particles/particleSystemSet";
  71916. export * from "babylonjs/Particles/solidParticle";
  71917. export * from "babylonjs/Particles/solidParticleSystem";
  71918. export * from "babylonjs/Particles/cloudPoint";
  71919. export * from "babylonjs/Particles/pointsCloudSystem";
  71920. export * from "babylonjs/Particles/subEmitter";
  71921. }
  71922. declare module "babylonjs/Physics/physicsEngineComponent" {
  71923. import { Nullable } from "babylonjs/types";
  71924. import { Observable, Observer } from "babylonjs/Misc/observable";
  71925. import { Vector3 } from "babylonjs/Maths/math.vector";
  71926. import { Mesh } from "babylonjs/Meshes/mesh";
  71927. import { ISceneComponent } from "babylonjs/sceneComponent";
  71928. import { Scene } from "babylonjs/scene";
  71929. import { Node } from "babylonjs/node";
  71930. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  71931. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  71932. module "babylonjs/scene" {
  71933. interface Scene {
  71934. /** @hidden (Backing field) */
  71935. _physicsEngine: Nullable<IPhysicsEngine>;
  71936. /** @hidden */
  71937. _physicsTimeAccumulator: number;
  71938. /**
  71939. * Gets the current physics engine
  71940. * @returns a IPhysicsEngine or null if none attached
  71941. */
  71942. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  71943. /**
  71944. * Enables physics to the current scene
  71945. * @param gravity defines the scene's gravity for the physics engine
  71946. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  71947. * @return a boolean indicating if the physics engine was initialized
  71948. */
  71949. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  71950. /**
  71951. * Disables and disposes the physics engine associated with the scene
  71952. */
  71953. disablePhysicsEngine(): void;
  71954. /**
  71955. * Gets a boolean indicating if there is an active physics engine
  71956. * @returns a boolean indicating if there is an active physics engine
  71957. */
  71958. isPhysicsEnabled(): boolean;
  71959. /**
  71960. * Deletes a physics compound impostor
  71961. * @param compound defines the compound to delete
  71962. */
  71963. deleteCompoundImpostor(compound: any): void;
  71964. /**
  71965. * An event triggered when physic simulation is about to be run
  71966. */
  71967. onBeforePhysicsObservable: Observable<Scene>;
  71968. /**
  71969. * An event triggered when physic simulation has been done
  71970. */
  71971. onAfterPhysicsObservable: Observable<Scene>;
  71972. }
  71973. }
  71974. module "babylonjs/Meshes/abstractMesh" {
  71975. interface AbstractMesh {
  71976. /** @hidden */
  71977. _physicsImpostor: Nullable<PhysicsImpostor>;
  71978. /**
  71979. * Gets or sets impostor used for physic simulation
  71980. * @see https://doc.babylonjs.com/features/physics_engine
  71981. */
  71982. physicsImpostor: Nullable<PhysicsImpostor>;
  71983. /**
  71984. * Gets the current physics impostor
  71985. * @see https://doc.babylonjs.com/features/physics_engine
  71986. * @returns a physics impostor or null
  71987. */
  71988. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  71989. /** Apply a physic impulse to the mesh
  71990. * @param force defines the force to apply
  71991. * @param contactPoint defines where to apply the force
  71992. * @returns the current mesh
  71993. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  71994. */
  71995. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  71996. /**
  71997. * Creates a physic joint between two meshes
  71998. * @param otherMesh defines the other mesh to use
  71999. * @param pivot1 defines the pivot to use on this mesh
  72000. * @param pivot2 defines the pivot to use on the other mesh
  72001. * @param options defines additional options (can be plugin dependent)
  72002. * @returns the current mesh
  72003. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  72004. */
  72005. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  72006. /** @hidden */
  72007. _disposePhysicsObserver: Nullable<Observer<Node>>;
  72008. }
  72009. }
  72010. /**
  72011. * Defines the physics engine scene component responsible to manage a physics engine
  72012. */
  72013. export class PhysicsEngineSceneComponent implements ISceneComponent {
  72014. /**
  72015. * The component name helpful to identify the component in the list of scene components.
  72016. */
  72017. readonly name: string;
  72018. /**
  72019. * The scene the component belongs to.
  72020. */
  72021. scene: Scene;
  72022. /**
  72023. * Creates a new instance of the component for the given scene
  72024. * @param scene Defines the scene to register the component in
  72025. */
  72026. constructor(scene: Scene);
  72027. /**
  72028. * Registers the component in a given scene
  72029. */
  72030. register(): void;
  72031. /**
  72032. * Rebuilds the elements related to this component in case of
  72033. * context lost for instance.
  72034. */
  72035. rebuild(): void;
  72036. /**
  72037. * Disposes the component and the associated ressources
  72038. */
  72039. dispose(): void;
  72040. }
  72041. }
  72042. declare module "babylonjs/Physics/physicsHelper" {
  72043. import { Nullable } from "babylonjs/types";
  72044. import { Vector3 } from "babylonjs/Maths/math.vector";
  72045. import { Mesh } from "babylonjs/Meshes/mesh";
  72046. import { Scene } from "babylonjs/scene";
  72047. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72048. /**
  72049. * A helper for physics simulations
  72050. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72051. */
  72052. export class PhysicsHelper {
  72053. private _scene;
  72054. private _physicsEngine;
  72055. /**
  72056. * Initializes the Physics helper
  72057. * @param scene Babylon.js scene
  72058. */
  72059. constructor(scene: Scene);
  72060. /**
  72061. * Applies a radial explosion impulse
  72062. * @param origin the origin of the explosion
  72063. * @param radiusOrEventOptions the radius or the options of radial explosion
  72064. * @param strength the explosion strength
  72065. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72066. * @returns A physics radial explosion event, or null
  72067. */
  72068. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72069. /**
  72070. * Applies a radial explosion force
  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. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72078. /**
  72079. * Creates a gravitational field
  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 gravitational field event, or null
  72085. */
  72086. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  72087. /**
  72088. * Creates a physics updraft event
  72089. * @param origin the origin of the updraft
  72090. * @param radiusOrEventOptions the radius or the options of the updraft
  72091. * @param strength the strength of the updraft
  72092. * @param height the height of the updraft
  72093. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  72094. * @returns A physics updraft event, or null
  72095. */
  72096. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  72097. /**
  72098. * Creates a physics vortex event
  72099. * @param origin the of the vortex
  72100. * @param radiusOrEventOptions the radius or the options of the vortex
  72101. * @param strength the strength of the vortex
  72102. * @param height the height of the vortex
  72103. * @returns a Physics vortex event, or null
  72104. * A physics vortex event or null
  72105. */
  72106. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  72107. }
  72108. /**
  72109. * Represents a physics radial explosion event
  72110. */
  72111. class PhysicsRadialExplosionEvent {
  72112. private _scene;
  72113. private _options;
  72114. private _sphere;
  72115. private _dataFetched;
  72116. /**
  72117. * Initializes a radial explosioin event
  72118. * @param _scene BabylonJS scene
  72119. * @param _options The options for the vortex event
  72120. */
  72121. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  72122. /**
  72123. * Returns the data related to the radial explosion event (sphere).
  72124. * @returns The radial explosion event data
  72125. */
  72126. getData(): PhysicsRadialExplosionEventData;
  72127. /**
  72128. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  72129. * @param impostor A physics imposter
  72130. * @param origin the origin of the explosion
  72131. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  72132. */
  72133. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  72134. /**
  72135. * Triggers affecterd impostors callbacks
  72136. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  72137. */
  72138. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  72139. /**
  72140. * Disposes the sphere.
  72141. * @param force Specifies if the sphere should be disposed by force
  72142. */
  72143. dispose(force?: boolean): void;
  72144. /*** Helpers ***/
  72145. private _prepareSphere;
  72146. private _intersectsWithSphere;
  72147. }
  72148. /**
  72149. * Represents a gravitational field event
  72150. */
  72151. class PhysicsGravitationalFieldEvent {
  72152. private _physicsHelper;
  72153. private _scene;
  72154. private _origin;
  72155. private _options;
  72156. private _tickCallback;
  72157. private _sphere;
  72158. private _dataFetched;
  72159. /**
  72160. * Initializes the physics gravitational field event
  72161. * @param _physicsHelper A physics helper
  72162. * @param _scene BabylonJS scene
  72163. * @param _origin The origin position of the gravitational field event
  72164. * @param _options The options for the vortex event
  72165. */
  72166. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  72167. /**
  72168. * Returns the data related to the gravitational field event (sphere).
  72169. * @returns A gravitational field event
  72170. */
  72171. getData(): PhysicsGravitationalFieldEventData;
  72172. /**
  72173. * Enables the gravitational field.
  72174. */
  72175. enable(): void;
  72176. /**
  72177. * Disables the gravitational field.
  72178. */
  72179. disable(): void;
  72180. /**
  72181. * Disposes the sphere.
  72182. * @param force The force to dispose from the gravitational field event
  72183. */
  72184. dispose(force?: boolean): void;
  72185. private _tick;
  72186. }
  72187. /**
  72188. * Represents a physics updraft event
  72189. */
  72190. class PhysicsUpdraftEvent {
  72191. private _scene;
  72192. private _origin;
  72193. private _options;
  72194. private _physicsEngine;
  72195. private _originTop;
  72196. private _originDirection;
  72197. private _tickCallback;
  72198. private _cylinder;
  72199. private _cylinderPosition;
  72200. private _dataFetched;
  72201. /**
  72202. * Initializes the physics updraft event
  72203. * @param _scene BabylonJS scene
  72204. * @param _origin The origin position of the updraft
  72205. * @param _options The options for the updraft event
  72206. */
  72207. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  72208. /**
  72209. * Returns the data related to the updraft event (cylinder).
  72210. * @returns A physics updraft event
  72211. */
  72212. getData(): PhysicsUpdraftEventData;
  72213. /**
  72214. * Enables the updraft.
  72215. */
  72216. enable(): void;
  72217. /**
  72218. * Disables the updraft.
  72219. */
  72220. disable(): void;
  72221. /**
  72222. * Disposes the cylinder.
  72223. * @param force Specifies if the updraft should be disposed by force
  72224. */
  72225. dispose(force?: boolean): void;
  72226. private getImpostorHitData;
  72227. private _tick;
  72228. /*** Helpers ***/
  72229. private _prepareCylinder;
  72230. private _intersectsWithCylinder;
  72231. }
  72232. /**
  72233. * Represents a physics vortex event
  72234. */
  72235. class PhysicsVortexEvent {
  72236. private _scene;
  72237. private _origin;
  72238. private _options;
  72239. private _physicsEngine;
  72240. private _originTop;
  72241. private _tickCallback;
  72242. private _cylinder;
  72243. private _cylinderPosition;
  72244. private _dataFetched;
  72245. /**
  72246. * Initializes the physics vortex event
  72247. * @param _scene The BabylonJS scene
  72248. * @param _origin The origin position of the vortex
  72249. * @param _options The options for the vortex event
  72250. */
  72251. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  72252. /**
  72253. * Returns the data related to the vortex event (cylinder).
  72254. * @returns The physics vortex event data
  72255. */
  72256. getData(): PhysicsVortexEventData;
  72257. /**
  72258. * Enables the vortex.
  72259. */
  72260. enable(): void;
  72261. /**
  72262. * Disables the cortex.
  72263. */
  72264. disable(): void;
  72265. /**
  72266. * Disposes the sphere.
  72267. * @param force
  72268. */
  72269. dispose(force?: boolean): void;
  72270. private getImpostorHitData;
  72271. private _tick;
  72272. /*** Helpers ***/
  72273. private _prepareCylinder;
  72274. private _intersectsWithCylinder;
  72275. }
  72276. /**
  72277. * Options fot the radial explosion event
  72278. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72279. */
  72280. export class PhysicsRadialExplosionEventOptions {
  72281. /**
  72282. * The radius of the sphere for the radial explosion.
  72283. */
  72284. radius: number;
  72285. /**
  72286. * The strenth of the explosion.
  72287. */
  72288. strength: number;
  72289. /**
  72290. * The strenght of the force in correspondence to the distance of the affected object
  72291. */
  72292. falloff: PhysicsRadialImpulseFalloff;
  72293. /**
  72294. * Sphere options for the radial explosion.
  72295. */
  72296. sphere: {
  72297. segments: number;
  72298. diameter: number;
  72299. };
  72300. /**
  72301. * Sphere options for the radial explosion.
  72302. */
  72303. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  72304. }
  72305. /**
  72306. * Options fot the updraft event
  72307. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72308. */
  72309. export class PhysicsUpdraftEventOptions {
  72310. /**
  72311. * The radius of the cylinder for the vortex
  72312. */
  72313. radius: number;
  72314. /**
  72315. * The strenth of the updraft.
  72316. */
  72317. strength: number;
  72318. /**
  72319. * The height of the cylinder for the updraft.
  72320. */
  72321. height: number;
  72322. /**
  72323. * The mode for the the updraft.
  72324. */
  72325. updraftMode: PhysicsUpdraftMode;
  72326. }
  72327. /**
  72328. * Options fot the vortex event
  72329. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72330. */
  72331. export class PhysicsVortexEventOptions {
  72332. /**
  72333. * The radius of the cylinder for the vortex
  72334. */
  72335. radius: number;
  72336. /**
  72337. * The strenth of the vortex.
  72338. */
  72339. strength: number;
  72340. /**
  72341. * The height of the cylinder for the vortex.
  72342. */
  72343. height: number;
  72344. /**
  72345. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  72346. */
  72347. centripetalForceThreshold: number;
  72348. /**
  72349. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  72350. */
  72351. centripetalForceMultiplier: number;
  72352. /**
  72353. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  72354. */
  72355. centrifugalForceMultiplier: number;
  72356. /**
  72357. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  72358. */
  72359. updraftForceMultiplier: number;
  72360. }
  72361. /**
  72362. * The strenght of the force in correspondence to the distance of the affected object
  72363. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72364. */
  72365. export enum PhysicsRadialImpulseFalloff {
  72366. /** Defines that impulse is constant in strength across it's whole radius */
  72367. Constant = 0,
  72368. /** Defines that impulse gets weaker if it's further from the origin */
  72369. Linear = 1
  72370. }
  72371. /**
  72372. * The strength of the force in correspondence to the distance of the affected object
  72373. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72374. */
  72375. export enum PhysicsUpdraftMode {
  72376. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  72377. Center = 0,
  72378. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  72379. Perpendicular = 1
  72380. }
  72381. /**
  72382. * Interface for a physics hit data
  72383. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72384. */
  72385. export interface PhysicsHitData {
  72386. /**
  72387. * The force applied at the contact point
  72388. */
  72389. force: Vector3;
  72390. /**
  72391. * The contact point
  72392. */
  72393. contactPoint: Vector3;
  72394. /**
  72395. * The distance from the origin to the contact point
  72396. */
  72397. distanceFromOrigin: number;
  72398. }
  72399. /**
  72400. * Interface for radial explosion event data
  72401. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72402. */
  72403. export interface PhysicsRadialExplosionEventData {
  72404. /**
  72405. * A sphere used for the radial explosion event
  72406. */
  72407. sphere: Mesh;
  72408. }
  72409. /**
  72410. * Interface for gravitational field event data
  72411. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72412. */
  72413. export interface PhysicsGravitationalFieldEventData {
  72414. /**
  72415. * A sphere mesh used for the gravitational field event
  72416. */
  72417. sphere: Mesh;
  72418. }
  72419. /**
  72420. * Interface for updraft event data
  72421. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72422. */
  72423. export interface PhysicsUpdraftEventData {
  72424. /**
  72425. * A cylinder used for the updraft event
  72426. */
  72427. cylinder: Mesh;
  72428. }
  72429. /**
  72430. * Interface for vortex event data
  72431. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72432. */
  72433. export interface PhysicsVortexEventData {
  72434. /**
  72435. * A cylinder used for the vortex event
  72436. */
  72437. cylinder: Mesh;
  72438. }
  72439. /**
  72440. * Interface for an affected physics impostor
  72441. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72442. */
  72443. export interface PhysicsAffectedImpostorWithData {
  72444. /**
  72445. * The impostor affected by the effect
  72446. */
  72447. impostor: PhysicsImpostor;
  72448. /**
  72449. * The data about the hit/horce from the explosion
  72450. */
  72451. hitData: PhysicsHitData;
  72452. }
  72453. }
  72454. declare module "babylonjs/Physics/Plugins/index" {
  72455. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  72456. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  72457. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  72458. }
  72459. declare module "babylonjs/Physics/index" {
  72460. export * from "babylonjs/Physics/IPhysicsEngine";
  72461. export * from "babylonjs/Physics/physicsEngine";
  72462. export * from "babylonjs/Physics/physicsEngineComponent";
  72463. export * from "babylonjs/Physics/physicsHelper";
  72464. export * from "babylonjs/Physics/physicsImpostor";
  72465. export * from "babylonjs/Physics/physicsJoint";
  72466. export * from "babylonjs/Physics/Plugins/index";
  72467. }
  72468. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  72469. /** @hidden */
  72470. export var blackAndWhitePixelShader: {
  72471. name: string;
  72472. shader: string;
  72473. };
  72474. }
  72475. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  72476. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72477. import { Camera } from "babylonjs/Cameras/camera";
  72478. import { Engine } from "babylonjs/Engines/engine";
  72479. import "babylonjs/Shaders/blackAndWhite.fragment";
  72480. import { Nullable } from "babylonjs/types";
  72481. import { Scene } from "babylonjs/scene";
  72482. /**
  72483. * Post process used to render in black and white
  72484. */
  72485. export class BlackAndWhitePostProcess extends PostProcess {
  72486. /**
  72487. * Linear about to convert he result to black and white (default: 1)
  72488. */
  72489. degree: number;
  72490. /**
  72491. * Gets a string identifying the name of the class
  72492. * @returns "BlackAndWhitePostProcess" string
  72493. */
  72494. getClassName(): string;
  72495. /**
  72496. * Creates a black and white post process
  72497. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  72498. * @param name The name of the effect.
  72499. * @param options The required width/height ratio to downsize to before computing the render pass.
  72500. * @param camera The camera to apply the render pass to.
  72501. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72502. * @param engine The engine which the post process will be applied. (default: current engine)
  72503. * @param reusable If the post process can be reused on the same frame. (default: false)
  72504. */
  72505. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72506. /** @hidden */
  72507. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  72508. }
  72509. }
  72510. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  72511. import { Nullable } from "babylonjs/types";
  72512. import { Camera } from "babylonjs/Cameras/camera";
  72513. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72514. import { Engine } from "babylonjs/Engines/engine";
  72515. /**
  72516. * This represents a set of one or more post processes in Babylon.
  72517. * A post process can be used to apply a shader to a texture after it is rendered.
  72518. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72519. */
  72520. export class PostProcessRenderEffect {
  72521. private _postProcesses;
  72522. private _getPostProcesses;
  72523. private _singleInstance;
  72524. private _cameras;
  72525. private _indicesForCamera;
  72526. /**
  72527. * Name of the effect
  72528. * @hidden
  72529. */
  72530. _name: string;
  72531. /**
  72532. * Instantiates a post process render effect.
  72533. * A post process can be used to apply a shader to a texture after it is rendered.
  72534. * @param engine The engine the effect is tied to
  72535. * @param name The name of the effect
  72536. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  72537. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  72538. */
  72539. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  72540. /**
  72541. * Checks if all the post processes in the effect are supported.
  72542. */
  72543. get isSupported(): boolean;
  72544. /**
  72545. * Updates the current state of the effect
  72546. * @hidden
  72547. */
  72548. _update(): void;
  72549. /**
  72550. * Attaches the effect on cameras
  72551. * @param cameras The camera to attach to.
  72552. * @hidden
  72553. */
  72554. _attachCameras(cameras: Camera): void;
  72555. /**
  72556. * Attaches the effect on cameras
  72557. * @param cameras The camera to attach to.
  72558. * @hidden
  72559. */
  72560. _attachCameras(cameras: Camera[]): void;
  72561. /**
  72562. * Detaches the effect on cameras
  72563. * @param cameras The camera to detatch from.
  72564. * @hidden
  72565. */
  72566. _detachCameras(cameras: Camera): void;
  72567. /**
  72568. * Detatches the effect on cameras
  72569. * @param cameras The camera to detatch from.
  72570. * @hidden
  72571. */
  72572. _detachCameras(cameras: Camera[]): void;
  72573. /**
  72574. * Enables the effect on given cameras
  72575. * @param cameras The camera to enable.
  72576. * @hidden
  72577. */
  72578. _enable(cameras: Camera): void;
  72579. /**
  72580. * Enables the effect on given cameras
  72581. * @param cameras The camera to enable.
  72582. * @hidden
  72583. */
  72584. _enable(cameras: Nullable<Camera[]>): void;
  72585. /**
  72586. * Disables the effect on the given cameras
  72587. * @param cameras The camera to disable.
  72588. * @hidden
  72589. */
  72590. _disable(cameras: Camera): void;
  72591. /**
  72592. * Disables the effect on the given cameras
  72593. * @param cameras The camera to disable.
  72594. * @hidden
  72595. */
  72596. _disable(cameras: Nullable<Camera[]>): void;
  72597. /**
  72598. * Gets a list of the post processes contained in the effect.
  72599. * @param camera The camera to get the post processes on.
  72600. * @returns The list of the post processes in the effect.
  72601. */
  72602. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  72603. }
  72604. }
  72605. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  72606. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72607. /** @hidden */
  72608. export var extractHighlightsPixelShader: {
  72609. name: string;
  72610. shader: string;
  72611. };
  72612. }
  72613. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  72614. import { Nullable } from "babylonjs/types";
  72615. import { Camera } from "babylonjs/Cameras/camera";
  72616. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72617. import { Engine } from "babylonjs/Engines/engine";
  72618. import "babylonjs/Shaders/extractHighlights.fragment";
  72619. /**
  72620. * 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.
  72621. */
  72622. export class ExtractHighlightsPostProcess extends PostProcess {
  72623. /**
  72624. * The luminance threshold, pixels below this value will be set to black.
  72625. */
  72626. threshold: number;
  72627. /** @hidden */
  72628. _exposure: number;
  72629. /**
  72630. * Post process which has the input texture to be used when performing highlight extraction
  72631. * @hidden
  72632. */
  72633. _inputPostProcess: Nullable<PostProcess>;
  72634. /**
  72635. * Gets a string identifying the name of the class
  72636. * @returns "ExtractHighlightsPostProcess" string
  72637. */
  72638. getClassName(): string;
  72639. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72640. }
  72641. }
  72642. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  72643. /** @hidden */
  72644. export var bloomMergePixelShader: {
  72645. name: string;
  72646. shader: string;
  72647. };
  72648. }
  72649. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  72650. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72651. import { Nullable } from "babylonjs/types";
  72652. import { Engine } from "babylonjs/Engines/engine";
  72653. import { Camera } from "babylonjs/Cameras/camera";
  72654. import "babylonjs/Shaders/bloomMerge.fragment";
  72655. /**
  72656. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72657. */
  72658. export class BloomMergePostProcess extends PostProcess {
  72659. /** Weight of the bloom to be added to the original input. */
  72660. weight: number;
  72661. /**
  72662. * Gets a string identifying the name of the class
  72663. * @returns "BloomMergePostProcess" string
  72664. */
  72665. getClassName(): string;
  72666. /**
  72667. * Creates a new instance of @see BloomMergePostProcess
  72668. * @param name The name of the effect.
  72669. * @param originalFromInput Post process which's input will be used for the merge.
  72670. * @param blurred Blurred highlights post process which's output will be used.
  72671. * @param weight Weight of the bloom to be added to the original input.
  72672. * @param options The required width/height ratio to downsize to before computing the render pass.
  72673. * @param camera The camera to apply the render pass to.
  72674. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72675. * @param engine The engine which the post process will be applied. (default: current engine)
  72676. * @param reusable If the post process can be reused on the same frame. (default: false)
  72677. * @param textureType Type of textures used when performing the post process. (default: 0)
  72678. * @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)
  72679. */
  72680. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  72681. /** Weight of the bloom to be added to the original input. */
  72682. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72683. }
  72684. }
  72685. declare module "babylonjs/PostProcesses/bloomEffect" {
  72686. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72687. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72688. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  72689. import { Camera } from "babylonjs/Cameras/camera";
  72690. import { Scene } from "babylonjs/scene";
  72691. /**
  72692. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  72693. */
  72694. export class BloomEffect extends PostProcessRenderEffect {
  72695. private bloomScale;
  72696. /**
  72697. * @hidden Internal
  72698. */
  72699. _effects: Array<PostProcess>;
  72700. /**
  72701. * @hidden Internal
  72702. */
  72703. _downscale: ExtractHighlightsPostProcess;
  72704. private _blurX;
  72705. private _blurY;
  72706. private _merge;
  72707. /**
  72708. * The luminance threshold to find bright areas of the image to bloom.
  72709. */
  72710. get threshold(): number;
  72711. set threshold(value: number);
  72712. /**
  72713. * The strength of the bloom.
  72714. */
  72715. get weight(): number;
  72716. set weight(value: number);
  72717. /**
  72718. * Specifies the size of the bloom blur kernel, relative to the final output size
  72719. */
  72720. get kernel(): number;
  72721. set kernel(value: number);
  72722. /**
  72723. * Creates a new instance of @see BloomEffect
  72724. * @param scene The scene the effect belongs to.
  72725. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  72726. * @param bloomKernel The size of the kernel to be used when applying the blur.
  72727. * @param bloomWeight The the strength of bloom.
  72728. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72729. * @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)
  72730. */
  72731. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  72732. /**
  72733. * Disposes each of the internal effects for a given camera.
  72734. * @param camera The camera to dispose the effect on.
  72735. */
  72736. disposeEffects(camera: Camera): void;
  72737. /**
  72738. * @hidden Internal
  72739. */
  72740. _updateEffects(): void;
  72741. /**
  72742. * Internal
  72743. * @returns if all the contained post processes are ready.
  72744. * @hidden
  72745. */
  72746. _isReady(): boolean;
  72747. }
  72748. }
  72749. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  72750. /** @hidden */
  72751. export var chromaticAberrationPixelShader: {
  72752. name: string;
  72753. shader: string;
  72754. };
  72755. }
  72756. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  72757. import { Vector2 } from "babylonjs/Maths/math.vector";
  72758. import { Nullable } from "babylonjs/types";
  72759. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72760. import { Camera } from "babylonjs/Cameras/camera";
  72761. import { Engine } from "babylonjs/Engines/engine";
  72762. import "babylonjs/Shaders/chromaticAberration.fragment";
  72763. import { Scene } from "babylonjs/scene";
  72764. /**
  72765. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  72766. */
  72767. export class ChromaticAberrationPostProcess extends PostProcess {
  72768. /**
  72769. * The amount of seperation of rgb channels (default: 30)
  72770. */
  72771. aberrationAmount: number;
  72772. /**
  72773. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  72774. */
  72775. radialIntensity: number;
  72776. /**
  72777. * 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))
  72778. */
  72779. direction: Vector2;
  72780. /**
  72781. * 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))
  72782. */
  72783. centerPosition: Vector2;
  72784. /** The width of the screen to apply the effect on */
  72785. screenWidth: number;
  72786. /** The height of the screen to apply the effect on */
  72787. screenHeight: number;
  72788. /**
  72789. * Gets a string identifying the name of the class
  72790. * @returns "ChromaticAberrationPostProcess" string
  72791. */
  72792. getClassName(): string;
  72793. /**
  72794. * Creates a new instance ChromaticAberrationPostProcess
  72795. * @param name The name of the effect.
  72796. * @param screenWidth The width of the screen to apply the effect on.
  72797. * @param screenHeight The height of the screen to apply the effect on.
  72798. * @param options The required width/height ratio to downsize to before computing the render pass.
  72799. * @param camera The camera to apply the render pass to.
  72800. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72801. * @param engine The engine which the post process will be applied. (default: current engine)
  72802. * @param reusable If the post process can be reused on the same frame. (default: false)
  72803. * @param textureType Type of textures used when performing the post process. (default: 0)
  72804. * @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)
  72805. */
  72806. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72807. /** @hidden */
  72808. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  72809. }
  72810. }
  72811. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  72812. /** @hidden */
  72813. export var circleOfConfusionPixelShader: {
  72814. name: string;
  72815. shader: string;
  72816. };
  72817. }
  72818. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  72819. import { Nullable } from "babylonjs/types";
  72820. import { Engine } from "babylonjs/Engines/engine";
  72821. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72822. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  72823. import { Camera } from "babylonjs/Cameras/camera";
  72824. import "babylonjs/Shaders/circleOfConfusion.fragment";
  72825. /**
  72826. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  72827. */
  72828. export class CircleOfConfusionPostProcess extends PostProcess {
  72829. /**
  72830. * 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.
  72831. */
  72832. lensSize: number;
  72833. /**
  72834. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  72835. */
  72836. fStop: number;
  72837. /**
  72838. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  72839. */
  72840. focusDistance: number;
  72841. /**
  72842. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  72843. */
  72844. focalLength: number;
  72845. /**
  72846. * Gets a string identifying the name of the class
  72847. * @returns "CircleOfConfusionPostProcess" string
  72848. */
  72849. getClassName(): string;
  72850. private _depthTexture;
  72851. /**
  72852. * Creates a new instance CircleOfConfusionPostProcess
  72853. * @param name The name of the effect.
  72854. * @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.
  72855. * @param options The required width/height ratio to downsize to before computing the render pass.
  72856. * @param camera The camera to apply the render pass to.
  72857. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72858. * @param engine The engine which the post process will be applied. (default: current engine)
  72859. * @param reusable If the post process can be reused on the same frame. (default: false)
  72860. * @param textureType Type of textures used when performing the post process. (default: 0)
  72861. * @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)
  72862. */
  72863. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72864. /**
  72865. * 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.
  72866. */
  72867. set depthTexture(value: RenderTargetTexture);
  72868. }
  72869. }
  72870. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  72871. /** @hidden */
  72872. export var colorCorrectionPixelShader: {
  72873. name: string;
  72874. shader: string;
  72875. };
  72876. }
  72877. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  72878. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72879. import { Engine } from "babylonjs/Engines/engine";
  72880. import { Camera } from "babylonjs/Cameras/camera";
  72881. import "babylonjs/Shaders/colorCorrection.fragment";
  72882. import { Nullable } from "babylonjs/types";
  72883. import { Scene } from "babylonjs/scene";
  72884. /**
  72885. *
  72886. * This post-process allows the modification of rendered colors by using
  72887. * a 'look-up table' (LUT). This effect is also called Color Grading.
  72888. *
  72889. * The object needs to be provided an url to a texture containing the color
  72890. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  72891. * Use an image editing software to tweak the LUT to match your needs.
  72892. *
  72893. * For an example of a color LUT, see here:
  72894. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  72895. * For explanations on color grading, see here:
  72896. * @see http://udn.epicgames.com/Three/ColorGrading.html
  72897. *
  72898. */
  72899. export class ColorCorrectionPostProcess extends PostProcess {
  72900. private _colorTableTexture;
  72901. /**
  72902. * Gets the color table url used to create the LUT texture
  72903. */
  72904. colorTableUrl: string;
  72905. /**
  72906. * Gets a string identifying the name of the class
  72907. * @returns "ColorCorrectionPostProcess" string
  72908. */
  72909. getClassName(): string;
  72910. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72911. /** @hidden */
  72912. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  72913. }
  72914. }
  72915. declare module "babylonjs/Shaders/convolution.fragment" {
  72916. /** @hidden */
  72917. export var convolutionPixelShader: {
  72918. name: string;
  72919. shader: string;
  72920. };
  72921. }
  72922. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  72923. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72924. import { Nullable } from "babylonjs/types";
  72925. import { Camera } from "babylonjs/Cameras/camera";
  72926. import { Engine } from "babylonjs/Engines/engine";
  72927. import "babylonjs/Shaders/convolution.fragment";
  72928. import { Scene } from "babylonjs/scene";
  72929. /**
  72930. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  72931. * input texture to perform effects such as edge detection or sharpening
  72932. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  72933. */
  72934. export class ConvolutionPostProcess extends PostProcess {
  72935. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  72936. kernel: number[];
  72937. /**
  72938. * Gets a string identifying the name of the class
  72939. * @returns "ConvolutionPostProcess" string
  72940. */
  72941. getClassName(): string;
  72942. /**
  72943. * Creates a new instance ConvolutionPostProcess
  72944. * @param name The name of the effect.
  72945. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  72946. * @param options The required width/height ratio to downsize to before computing the render pass.
  72947. * @param camera The camera to apply the render pass to.
  72948. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72949. * @param engine The engine which the post process will be applied. (default: current engine)
  72950. * @param reusable If the post process can be reused on the same frame. (default: false)
  72951. * @param textureType Type of textures used when performing the post process. (default: 0)
  72952. */
  72953. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72954. /** @hidden */
  72955. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  72956. /**
  72957. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72958. */
  72959. static EdgeDetect0Kernel: number[];
  72960. /**
  72961. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72962. */
  72963. static EdgeDetect1Kernel: number[];
  72964. /**
  72965. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72966. */
  72967. static EdgeDetect2Kernel: number[];
  72968. /**
  72969. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72970. */
  72971. static SharpenKernel: number[];
  72972. /**
  72973. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72974. */
  72975. static EmbossKernel: number[];
  72976. /**
  72977. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72978. */
  72979. static GaussianKernel: number[];
  72980. }
  72981. }
  72982. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  72983. import { Nullable } from "babylonjs/types";
  72984. import { Vector2 } from "babylonjs/Maths/math.vector";
  72985. import { Camera } from "babylonjs/Cameras/camera";
  72986. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72987. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  72988. import { Engine } from "babylonjs/Engines/engine";
  72989. import { Scene } from "babylonjs/scene";
  72990. /**
  72991. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  72992. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  72993. * based on samples that have a large difference in distance than the center pixel.
  72994. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  72995. */
  72996. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  72997. /**
  72998. * The direction the blur should be applied
  72999. */
  73000. direction: Vector2;
  73001. /**
  73002. * Gets a string identifying the name of the class
  73003. * @returns "DepthOfFieldBlurPostProcess" string
  73004. */
  73005. getClassName(): string;
  73006. /**
  73007. * Creates a new instance CircleOfConfusionPostProcess
  73008. * @param name The name of the effect.
  73009. * @param scene The scene the effect belongs to.
  73010. * @param direction The direction the blur should be applied.
  73011. * @param kernel The size of the kernel used to blur.
  73012. * @param options The required width/height ratio to downsize to before computing the render pass.
  73013. * @param camera The camera to apply the render pass to.
  73014. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  73015. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  73016. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73017. * @param engine The engine which the post process will be applied. (default: current engine)
  73018. * @param reusable If the post process can be reused on the same frame. (default: false)
  73019. * @param textureType Type of textures used when performing the post process. (default: 0)
  73020. * @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)
  73021. */
  73022. 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);
  73023. }
  73024. }
  73025. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  73026. /** @hidden */
  73027. export var depthOfFieldMergePixelShader: {
  73028. name: string;
  73029. shader: string;
  73030. };
  73031. }
  73032. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  73033. import { Nullable } from "babylonjs/types";
  73034. import { Camera } from "babylonjs/Cameras/camera";
  73035. import { Effect } from "babylonjs/Materials/effect";
  73036. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73037. import { Engine } from "babylonjs/Engines/engine";
  73038. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  73039. /**
  73040. * Options to be set when merging outputs from the default pipeline.
  73041. */
  73042. export class DepthOfFieldMergePostProcessOptions {
  73043. /**
  73044. * The original image to merge on top of
  73045. */
  73046. originalFromInput: PostProcess;
  73047. /**
  73048. * Parameters to perform the merge of the depth of field effect
  73049. */
  73050. depthOfField?: {
  73051. circleOfConfusion: PostProcess;
  73052. blurSteps: Array<PostProcess>;
  73053. };
  73054. /**
  73055. * Parameters to perform the merge of bloom effect
  73056. */
  73057. bloom?: {
  73058. blurred: PostProcess;
  73059. weight: number;
  73060. };
  73061. }
  73062. /**
  73063. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  73064. */
  73065. export class DepthOfFieldMergePostProcess extends PostProcess {
  73066. private blurSteps;
  73067. /**
  73068. * Gets a string identifying the name of the class
  73069. * @returns "DepthOfFieldMergePostProcess" string
  73070. */
  73071. getClassName(): string;
  73072. /**
  73073. * Creates a new instance of DepthOfFieldMergePostProcess
  73074. * @param name The name of the effect.
  73075. * @param originalFromInput Post process which's input will be used for the merge.
  73076. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  73077. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  73078. * @param options The required width/height ratio to downsize to before computing the render pass.
  73079. * @param camera The camera to apply the render pass to.
  73080. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73081. * @param engine The engine which the post process will be applied. (default: current engine)
  73082. * @param reusable If the post process can be reused on the same frame. (default: false)
  73083. * @param textureType Type of textures used when performing the post process. (default: 0)
  73084. * @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)
  73085. */
  73086. 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);
  73087. /**
  73088. * Updates the effect with the current post process compile time values and recompiles the shader.
  73089. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  73090. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  73091. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  73092. * @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
  73093. * @param onCompiled Called when the shader has been compiled.
  73094. * @param onError Called if there is an error when compiling a shader.
  73095. */
  73096. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  73097. }
  73098. }
  73099. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  73100. import { Nullable } from "babylonjs/types";
  73101. import { Camera } from "babylonjs/Cameras/camera";
  73102. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73103. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73104. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73105. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  73106. import { Scene } from "babylonjs/scene";
  73107. /**
  73108. * Specifies the level of max blur that should be applied when using the depth of field effect
  73109. */
  73110. export enum DepthOfFieldEffectBlurLevel {
  73111. /**
  73112. * Subtle blur
  73113. */
  73114. Low = 0,
  73115. /**
  73116. * Medium blur
  73117. */
  73118. Medium = 1,
  73119. /**
  73120. * Large blur
  73121. */
  73122. High = 2
  73123. }
  73124. /**
  73125. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  73126. */
  73127. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  73128. private _circleOfConfusion;
  73129. /**
  73130. * @hidden Internal, blurs from high to low
  73131. */
  73132. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  73133. private _depthOfFieldBlurY;
  73134. private _dofMerge;
  73135. /**
  73136. * @hidden Internal post processes in depth of field effect
  73137. */
  73138. _effects: Array<PostProcess>;
  73139. /**
  73140. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  73141. */
  73142. set focalLength(value: number);
  73143. get focalLength(): number;
  73144. /**
  73145. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73146. */
  73147. set fStop(value: number);
  73148. get fStop(): number;
  73149. /**
  73150. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73151. */
  73152. set focusDistance(value: number);
  73153. get focusDistance(): number;
  73154. /**
  73155. * 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.
  73156. */
  73157. set lensSize(value: number);
  73158. get lensSize(): number;
  73159. /**
  73160. * Creates a new instance DepthOfFieldEffect
  73161. * @param scene The scene the effect belongs to.
  73162. * @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.
  73163. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  73164. * @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)
  73165. */
  73166. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  73167. /**
  73168. * Get the current class name of the current effet
  73169. * @returns "DepthOfFieldEffect"
  73170. */
  73171. getClassName(): string;
  73172. /**
  73173. * 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.
  73174. */
  73175. set depthTexture(value: RenderTargetTexture);
  73176. /**
  73177. * Disposes each of the internal effects for a given camera.
  73178. * @param camera The camera to dispose the effect on.
  73179. */
  73180. disposeEffects(camera: Camera): void;
  73181. /**
  73182. * @hidden Internal
  73183. */
  73184. _updateEffects(): void;
  73185. /**
  73186. * Internal
  73187. * @returns if all the contained post processes are ready.
  73188. * @hidden
  73189. */
  73190. _isReady(): boolean;
  73191. }
  73192. }
  73193. declare module "babylonjs/Shaders/displayPass.fragment" {
  73194. /** @hidden */
  73195. export var displayPassPixelShader: {
  73196. name: string;
  73197. shader: string;
  73198. };
  73199. }
  73200. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  73201. import { Nullable } from "babylonjs/types";
  73202. import { Camera } from "babylonjs/Cameras/camera";
  73203. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73204. import { Engine } from "babylonjs/Engines/engine";
  73205. import "babylonjs/Shaders/displayPass.fragment";
  73206. import { Scene } from "babylonjs/scene";
  73207. /**
  73208. * DisplayPassPostProcess which produces an output the same as it's input
  73209. */
  73210. export class DisplayPassPostProcess extends PostProcess {
  73211. /**
  73212. * Gets a string identifying the name of the class
  73213. * @returns "DisplayPassPostProcess" string
  73214. */
  73215. getClassName(): string;
  73216. /**
  73217. * Creates the DisplayPassPostProcess
  73218. * @param name The name of the effect.
  73219. * @param options The required width/height ratio to downsize to before computing the render pass.
  73220. * @param camera The camera to apply the render pass to.
  73221. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73222. * @param engine The engine which the post process will be applied. (default: current engine)
  73223. * @param reusable If the post process can be reused on the same frame. (default: false)
  73224. */
  73225. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73226. /** @hidden */
  73227. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  73228. }
  73229. }
  73230. declare module "babylonjs/Shaders/filter.fragment" {
  73231. /** @hidden */
  73232. export var filterPixelShader: {
  73233. name: string;
  73234. shader: string;
  73235. };
  73236. }
  73237. declare module "babylonjs/PostProcesses/filterPostProcess" {
  73238. import { Nullable } from "babylonjs/types";
  73239. import { Matrix } from "babylonjs/Maths/math.vector";
  73240. import { Camera } from "babylonjs/Cameras/camera";
  73241. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73242. import { Engine } from "babylonjs/Engines/engine";
  73243. import "babylonjs/Shaders/filter.fragment";
  73244. import { Scene } from "babylonjs/scene";
  73245. /**
  73246. * Applies a kernel filter to the image
  73247. */
  73248. export class FilterPostProcess extends PostProcess {
  73249. /** The matrix to be applied to the image */
  73250. kernelMatrix: Matrix;
  73251. /**
  73252. * Gets a string identifying the name of the class
  73253. * @returns "FilterPostProcess" string
  73254. */
  73255. getClassName(): string;
  73256. /**
  73257. *
  73258. * @param name The name of the effect.
  73259. * @param kernelMatrix The matrix to be applied to the image
  73260. * @param options The required width/height ratio to downsize to before computing the render pass.
  73261. * @param camera The camera to apply the render pass to.
  73262. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73263. * @param engine The engine which the post process will be applied. (default: current engine)
  73264. * @param reusable If the post process can be reused on the same frame. (default: false)
  73265. */
  73266. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73267. /** @hidden */
  73268. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  73269. }
  73270. }
  73271. declare module "babylonjs/Shaders/fxaa.fragment" {
  73272. /** @hidden */
  73273. export var fxaaPixelShader: {
  73274. name: string;
  73275. shader: string;
  73276. };
  73277. }
  73278. declare module "babylonjs/Shaders/fxaa.vertex" {
  73279. /** @hidden */
  73280. export var fxaaVertexShader: {
  73281. name: string;
  73282. shader: string;
  73283. };
  73284. }
  73285. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  73286. import { Nullable } from "babylonjs/types";
  73287. import { Camera } from "babylonjs/Cameras/camera";
  73288. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73289. import { Engine } from "babylonjs/Engines/engine";
  73290. import "babylonjs/Shaders/fxaa.fragment";
  73291. import "babylonjs/Shaders/fxaa.vertex";
  73292. import { Scene } from "babylonjs/scene";
  73293. /**
  73294. * Fxaa post process
  73295. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  73296. */
  73297. export class FxaaPostProcess extends PostProcess {
  73298. /**
  73299. * Gets a string identifying the name of the class
  73300. * @returns "FxaaPostProcess" string
  73301. */
  73302. getClassName(): string;
  73303. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73304. private _getDefines;
  73305. /** @hidden */
  73306. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  73307. }
  73308. }
  73309. declare module "babylonjs/Shaders/grain.fragment" {
  73310. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  73311. /** @hidden */
  73312. export var grainPixelShader: {
  73313. name: string;
  73314. shader: string;
  73315. };
  73316. }
  73317. declare module "babylonjs/PostProcesses/grainPostProcess" {
  73318. import { Nullable } from "babylonjs/types";
  73319. import { Camera } from "babylonjs/Cameras/camera";
  73320. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73321. import { Engine } from "babylonjs/Engines/engine";
  73322. import "babylonjs/Shaders/grain.fragment";
  73323. import { Scene } from "babylonjs/scene";
  73324. /**
  73325. * The GrainPostProcess adds noise to the image at mid luminance levels
  73326. */
  73327. export class GrainPostProcess extends PostProcess {
  73328. /**
  73329. * The intensity of the grain added (default: 30)
  73330. */
  73331. intensity: number;
  73332. /**
  73333. * If the grain should be randomized on every frame
  73334. */
  73335. animated: boolean;
  73336. /**
  73337. * Gets a string identifying the name of the class
  73338. * @returns "GrainPostProcess" string
  73339. */
  73340. getClassName(): string;
  73341. /**
  73342. * Creates a new instance of @see GrainPostProcess
  73343. * @param name The name of the effect.
  73344. * @param options The required width/height ratio to downsize to before computing the render pass.
  73345. * @param camera The camera to apply the render pass to.
  73346. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73347. * @param engine The engine which the post process will be applied. (default: current engine)
  73348. * @param reusable If the post process can be reused on the same frame. (default: false)
  73349. * @param textureType Type of textures used when performing the post process. (default: 0)
  73350. * @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)
  73351. */
  73352. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73353. /** @hidden */
  73354. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  73355. }
  73356. }
  73357. declare module "babylonjs/Shaders/highlights.fragment" {
  73358. /** @hidden */
  73359. export var highlightsPixelShader: {
  73360. name: string;
  73361. shader: string;
  73362. };
  73363. }
  73364. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  73365. import { Nullable } from "babylonjs/types";
  73366. import { Camera } from "babylonjs/Cameras/camera";
  73367. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73368. import { Engine } from "babylonjs/Engines/engine";
  73369. import "babylonjs/Shaders/highlights.fragment";
  73370. /**
  73371. * Extracts highlights from the image
  73372. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73373. */
  73374. export class HighlightsPostProcess extends PostProcess {
  73375. /**
  73376. * Gets a string identifying the name of the class
  73377. * @returns "HighlightsPostProcess" string
  73378. */
  73379. getClassName(): string;
  73380. /**
  73381. * Extracts highlights from the image
  73382. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73383. * @param name The name of the effect.
  73384. * @param options The required width/height ratio to downsize to before computing the render pass.
  73385. * @param camera The camera to apply the render pass to.
  73386. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73387. * @param engine The engine which the post process will be applied. (default: current engine)
  73388. * @param reusable If the post process can be reused on the same frame. (default: false)
  73389. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  73390. */
  73391. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73392. }
  73393. }
  73394. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  73395. /** @hidden */
  73396. export var mrtFragmentDeclaration: {
  73397. name: string;
  73398. shader: string;
  73399. };
  73400. }
  73401. declare module "babylonjs/Shaders/geometry.fragment" {
  73402. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  73403. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  73404. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  73405. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  73406. /** @hidden */
  73407. export var geometryPixelShader: {
  73408. name: string;
  73409. shader: string;
  73410. };
  73411. }
  73412. declare module "babylonjs/Shaders/geometry.vertex" {
  73413. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  73414. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  73415. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  73416. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  73417. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  73418. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  73419. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  73420. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  73421. /** @hidden */
  73422. export var geometryVertexShader: {
  73423. name: string;
  73424. shader: string;
  73425. };
  73426. }
  73427. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  73428. import { Matrix } from "babylonjs/Maths/math.vector";
  73429. import { SubMesh } from "babylonjs/Meshes/subMesh";
  73430. import { Mesh } from "babylonjs/Meshes/mesh";
  73431. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  73432. import { Effect } from "babylonjs/Materials/effect";
  73433. import { Scene } from "babylonjs/scene";
  73434. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73435. import "babylonjs/Shaders/geometry.fragment";
  73436. import "babylonjs/Shaders/geometry.vertex";
  73437. /** @hidden */
  73438. interface ISavedTransformationMatrix {
  73439. world: Matrix;
  73440. viewProjection: Matrix;
  73441. }
  73442. /**
  73443. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  73444. */
  73445. export class GeometryBufferRenderer {
  73446. /**
  73447. * Constant used to retrieve the position texture index in the G-Buffer textures array
  73448. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  73449. */
  73450. static readonly POSITION_TEXTURE_TYPE: number;
  73451. /**
  73452. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  73453. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  73454. */
  73455. static readonly VELOCITY_TEXTURE_TYPE: number;
  73456. /**
  73457. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  73458. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  73459. */
  73460. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  73461. /**
  73462. * Dictionary used to store the previous transformation matrices of each rendered mesh
  73463. * in order to compute objects velocities when enableVelocity is set to "true"
  73464. * @hidden
  73465. */
  73466. _previousTransformationMatrices: {
  73467. [index: number]: ISavedTransformationMatrix;
  73468. };
  73469. /**
  73470. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  73471. * in order to compute objects velocities when enableVelocity is set to "true"
  73472. * @hidden
  73473. */
  73474. _previousBonesTransformationMatrices: {
  73475. [index: number]: Float32Array;
  73476. };
  73477. /**
  73478. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  73479. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  73480. */
  73481. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  73482. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  73483. renderTransparentMeshes: boolean;
  73484. private _scene;
  73485. private _resizeObserver;
  73486. private _multiRenderTarget;
  73487. private _ratio;
  73488. private _enablePosition;
  73489. private _enableVelocity;
  73490. private _enableReflectivity;
  73491. private _positionIndex;
  73492. private _velocityIndex;
  73493. private _reflectivityIndex;
  73494. protected _effect: Effect;
  73495. protected _cachedDefines: string;
  73496. /**
  73497. * Set the render list (meshes to be rendered) used in the G buffer.
  73498. */
  73499. set renderList(meshes: Mesh[]);
  73500. /**
  73501. * Gets wether or not G buffer are supported by the running hardware.
  73502. * This requires draw buffer supports
  73503. */
  73504. get isSupported(): boolean;
  73505. /**
  73506. * Returns the index of the given texture type in the G-Buffer textures array
  73507. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  73508. * @returns the index of the given texture type in the G-Buffer textures array
  73509. */
  73510. getTextureIndex(textureType: number): number;
  73511. /**
  73512. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  73513. */
  73514. get enablePosition(): boolean;
  73515. /**
  73516. * Sets whether or not objects positions are enabled for the G buffer.
  73517. */
  73518. set enablePosition(enable: boolean);
  73519. /**
  73520. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  73521. */
  73522. get enableVelocity(): boolean;
  73523. /**
  73524. * Sets wether or not objects velocities are enabled for the G buffer.
  73525. */
  73526. set enableVelocity(enable: boolean);
  73527. /**
  73528. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  73529. */
  73530. get enableReflectivity(): boolean;
  73531. /**
  73532. * Sets wether or not objects roughness are enabled for the G buffer.
  73533. */
  73534. set enableReflectivity(enable: boolean);
  73535. /**
  73536. * Gets the scene associated with the buffer.
  73537. */
  73538. get scene(): Scene;
  73539. /**
  73540. * Gets the ratio used by the buffer during its creation.
  73541. * How big is the buffer related to the main canvas.
  73542. */
  73543. get ratio(): number;
  73544. /** @hidden */
  73545. static _SceneComponentInitialization: (scene: Scene) => void;
  73546. /**
  73547. * Creates a new G Buffer for the scene
  73548. * @param scene The scene the buffer belongs to
  73549. * @param ratio How big is the buffer related to the main canvas.
  73550. */
  73551. constructor(scene: Scene, ratio?: number);
  73552. /**
  73553. * Checks wether everything is ready to render a submesh to the G buffer.
  73554. * @param subMesh the submesh to check readiness for
  73555. * @param useInstances is the mesh drawn using instance or not
  73556. * @returns true if ready otherwise false
  73557. */
  73558. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73559. /**
  73560. * Gets the current underlying G Buffer.
  73561. * @returns the buffer
  73562. */
  73563. getGBuffer(): MultiRenderTarget;
  73564. /**
  73565. * Gets the number of samples used to render the buffer (anti aliasing).
  73566. */
  73567. get samples(): number;
  73568. /**
  73569. * Sets the number of samples used to render the buffer (anti aliasing).
  73570. */
  73571. set samples(value: number);
  73572. /**
  73573. * Disposes the renderer and frees up associated resources.
  73574. */
  73575. dispose(): void;
  73576. protected _createRenderTargets(): void;
  73577. private _copyBonesTransformationMatrices;
  73578. }
  73579. }
  73580. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  73581. import { Nullable } from "babylonjs/types";
  73582. import { Scene } from "babylonjs/scene";
  73583. import { ISceneComponent } from "babylonjs/sceneComponent";
  73584. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  73585. module "babylonjs/scene" {
  73586. interface Scene {
  73587. /** @hidden (Backing field) */
  73588. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73589. /**
  73590. * Gets or Sets the current geometry buffer associated to the scene.
  73591. */
  73592. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73593. /**
  73594. * Enables a GeometryBufferRender and associates it with the scene
  73595. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  73596. * @returns the GeometryBufferRenderer
  73597. */
  73598. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  73599. /**
  73600. * Disables the GeometryBufferRender associated with the scene
  73601. */
  73602. disableGeometryBufferRenderer(): void;
  73603. }
  73604. }
  73605. /**
  73606. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73607. * in several rendering techniques.
  73608. */
  73609. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  73610. /**
  73611. * The component name helpful to identify the component in the list of scene components.
  73612. */
  73613. readonly name: string;
  73614. /**
  73615. * The scene the component belongs to.
  73616. */
  73617. scene: Scene;
  73618. /**
  73619. * Creates a new instance of the component for the given scene
  73620. * @param scene Defines the scene to register the component in
  73621. */
  73622. constructor(scene: Scene);
  73623. /**
  73624. * Registers the component in a given scene
  73625. */
  73626. register(): void;
  73627. /**
  73628. * Rebuilds the elements related to this component in case of
  73629. * context lost for instance.
  73630. */
  73631. rebuild(): void;
  73632. /**
  73633. * Disposes the component and the associated ressources
  73634. */
  73635. dispose(): void;
  73636. private _gatherRenderTargets;
  73637. }
  73638. }
  73639. declare module "babylonjs/Shaders/motionBlur.fragment" {
  73640. /** @hidden */
  73641. export var motionBlurPixelShader: {
  73642. name: string;
  73643. shader: string;
  73644. };
  73645. }
  73646. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  73647. import { Nullable } from "babylonjs/types";
  73648. import { Camera } from "babylonjs/Cameras/camera";
  73649. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73650. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73651. import "babylonjs/Animations/animatable";
  73652. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  73653. import "babylonjs/Shaders/motionBlur.fragment";
  73654. import { Engine } from "babylonjs/Engines/engine";
  73655. import { Scene } from "babylonjs/scene";
  73656. /**
  73657. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  73658. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  73659. * As an example, all you have to do is to create the post-process:
  73660. * var mb = new BABYLON.MotionBlurPostProcess(
  73661. * 'mb', // The name of the effect.
  73662. * scene, // The scene containing the objects to blur according to their velocity.
  73663. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  73664. * camera // The camera to apply the render pass to.
  73665. * );
  73666. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  73667. */
  73668. export class MotionBlurPostProcess extends PostProcess {
  73669. /**
  73670. * Defines how much the image is blurred by the movement. Default value is equal to 1
  73671. */
  73672. motionStrength: number;
  73673. /**
  73674. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  73675. */
  73676. get motionBlurSamples(): number;
  73677. /**
  73678. * Sets the number of iterations to be used for motion blur quality
  73679. */
  73680. set motionBlurSamples(samples: number);
  73681. private _motionBlurSamples;
  73682. private _geometryBufferRenderer;
  73683. /**
  73684. * Gets a string identifying the name of the class
  73685. * @returns "MotionBlurPostProcess" string
  73686. */
  73687. getClassName(): string;
  73688. /**
  73689. * Creates a new instance MotionBlurPostProcess
  73690. * @param name The name of the effect.
  73691. * @param scene The scene containing the objects to blur according to their velocity.
  73692. * @param options The required width/height ratio to downsize to before computing the render pass.
  73693. * @param camera The camera to apply the render pass to.
  73694. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73695. * @param engine The engine which the post process will be applied. (default: current engine)
  73696. * @param reusable If the post process can be reused on the same frame. (default: false)
  73697. * @param textureType Type of textures used when performing the post process. (default: 0)
  73698. * @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)
  73699. */
  73700. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73701. /**
  73702. * Excludes the given skinned mesh from computing bones velocities.
  73703. * 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.
  73704. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  73705. */
  73706. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73707. /**
  73708. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  73709. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  73710. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  73711. */
  73712. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73713. /**
  73714. * Disposes the post process.
  73715. * @param camera The camera to dispose the post process on.
  73716. */
  73717. dispose(camera?: Camera): void;
  73718. /** @hidden */
  73719. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  73720. }
  73721. }
  73722. declare module "babylonjs/Shaders/refraction.fragment" {
  73723. /** @hidden */
  73724. export var refractionPixelShader: {
  73725. name: string;
  73726. shader: string;
  73727. };
  73728. }
  73729. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  73730. import { Color3 } from "babylonjs/Maths/math.color";
  73731. import { Camera } from "babylonjs/Cameras/camera";
  73732. import { Texture } from "babylonjs/Materials/Textures/texture";
  73733. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73734. import { Engine } from "babylonjs/Engines/engine";
  73735. import "babylonjs/Shaders/refraction.fragment";
  73736. import { Scene } from "babylonjs/scene";
  73737. /**
  73738. * Post process which applies a refractin texture
  73739. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73740. */
  73741. export class RefractionPostProcess extends PostProcess {
  73742. private _refTexture;
  73743. private _ownRefractionTexture;
  73744. /** the base color of the refraction (used to taint the rendering) */
  73745. color: Color3;
  73746. /** simulated refraction depth */
  73747. depth: number;
  73748. /** the coefficient of the base color (0 to remove base color tainting) */
  73749. colorLevel: number;
  73750. /** Gets the url used to load the refraction texture */
  73751. refractionTextureUrl: string;
  73752. /**
  73753. * Gets or sets the refraction texture
  73754. * Please note that you are responsible for disposing the texture if you set it manually
  73755. */
  73756. get refractionTexture(): Texture;
  73757. set refractionTexture(value: Texture);
  73758. /**
  73759. * Gets a string identifying the name of the class
  73760. * @returns "RefractionPostProcess" string
  73761. */
  73762. getClassName(): string;
  73763. /**
  73764. * Initializes the RefractionPostProcess
  73765. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73766. * @param name The name of the effect.
  73767. * @param refractionTextureUrl Url of the refraction texture to use
  73768. * @param color the base color of the refraction (used to taint the rendering)
  73769. * @param depth simulated refraction depth
  73770. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  73771. * @param camera The camera to apply the render pass to.
  73772. * @param options The required width/height ratio to downsize to before computing the render pass.
  73773. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73774. * @param engine The engine which the post process will be applied. (default: current engine)
  73775. * @param reusable If the post process can be reused on the same frame. (default: false)
  73776. */
  73777. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73778. /**
  73779. * Disposes of the post process
  73780. * @param camera Camera to dispose post process on
  73781. */
  73782. dispose(camera: Camera): void;
  73783. /** @hidden */
  73784. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  73785. }
  73786. }
  73787. declare module "babylonjs/Shaders/sharpen.fragment" {
  73788. /** @hidden */
  73789. export var sharpenPixelShader: {
  73790. name: string;
  73791. shader: string;
  73792. };
  73793. }
  73794. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  73795. import { Nullable } from "babylonjs/types";
  73796. import { Camera } from "babylonjs/Cameras/camera";
  73797. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73798. import "babylonjs/Shaders/sharpen.fragment";
  73799. import { Engine } from "babylonjs/Engines/engine";
  73800. import { Scene } from "babylonjs/scene";
  73801. /**
  73802. * The SharpenPostProcess applies a sharpen kernel to every pixel
  73803. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73804. */
  73805. export class SharpenPostProcess extends PostProcess {
  73806. /**
  73807. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  73808. */
  73809. colorAmount: number;
  73810. /**
  73811. * How much sharpness should be applied (default: 0.3)
  73812. */
  73813. edgeAmount: number;
  73814. /**
  73815. * Gets a string identifying the name of the class
  73816. * @returns "SharpenPostProcess" string
  73817. */
  73818. getClassName(): string;
  73819. /**
  73820. * Creates a new instance ConvolutionPostProcess
  73821. * @param name The name of the effect.
  73822. * @param options The required width/height ratio to downsize to before computing the render pass.
  73823. * @param camera The camera to apply the render pass to.
  73824. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73825. * @param engine The engine which the post process will be applied. (default: current engine)
  73826. * @param reusable If the post process can be reused on the same frame. (default: false)
  73827. * @param textureType Type of textures used when performing the post process. (default: 0)
  73828. * @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)
  73829. */
  73830. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73831. /** @hidden */
  73832. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  73833. }
  73834. }
  73835. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  73836. import { Nullable } from "babylonjs/types";
  73837. import { Camera } from "babylonjs/Cameras/camera";
  73838. import { Engine } from "babylonjs/Engines/engine";
  73839. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73840. import { IInspectable } from "babylonjs/Misc/iInspectable";
  73841. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  73842. /**
  73843. * PostProcessRenderPipeline
  73844. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73845. */
  73846. export class PostProcessRenderPipeline {
  73847. private engine;
  73848. private _renderEffects;
  73849. private _renderEffectsForIsolatedPass;
  73850. /**
  73851. * List of inspectable custom properties (used by the Inspector)
  73852. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  73853. */
  73854. inspectableCustomProperties: IInspectable[];
  73855. /**
  73856. * @hidden
  73857. */
  73858. protected _cameras: Camera[];
  73859. /** @hidden */
  73860. _name: string;
  73861. /**
  73862. * Gets pipeline name
  73863. */
  73864. get name(): string;
  73865. /** Gets the list of attached cameras */
  73866. get cameras(): Camera[];
  73867. /**
  73868. * Initializes a PostProcessRenderPipeline
  73869. * @param engine engine to add the pipeline to
  73870. * @param name name of the pipeline
  73871. */
  73872. constructor(engine: Engine, name: string);
  73873. /**
  73874. * Gets the class name
  73875. * @returns "PostProcessRenderPipeline"
  73876. */
  73877. getClassName(): string;
  73878. /**
  73879. * If all the render effects in the pipeline are supported
  73880. */
  73881. get isSupported(): boolean;
  73882. /**
  73883. * Adds an effect to the pipeline
  73884. * @param renderEffect the effect to add
  73885. */
  73886. addEffect(renderEffect: PostProcessRenderEffect): void;
  73887. /** @hidden */
  73888. _rebuild(): void;
  73889. /** @hidden */
  73890. _enableEffect(renderEffectName: string, cameras: Camera): void;
  73891. /** @hidden */
  73892. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  73893. /** @hidden */
  73894. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73895. /** @hidden */
  73896. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73897. /** @hidden */
  73898. _attachCameras(cameras: Camera, unique: boolean): void;
  73899. /** @hidden */
  73900. _attachCameras(cameras: Camera[], unique: boolean): void;
  73901. /** @hidden */
  73902. _detachCameras(cameras: Camera): void;
  73903. /** @hidden */
  73904. _detachCameras(cameras: Nullable<Camera[]>): void;
  73905. /** @hidden */
  73906. _update(): void;
  73907. /** @hidden */
  73908. _reset(): void;
  73909. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  73910. /**
  73911. * Sets the required values to the prepass renderer.
  73912. * @param prePassRenderer defines the prepass renderer to setup.
  73913. * @returns true if the pre pass is needed.
  73914. */
  73915. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  73916. /**
  73917. * Disposes of the pipeline
  73918. */
  73919. dispose(): void;
  73920. }
  73921. }
  73922. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  73923. import { Camera } from "babylonjs/Cameras/camera";
  73924. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73925. /**
  73926. * PostProcessRenderPipelineManager class
  73927. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73928. */
  73929. export class PostProcessRenderPipelineManager {
  73930. private _renderPipelines;
  73931. /**
  73932. * Initializes a PostProcessRenderPipelineManager
  73933. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73934. */
  73935. constructor();
  73936. /**
  73937. * Gets the list of supported render pipelines
  73938. */
  73939. get supportedPipelines(): PostProcessRenderPipeline[];
  73940. /**
  73941. * Adds a pipeline to the manager
  73942. * @param renderPipeline The pipeline to add
  73943. */
  73944. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  73945. /**
  73946. * Attaches a camera to the pipeline
  73947. * @param renderPipelineName The name of the pipeline to attach to
  73948. * @param cameras the camera to attach
  73949. * @param unique if the camera can be attached multiple times to the pipeline
  73950. */
  73951. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  73952. /**
  73953. * Detaches a camera from the pipeline
  73954. * @param renderPipelineName The name of the pipeline to detach from
  73955. * @param cameras the camera to detach
  73956. */
  73957. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  73958. /**
  73959. * Enables an effect by name on a pipeline
  73960. * @param renderPipelineName the name of the pipeline to enable the effect in
  73961. * @param renderEffectName the name of the effect to enable
  73962. * @param cameras the cameras that the effect should be enabled on
  73963. */
  73964. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73965. /**
  73966. * Disables an effect by name on a pipeline
  73967. * @param renderPipelineName the name of the pipeline to disable the effect in
  73968. * @param renderEffectName the name of the effect to disable
  73969. * @param cameras the cameras that the effect should be disabled on
  73970. */
  73971. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73972. /**
  73973. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  73974. */
  73975. update(): void;
  73976. /** @hidden */
  73977. _rebuild(): void;
  73978. /**
  73979. * Disposes of the manager and pipelines
  73980. */
  73981. dispose(): void;
  73982. }
  73983. }
  73984. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  73985. import { ISceneComponent } from "babylonjs/sceneComponent";
  73986. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  73987. import { Scene } from "babylonjs/scene";
  73988. module "babylonjs/scene" {
  73989. interface Scene {
  73990. /** @hidden (Backing field) */
  73991. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73992. /**
  73993. * Gets the postprocess render pipeline manager
  73994. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73995. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  73996. */
  73997. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73998. }
  73999. }
  74000. /**
  74001. * Defines the Render Pipeline scene component responsible to rendering pipelines
  74002. */
  74003. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  74004. /**
  74005. * The component name helpfull to identify the component in the list of scene components.
  74006. */
  74007. readonly name: string;
  74008. /**
  74009. * The scene the component belongs to.
  74010. */
  74011. scene: Scene;
  74012. /**
  74013. * Creates a new instance of the component for the given scene
  74014. * @param scene Defines the scene to register the component in
  74015. */
  74016. constructor(scene: Scene);
  74017. /**
  74018. * Registers the component in a given scene
  74019. */
  74020. register(): void;
  74021. /**
  74022. * Rebuilds the elements related to this component in case of
  74023. * context lost for instance.
  74024. */
  74025. rebuild(): void;
  74026. /**
  74027. * Disposes the component and the associated ressources
  74028. */
  74029. dispose(): void;
  74030. private _gatherRenderTargets;
  74031. }
  74032. }
  74033. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  74034. import { Nullable } from "babylonjs/types";
  74035. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74036. import { Camera } from "babylonjs/Cameras/camera";
  74037. import { IDisposable } from "babylonjs/scene";
  74038. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  74039. import { Scene } from "babylonjs/scene";
  74040. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  74041. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  74042. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  74043. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  74044. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74045. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74046. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  74047. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74048. import { Animation } from "babylonjs/Animations/animation";
  74049. /**
  74050. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  74051. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74052. */
  74053. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74054. private _scene;
  74055. private _camerasToBeAttached;
  74056. /**
  74057. * ID of the sharpen post process,
  74058. */
  74059. private readonly SharpenPostProcessId;
  74060. /**
  74061. * @ignore
  74062. * ID of the image processing post process;
  74063. */
  74064. readonly ImageProcessingPostProcessId: string;
  74065. /**
  74066. * @ignore
  74067. * ID of the Fast Approximate Anti-Aliasing post process;
  74068. */
  74069. readonly FxaaPostProcessId: string;
  74070. /**
  74071. * ID of the chromatic aberration post process,
  74072. */
  74073. private readonly ChromaticAberrationPostProcessId;
  74074. /**
  74075. * ID of the grain post process
  74076. */
  74077. private readonly GrainPostProcessId;
  74078. /**
  74079. * Sharpen post process which will apply a sharpen convolution to enhance edges
  74080. */
  74081. sharpen: SharpenPostProcess;
  74082. private _sharpenEffect;
  74083. private bloom;
  74084. /**
  74085. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  74086. */
  74087. depthOfField: DepthOfFieldEffect;
  74088. /**
  74089. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74090. */
  74091. fxaa: FxaaPostProcess;
  74092. /**
  74093. * Image post processing pass used to perform operations such as tone mapping or color grading.
  74094. */
  74095. imageProcessing: ImageProcessingPostProcess;
  74096. /**
  74097. * Chromatic aberration post process which will shift rgb colors in the image
  74098. */
  74099. chromaticAberration: ChromaticAberrationPostProcess;
  74100. private _chromaticAberrationEffect;
  74101. /**
  74102. * Grain post process which add noise to the image
  74103. */
  74104. grain: GrainPostProcess;
  74105. private _grainEffect;
  74106. /**
  74107. * Glow post process which adds a glow to emissive areas of the image
  74108. */
  74109. private _glowLayer;
  74110. /**
  74111. * Animations which can be used to tweak settings over a period of time
  74112. */
  74113. animations: Animation[];
  74114. private _imageProcessingConfigurationObserver;
  74115. private _sharpenEnabled;
  74116. private _bloomEnabled;
  74117. private _depthOfFieldEnabled;
  74118. private _depthOfFieldBlurLevel;
  74119. private _fxaaEnabled;
  74120. private _imageProcessingEnabled;
  74121. private _defaultPipelineTextureType;
  74122. private _bloomScale;
  74123. private _chromaticAberrationEnabled;
  74124. private _grainEnabled;
  74125. private _buildAllowed;
  74126. /**
  74127. * Gets active scene
  74128. */
  74129. get scene(): Scene;
  74130. /**
  74131. * Enable or disable the sharpen process from the pipeline
  74132. */
  74133. set sharpenEnabled(enabled: boolean);
  74134. get sharpenEnabled(): boolean;
  74135. private _resizeObserver;
  74136. private _hardwareScaleLevel;
  74137. private _bloomKernel;
  74138. /**
  74139. * Specifies the size of the bloom blur kernel, relative to the final output size
  74140. */
  74141. get bloomKernel(): number;
  74142. set bloomKernel(value: number);
  74143. /**
  74144. * Specifies the weight of the bloom in the final rendering
  74145. */
  74146. private _bloomWeight;
  74147. /**
  74148. * Specifies the luma threshold for the area that will be blurred by the bloom
  74149. */
  74150. private _bloomThreshold;
  74151. private _hdr;
  74152. /**
  74153. * The strength of the bloom.
  74154. */
  74155. set bloomWeight(value: number);
  74156. get bloomWeight(): number;
  74157. /**
  74158. * The strength of the bloom.
  74159. */
  74160. set bloomThreshold(value: number);
  74161. get bloomThreshold(): number;
  74162. /**
  74163. * The scale of the bloom, lower value will provide better performance.
  74164. */
  74165. set bloomScale(value: number);
  74166. get bloomScale(): number;
  74167. /**
  74168. * Enable or disable the bloom from the pipeline
  74169. */
  74170. set bloomEnabled(enabled: boolean);
  74171. get bloomEnabled(): boolean;
  74172. private _rebuildBloom;
  74173. /**
  74174. * If the depth of field is enabled.
  74175. */
  74176. get depthOfFieldEnabled(): boolean;
  74177. set depthOfFieldEnabled(enabled: boolean);
  74178. /**
  74179. * Blur level of the depth of field effect. (Higher blur will effect performance)
  74180. */
  74181. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  74182. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  74183. /**
  74184. * If the anti aliasing is enabled.
  74185. */
  74186. set fxaaEnabled(enabled: boolean);
  74187. get fxaaEnabled(): boolean;
  74188. private _samples;
  74189. /**
  74190. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74191. */
  74192. set samples(sampleCount: number);
  74193. get samples(): number;
  74194. /**
  74195. * If image processing is enabled.
  74196. */
  74197. set imageProcessingEnabled(enabled: boolean);
  74198. get imageProcessingEnabled(): boolean;
  74199. /**
  74200. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  74201. */
  74202. set glowLayerEnabled(enabled: boolean);
  74203. get glowLayerEnabled(): boolean;
  74204. /**
  74205. * Gets the glow layer (or null if not defined)
  74206. */
  74207. get glowLayer(): Nullable<GlowLayer>;
  74208. /**
  74209. * Enable or disable the chromaticAberration process from the pipeline
  74210. */
  74211. set chromaticAberrationEnabled(enabled: boolean);
  74212. get chromaticAberrationEnabled(): boolean;
  74213. /**
  74214. * Enable or disable the grain process from the pipeline
  74215. */
  74216. set grainEnabled(enabled: boolean);
  74217. get grainEnabled(): boolean;
  74218. /**
  74219. * @constructor
  74220. * @param name - The rendering pipeline name (default: "")
  74221. * @param hdr - If high dynamic range textures should be used (default: true)
  74222. * @param scene - The scene linked to this pipeline (default: the last created scene)
  74223. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  74224. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  74225. */
  74226. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  74227. /**
  74228. * Get the class name
  74229. * @returns "DefaultRenderingPipeline"
  74230. */
  74231. getClassName(): string;
  74232. /**
  74233. * Force the compilation of the entire pipeline.
  74234. */
  74235. prepare(): void;
  74236. private _hasCleared;
  74237. private _prevPostProcess;
  74238. private _prevPrevPostProcess;
  74239. private _setAutoClearAndTextureSharing;
  74240. private _depthOfFieldSceneObserver;
  74241. private _buildPipeline;
  74242. private _disposePostProcesses;
  74243. /**
  74244. * Adds a camera to the pipeline
  74245. * @param camera the camera to be added
  74246. */
  74247. addCamera(camera: Camera): void;
  74248. /**
  74249. * Removes a camera from the pipeline
  74250. * @param camera the camera to remove
  74251. */
  74252. removeCamera(camera: Camera): void;
  74253. /**
  74254. * Dispose of the pipeline and stop all post processes
  74255. */
  74256. dispose(): void;
  74257. /**
  74258. * Serialize the rendering pipeline (Used when exporting)
  74259. * @returns the serialized object
  74260. */
  74261. serialize(): any;
  74262. /**
  74263. * Parse the serialized pipeline
  74264. * @param source Source pipeline.
  74265. * @param scene The scene to load the pipeline to.
  74266. * @param rootUrl The URL of the serialized pipeline.
  74267. * @returns An instantiated pipeline from the serialized object.
  74268. */
  74269. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  74270. }
  74271. }
  74272. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  74273. /** @hidden */
  74274. export var lensHighlightsPixelShader: {
  74275. name: string;
  74276. shader: string;
  74277. };
  74278. }
  74279. declare module "babylonjs/Shaders/depthOfField.fragment" {
  74280. /** @hidden */
  74281. export var depthOfFieldPixelShader: {
  74282. name: string;
  74283. shader: string;
  74284. };
  74285. }
  74286. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  74287. import { Camera } from "babylonjs/Cameras/camera";
  74288. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74289. import { Scene } from "babylonjs/scene";
  74290. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74291. import "babylonjs/Shaders/chromaticAberration.fragment";
  74292. import "babylonjs/Shaders/lensHighlights.fragment";
  74293. import "babylonjs/Shaders/depthOfField.fragment";
  74294. /**
  74295. * BABYLON.JS Chromatic Aberration GLSL Shader
  74296. * Author: Olivier Guyot
  74297. * Separates very slightly R, G and B colors on the edges of the screen
  74298. * Inspired by Francois Tarlier & Martins Upitis
  74299. */
  74300. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  74301. /**
  74302. * @ignore
  74303. * The chromatic aberration PostProcess id in the pipeline
  74304. */
  74305. LensChromaticAberrationEffect: string;
  74306. /**
  74307. * @ignore
  74308. * The highlights enhancing PostProcess id in the pipeline
  74309. */
  74310. HighlightsEnhancingEffect: string;
  74311. /**
  74312. * @ignore
  74313. * The depth-of-field PostProcess id in the pipeline
  74314. */
  74315. LensDepthOfFieldEffect: string;
  74316. private _scene;
  74317. private _depthTexture;
  74318. private _grainTexture;
  74319. private _chromaticAberrationPostProcess;
  74320. private _highlightsPostProcess;
  74321. private _depthOfFieldPostProcess;
  74322. private _edgeBlur;
  74323. private _grainAmount;
  74324. private _chromaticAberration;
  74325. private _distortion;
  74326. private _highlightsGain;
  74327. private _highlightsThreshold;
  74328. private _dofDistance;
  74329. private _dofAperture;
  74330. private _dofDarken;
  74331. private _dofPentagon;
  74332. private _blurNoise;
  74333. /**
  74334. * @constructor
  74335. *
  74336. * Effect parameters are as follow:
  74337. * {
  74338. * chromatic_aberration: number; // from 0 to x (1 for realism)
  74339. * edge_blur: number; // from 0 to x (1 for realism)
  74340. * distortion: number; // from 0 to x (1 for realism)
  74341. * grain_amount: number; // from 0 to 1
  74342. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  74343. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  74344. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  74345. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  74346. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  74347. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  74348. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  74349. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  74350. * }
  74351. * Note: if an effect parameter is unset, effect is disabled
  74352. *
  74353. * @param name The rendering pipeline name
  74354. * @param parameters - An object containing all parameters (see above)
  74355. * @param scene The scene linked to this pipeline
  74356. * @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)
  74357. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74358. */
  74359. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  74360. /**
  74361. * Get the class name
  74362. * @returns "LensRenderingPipeline"
  74363. */
  74364. getClassName(): string;
  74365. /**
  74366. * Gets associated scene
  74367. */
  74368. get scene(): Scene;
  74369. /**
  74370. * Gets or sets the edge blur
  74371. */
  74372. get edgeBlur(): number;
  74373. set edgeBlur(value: number);
  74374. /**
  74375. * Gets or sets the grain amount
  74376. */
  74377. get grainAmount(): number;
  74378. set grainAmount(value: number);
  74379. /**
  74380. * Gets or sets the chromatic aberration amount
  74381. */
  74382. get chromaticAberration(): number;
  74383. set chromaticAberration(value: number);
  74384. /**
  74385. * Gets or sets the depth of field aperture
  74386. */
  74387. get dofAperture(): number;
  74388. set dofAperture(value: number);
  74389. /**
  74390. * Gets or sets the edge distortion
  74391. */
  74392. get edgeDistortion(): number;
  74393. set edgeDistortion(value: number);
  74394. /**
  74395. * Gets or sets the depth of field distortion
  74396. */
  74397. get dofDistortion(): number;
  74398. set dofDistortion(value: number);
  74399. /**
  74400. * Gets or sets the darken out of focus amount
  74401. */
  74402. get darkenOutOfFocus(): number;
  74403. set darkenOutOfFocus(value: number);
  74404. /**
  74405. * Gets or sets a boolean indicating if blur noise is enabled
  74406. */
  74407. get blurNoise(): boolean;
  74408. set blurNoise(value: boolean);
  74409. /**
  74410. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  74411. */
  74412. get pentagonBokeh(): boolean;
  74413. set pentagonBokeh(value: boolean);
  74414. /**
  74415. * Gets or sets the highlight grain amount
  74416. */
  74417. get highlightsGain(): number;
  74418. set highlightsGain(value: number);
  74419. /**
  74420. * Gets or sets the highlight threshold
  74421. */
  74422. get highlightsThreshold(): number;
  74423. set highlightsThreshold(value: number);
  74424. /**
  74425. * Sets the amount of blur at the edges
  74426. * @param amount blur amount
  74427. */
  74428. setEdgeBlur(amount: number): void;
  74429. /**
  74430. * Sets edge blur to 0
  74431. */
  74432. disableEdgeBlur(): void;
  74433. /**
  74434. * Sets the amout of grain
  74435. * @param amount Amount of grain
  74436. */
  74437. setGrainAmount(amount: number): void;
  74438. /**
  74439. * Set grain amount to 0
  74440. */
  74441. disableGrain(): void;
  74442. /**
  74443. * Sets the chromatic aberration amount
  74444. * @param amount amount of chromatic aberration
  74445. */
  74446. setChromaticAberration(amount: number): void;
  74447. /**
  74448. * Sets chromatic aberration amount to 0
  74449. */
  74450. disableChromaticAberration(): void;
  74451. /**
  74452. * Sets the EdgeDistortion amount
  74453. * @param amount amount of EdgeDistortion
  74454. */
  74455. setEdgeDistortion(amount: number): void;
  74456. /**
  74457. * Sets edge distortion to 0
  74458. */
  74459. disableEdgeDistortion(): void;
  74460. /**
  74461. * Sets the FocusDistance amount
  74462. * @param amount amount of FocusDistance
  74463. */
  74464. setFocusDistance(amount: number): void;
  74465. /**
  74466. * Disables depth of field
  74467. */
  74468. disableDepthOfField(): void;
  74469. /**
  74470. * Sets the Aperture amount
  74471. * @param amount amount of Aperture
  74472. */
  74473. setAperture(amount: number): void;
  74474. /**
  74475. * Sets the DarkenOutOfFocus amount
  74476. * @param amount amount of DarkenOutOfFocus
  74477. */
  74478. setDarkenOutOfFocus(amount: number): void;
  74479. private _pentagonBokehIsEnabled;
  74480. /**
  74481. * Creates a pentagon bokeh effect
  74482. */
  74483. enablePentagonBokeh(): void;
  74484. /**
  74485. * Disables the pentagon bokeh effect
  74486. */
  74487. disablePentagonBokeh(): void;
  74488. /**
  74489. * Enables noise blur
  74490. */
  74491. enableNoiseBlur(): void;
  74492. /**
  74493. * Disables noise blur
  74494. */
  74495. disableNoiseBlur(): void;
  74496. /**
  74497. * Sets the HighlightsGain amount
  74498. * @param amount amount of HighlightsGain
  74499. */
  74500. setHighlightsGain(amount: number): void;
  74501. /**
  74502. * Sets the HighlightsThreshold amount
  74503. * @param amount amount of HighlightsThreshold
  74504. */
  74505. setHighlightsThreshold(amount: number): void;
  74506. /**
  74507. * Disables highlights
  74508. */
  74509. disableHighlights(): void;
  74510. /**
  74511. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  74512. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  74513. */
  74514. dispose(disableDepthRender?: boolean): void;
  74515. private _createChromaticAberrationPostProcess;
  74516. private _createHighlightsPostProcess;
  74517. private _createDepthOfFieldPostProcess;
  74518. private _createGrainTexture;
  74519. }
  74520. }
  74521. declare module "babylonjs/Shaders/ssao2.fragment" {
  74522. /** @hidden */
  74523. export var ssao2PixelShader: {
  74524. name: string;
  74525. shader: string;
  74526. };
  74527. }
  74528. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  74529. /** @hidden */
  74530. export var ssaoCombinePixelShader: {
  74531. name: string;
  74532. shader: string;
  74533. };
  74534. }
  74535. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  74536. import { Camera } from "babylonjs/Cameras/camera";
  74537. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74538. import { Scene } from "babylonjs/scene";
  74539. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74540. import "babylonjs/Shaders/ssao2.fragment";
  74541. import "babylonjs/Shaders/ssaoCombine.fragment";
  74542. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74543. /**
  74544. * Render pipeline to produce ssao effect
  74545. */
  74546. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  74547. /**
  74548. * @ignore
  74549. * The PassPostProcess id in the pipeline that contains the original scene color
  74550. */
  74551. SSAOOriginalSceneColorEffect: string;
  74552. /**
  74553. * @ignore
  74554. * The SSAO PostProcess id in the pipeline
  74555. */
  74556. SSAORenderEffect: string;
  74557. /**
  74558. * @ignore
  74559. * The horizontal blur PostProcess id in the pipeline
  74560. */
  74561. SSAOBlurHRenderEffect: string;
  74562. /**
  74563. * @ignore
  74564. * The vertical blur PostProcess id in the pipeline
  74565. */
  74566. SSAOBlurVRenderEffect: string;
  74567. /**
  74568. * @ignore
  74569. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74570. */
  74571. SSAOCombineRenderEffect: string;
  74572. /**
  74573. * The output strength of the SSAO post-process. Default value is 1.0.
  74574. */
  74575. totalStrength: number;
  74576. /**
  74577. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  74578. */
  74579. maxZ: number;
  74580. /**
  74581. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  74582. */
  74583. minZAspect: number;
  74584. private _samples;
  74585. /**
  74586. * Number of samples used for the SSAO calculations. Default value is 8
  74587. */
  74588. set samples(n: number);
  74589. get samples(): number;
  74590. private _textureSamples;
  74591. /**
  74592. * Number of samples to use for antialiasing
  74593. */
  74594. set textureSamples(n: number);
  74595. get textureSamples(): number;
  74596. /**
  74597. * Force rendering the geometry through geometry buffer
  74598. */
  74599. private _forceGeometryBuffer;
  74600. /**
  74601. * Ratio object used for SSAO ratio and blur ratio
  74602. */
  74603. private _ratio;
  74604. /**
  74605. * Dynamically generated sphere sampler.
  74606. */
  74607. private _sampleSphere;
  74608. /**
  74609. * Blur filter offsets
  74610. */
  74611. private _samplerOffsets;
  74612. private _expensiveBlur;
  74613. /**
  74614. * If bilateral blur should be used
  74615. */
  74616. set expensiveBlur(b: boolean);
  74617. get expensiveBlur(): boolean;
  74618. /**
  74619. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  74620. */
  74621. radius: number;
  74622. /**
  74623. * The base color of the SSAO post-process
  74624. * The final result is "base + ssao" between [0, 1]
  74625. */
  74626. base: number;
  74627. /**
  74628. * Support test.
  74629. */
  74630. static get IsSupported(): boolean;
  74631. private _scene;
  74632. private _randomTexture;
  74633. private _originalColorPostProcess;
  74634. private _ssaoPostProcess;
  74635. private _blurHPostProcess;
  74636. private _blurVPostProcess;
  74637. private _ssaoCombinePostProcess;
  74638. private _prePassRenderer;
  74639. /**
  74640. * Gets active scene
  74641. */
  74642. get scene(): Scene;
  74643. /**
  74644. * @constructor
  74645. * @param name The rendering pipeline name
  74646. * @param scene The scene linked to this pipeline
  74647. * @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 }
  74648. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74649. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  74650. */
  74651. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  74652. /**
  74653. * Get the class name
  74654. * @returns "SSAO2RenderingPipeline"
  74655. */
  74656. getClassName(): string;
  74657. /**
  74658. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74659. */
  74660. dispose(disableGeometryBufferRenderer?: boolean): void;
  74661. private _createBlurPostProcess;
  74662. /** @hidden */
  74663. _rebuild(): void;
  74664. private _bits;
  74665. private _radicalInverse_VdC;
  74666. private _hammersley;
  74667. private _hemisphereSample_uniform;
  74668. private _generateHemisphere;
  74669. private _getDefinesForSSAO;
  74670. private _createSSAOPostProcess;
  74671. private _createSSAOCombinePostProcess;
  74672. private _createRandomTexture;
  74673. /**
  74674. * Serialize the rendering pipeline (Used when exporting)
  74675. * @returns the serialized object
  74676. */
  74677. serialize(): any;
  74678. /**
  74679. * Parse the serialized pipeline
  74680. * @param source Source pipeline.
  74681. * @param scene The scene to load the pipeline to.
  74682. * @param rootUrl The URL of the serialized pipeline.
  74683. * @returns An instantiated pipeline from the serialized object.
  74684. */
  74685. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  74686. /**
  74687. * Sets the required values to the prepass renderer.
  74688. * @param prePassRenderer defines the prepass renderer to setup
  74689. * @returns true if the pre pass is needed.
  74690. */
  74691. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74692. }
  74693. }
  74694. declare module "babylonjs/Shaders/ssao.fragment" {
  74695. /** @hidden */
  74696. export var ssaoPixelShader: {
  74697. name: string;
  74698. shader: string;
  74699. };
  74700. }
  74701. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  74702. import { Camera } from "babylonjs/Cameras/camera";
  74703. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74704. import { Scene } from "babylonjs/scene";
  74705. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74706. import "babylonjs/Shaders/ssao.fragment";
  74707. import "babylonjs/Shaders/ssaoCombine.fragment";
  74708. /**
  74709. * Render pipeline to produce ssao effect
  74710. */
  74711. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  74712. /**
  74713. * @ignore
  74714. * The PassPostProcess id in the pipeline that contains the original scene color
  74715. */
  74716. SSAOOriginalSceneColorEffect: string;
  74717. /**
  74718. * @ignore
  74719. * The SSAO PostProcess id in the pipeline
  74720. */
  74721. SSAORenderEffect: string;
  74722. /**
  74723. * @ignore
  74724. * The horizontal blur PostProcess id in the pipeline
  74725. */
  74726. SSAOBlurHRenderEffect: string;
  74727. /**
  74728. * @ignore
  74729. * The vertical blur PostProcess id in the pipeline
  74730. */
  74731. SSAOBlurVRenderEffect: string;
  74732. /**
  74733. * @ignore
  74734. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74735. */
  74736. SSAOCombineRenderEffect: string;
  74737. /**
  74738. * The output strength of the SSAO post-process. Default value is 1.0.
  74739. */
  74740. totalStrength: number;
  74741. /**
  74742. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  74743. */
  74744. radius: number;
  74745. /**
  74746. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  74747. * Must not be equal to fallOff and superior to fallOff.
  74748. * Default value is 0.0075
  74749. */
  74750. area: number;
  74751. /**
  74752. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  74753. * Must not be equal to area and inferior to area.
  74754. * Default value is 0.000001
  74755. */
  74756. fallOff: number;
  74757. /**
  74758. * The base color of the SSAO post-process
  74759. * The final result is "base + ssao" between [0, 1]
  74760. */
  74761. base: number;
  74762. private _scene;
  74763. private _depthTexture;
  74764. private _randomTexture;
  74765. private _originalColorPostProcess;
  74766. private _ssaoPostProcess;
  74767. private _blurHPostProcess;
  74768. private _blurVPostProcess;
  74769. private _ssaoCombinePostProcess;
  74770. private _firstUpdate;
  74771. /**
  74772. * Gets active scene
  74773. */
  74774. get scene(): Scene;
  74775. /**
  74776. * @constructor
  74777. * @param name - The rendering pipeline name
  74778. * @param scene - The scene linked to this pipeline
  74779. * @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 }
  74780. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  74781. */
  74782. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  74783. /**
  74784. * Get the class name
  74785. * @returns "SSAORenderingPipeline"
  74786. */
  74787. getClassName(): string;
  74788. /**
  74789. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74790. */
  74791. dispose(disableDepthRender?: boolean): void;
  74792. private _createBlurPostProcess;
  74793. /** @hidden */
  74794. _rebuild(): void;
  74795. private _createSSAOPostProcess;
  74796. private _createSSAOCombinePostProcess;
  74797. private _createRandomTexture;
  74798. }
  74799. }
  74800. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  74801. /** @hidden */
  74802. export var screenSpaceReflectionPixelShader: {
  74803. name: string;
  74804. shader: string;
  74805. };
  74806. }
  74807. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  74808. import { Nullable } from "babylonjs/types";
  74809. import { Camera } from "babylonjs/Cameras/camera";
  74810. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74811. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  74812. import { Engine } from "babylonjs/Engines/engine";
  74813. import { Scene } from "babylonjs/scene";
  74814. /**
  74815. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  74816. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  74817. */
  74818. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  74819. /**
  74820. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  74821. */
  74822. threshold: number;
  74823. /**
  74824. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  74825. */
  74826. strength: number;
  74827. /**
  74828. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  74829. */
  74830. reflectionSpecularFalloffExponent: number;
  74831. /**
  74832. * 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]
  74833. */
  74834. step: number;
  74835. /**
  74836. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  74837. */
  74838. roughnessFactor: number;
  74839. private _geometryBufferRenderer;
  74840. private _enableSmoothReflections;
  74841. private _reflectionSamples;
  74842. private _smoothSteps;
  74843. /**
  74844. * Gets a string identifying the name of the class
  74845. * @returns "ScreenSpaceReflectionPostProcess" string
  74846. */
  74847. getClassName(): string;
  74848. /**
  74849. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  74850. * @param name The name of the effect.
  74851. * @param scene The scene containing the objects to calculate reflections.
  74852. * @param options The required width/height ratio to downsize to before computing the render pass.
  74853. * @param camera The camera to apply the render pass to.
  74854. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74855. * @param engine The engine which the post process will be applied. (default: current engine)
  74856. * @param reusable If the post process can be reused on the same frame. (default: false)
  74857. * @param textureType Type of textures used when performing the post process. (default: 0)
  74858. * @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)
  74859. */
  74860. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74861. /**
  74862. * Gets wether or not smoothing reflections is enabled.
  74863. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74864. */
  74865. get enableSmoothReflections(): boolean;
  74866. /**
  74867. * Sets wether or not smoothing reflections is enabled.
  74868. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74869. */
  74870. set enableSmoothReflections(enabled: boolean);
  74871. /**
  74872. * Gets the number of samples taken while computing reflections. More samples count is high,
  74873. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74874. */
  74875. get reflectionSamples(): number;
  74876. /**
  74877. * Sets the number of samples taken while computing reflections. More samples count is high,
  74878. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74879. */
  74880. set reflectionSamples(samples: number);
  74881. /**
  74882. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  74883. * more the post-process will require GPU power and can generate a drop in FPS.
  74884. * Default value (5.0) work pretty well in all cases but can be adjusted.
  74885. */
  74886. get smoothSteps(): number;
  74887. set smoothSteps(steps: number);
  74888. private _updateEffectDefines;
  74889. /** @hidden */
  74890. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  74891. }
  74892. }
  74893. declare module "babylonjs/Shaders/standard.fragment" {
  74894. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  74895. /** @hidden */
  74896. export var standardPixelShader: {
  74897. name: string;
  74898. shader: string;
  74899. };
  74900. }
  74901. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  74902. import { Nullable } from "babylonjs/types";
  74903. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74904. import { Camera } from "babylonjs/Cameras/camera";
  74905. import { Texture } from "babylonjs/Materials/Textures/texture";
  74906. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74907. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74908. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  74909. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74910. import { IDisposable } from "babylonjs/scene";
  74911. import { SpotLight } from "babylonjs/Lights/spotLight";
  74912. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  74913. import { Scene } from "babylonjs/scene";
  74914. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  74915. import { Animation } from "babylonjs/Animations/animation";
  74916. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74917. import "babylonjs/Shaders/standard.fragment";
  74918. /**
  74919. * Standard rendering pipeline
  74920. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  74921. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  74922. */
  74923. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74924. /**
  74925. * Public members
  74926. */
  74927. /**
  74928. * Post-process which contains the original scene color before the pipeline applies all the effects
  74929. */
  74930. originalPostProcess: Nullable<PostProcess>;
  74931. /**
  74932. * Post-process used to down scale an image x4
  74933. */
  74934. downSampleX4PostProcess: Nullable<PostProcess>;
  74935. /**
  74936. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  74937. */
  74938. brightPassPostProcess: Nullable<PostProcess>;
  74939. /**
  74940. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  74941. */
  74942. blurHPostProcesses: PostProcess[];
  74943. /**
  74944. * Post-process array storing all the vertical blur post-processes used by the pipeline
  74945. */
  74946. blurVPostProcesses: PostProcess[];
  74947. /**
  74948. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  74949. */
  74950. textureAdderPostProcess: Nullable<PostProcess>;
  74951. /**
  74952. * Post-process used to create volumetric lighting effect
  74953. */
  74954. volumetricLightPostProcess: Nullable<PostProcess>;
  74955. /**
  74956. * Post-process used to smooth the previous volumetric light post-process on the X axis
  74957. */
  74958. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  74959. /**
  74960. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  74961. */
  74962. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  74963. /**
  74964. * Post-process used to merge the volumetric light effect and the real scene color
  74965. */
  74966. volumetricLightMergePostProces: Nullable<PostProcess>;
  74967. /**
  74968. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  74969. */
  74970. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  74971. /**
  74972. * Base post-process used to calculate the average luminance of the final image for HDR
  74973. */
  74974. luminancePostProcess: Nullable<PostProcess>;
  74975. /**
  74976. * Post-processes used to create down sample post-processes in order to get
  74977. * the average luminance of the final image for HDR
  74978. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  74979. */
  74980. luminanceDownSamplePostProcesses: PostProcess[];
  74981. /**
  74982. * Post-process used to create a HDR effect (light adaptation)
  74983. */
  74984. hdrPostProcess: Nullable<PostProcess>;
  74985. /**
  74986. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  74987. */
  74988. textureAdderFinalPostProcess: Nullable<PostProcess>;
  74989. /**
  74990. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  74991. */
  74992. lensFlareFinalPostProcess: Nullable<PostProcess>;
  74993. /**
  74994. * Post-process used to merge the final HDR post-process and the real scene color
  74995. */
  74996. hdrFinalPostProcess: Nullable<PostProcess>;
  74997. /**
  74998. * Post-process used to create a lens flare effect
  74999. */
  75000. lensFlarePostProcess: Nullable<PostProcess>;
  75001. /**
  75002. * Post-process that merges the result of the lens flare post-process and the real scene color
  75003. */
  75004. lensFlareComposePostProcess: Nullable<PostProcess>;
  75005. /**
  75006. * Post-process used to create a motion blur effect
  75007. */
  75008. motionBlurPostProcess: Nullable<PostProcess>;
  75009. /**
  75010. * Post-process used to create a depth of field effect
  75011. */
  75012. depthOfFieldPostProcess: Nullable<PostProcess>;
  75013. /**
  75014. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  75015. */
  75016. fxaaPostProcess: Nullable<FxaaPostProcess>;
  75017. /**
  75018. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  75019. */
  75020. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  75021. /**
  75022. * Represents the brightness threshold in order to configure the illuminated surfaces
  75023. */
  75024. brightThreshold: number;
  75025. /**
  75026. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  75027. */
  75028. blurWidth: number;
  75029. /**
  75030. * Sets if the blur for highlighted surfaces must be only horizontal
  75031. */
  75032. horizontalBlur: boolean;
  75033. /**
  75034. * Gets the overall exposure used by the pipeline
  75035. */
  75036. get exposure(): number;
  75037. /**
  75038. * Sets the overall exposure used by the pipeline
  75039. */
  75040. set exposure(value: number);
  75041. /**
  75042. * Texture used typically to simulate "dirty" on camera lens
  75043. */
  75044. lensTexture: Nullable<Texture>;
  75045. /**
  75046. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  75047. */
  75048. volumetricLightCoefficient: number;
  75049. /**
  75050. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  75051. */
  75052. volumetricLightPower: number;
  75053. /**
  75054. * Used the set the blur intensity to smooth the volumetric lights
  75055. */
  75056. volumetricLightBlurScale: number;
  75057. /**
  75058. * Light (spot or directional) used to generate the volumetric lights rays
  75059. * The source light must have a shadow generate so the pipeline can get its
  75060. * depth map
  75061. */
  75062. sourceLight: Nullable<SpotLight | DirectionalLight>;
  75063. /**
  75064. * For eye adaptation, represents the minimum luminance the eye can see
  75065. */
  75066. hdrMinimumLuminance: number;
  75067. /**
  75068. * For eye adaptation, represents the decrease luminance speed
  75069. */
  75070. hdrDecreaseRate: number;
  75071. /**
  75072. * For eye adaptation, represents the increase luminance speed
  75073. */
  75074. hdrIncreaseRate: number;
  75075. /**
  75076. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75077. */
  75078. get hdrAutoExposure(): boolean;
  75079. /**
  75080. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75081. */
  75082. set hdrAutoExposure(value: boolean);
  75083. /**
  75084. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  75085. */
  75086. lensColorTexture: Nullable<Texture>;
  75087. /**
  75088. * The overall strengh for the lens flare effect
  75089. */
  75090. lensFlareStrength: number;
  75091. /**
  75092. * Dispersion coefficient for lens flare ghosts
  75093. */
  75094. lensFlareGhostDispersal: number;
  75095. /**
  75096. * Main lens flare halo width
  75097. */
  75098. lensFlareHaloWidth: number;
  75099. /**
  75100. * Based on the lens distortion effect, defines how much the lens flare result
  75101. * is distorted
  75102. */
  75103. lensFlareDistortionStrength: number;
  75104. /**
  75105. * Configures the blur intensity used for for lens flare (halo)
  75106. */
  75107. lensFlareBlurWidth: number;
  75108. /**
  75109. * Lens star texture must be used to simulate rays on the flares and is available
  75110. * in the documentation
  75111. */
  75112. lensStarTexture: Nullable<Texture>;
  75113. /**
  75114. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  75115. * flare effect by taking account of the dirt texture
  75116. */
  75117. lensFlareDirtTexture: Nullable<Texture>;
  75118. /**
  75119. * Represents the focal length for the depth of field effect
  75120. */
  75121. depthOfFieldDistance: number;
  75122. /**
  75123. * Represents the blur intensity for the blurred part of the depth of field effect
  75124. */
  75125. depthOfFieldBlurWidth: number;
  75126. /**
  75127. * Gets how much the image is blurred by the movement while using the motion blur post-process
  75128. */
  75129. get motionStrength(): number;
  75130. /**
  75131. * Sets how much the image is blurred by the movement while using the motion blur post-process
  75132. */
  75133. set motionStrength(strength: number);
  75134. /**
  75135. * Gets wether or not the motion blur post-process is object based or screen based.
  75136. */
  75137. get objectBasedMotionBlur(): boolean;
  75138. /**
  75139. * Sets wether or not the motion blur post-process should be object based or screen based
  75140. */
  75141. set objectBasedMotionBlur(value: boolean);
  75142. /**
  75143. * List of animations for the pipeline (IAnimatable implementation)
  75144. */
  75145. animations: Animation[];
  75146. /**
  75147. * Private members
  75148. */
  75149. private _scene;
  75150. private _currentDepthOfFieldSource;
  75151. private _basePostProcess;
  75152. private _fixedExposure;
  75153. private _currentExposure;
  75154. private _hdrAutoExposure;
  75155. private _hdrCurrentLuminance;
  75156. private _motionStrength;
  75157. private _isObjectBasedMotionBlur;
  75158. private _floatTextureType;
  75159. private _camerasToBeAttached;
  75160. private _ratio;
  75161. private _bloomEnabled;
  75162. private _depthOfFieldEnabled;
  75163. private _vlsEnabled;
  75164. private _lensFlareEnabled;
  75165. private _hdrEnabled;
  75166. private _motionBlurEnabled;
  75167. private _fxaaEnabled;
  75168. private _screenSpaceReflectionsEnabled;
  75169. private _motionBlurSamples;
  75170. private _volumetricLightStepsCount;
  75171. private _samples;
  75172. /**
  75173. * @ignore
  75174. * Specifies if the bloom pipeline is enabled
  75175. */
  75176. get BloomEnabled(): boolean;
  75177. set BloomEnabled(enabled: boolean);
  75178. /**
  75179. * @ignore
  75180. * Specifies if the depth of field pipeline is enabed
  75181. */
  75182. get DepthOfFieldEnabled(): boolean;
  75183. set DepthOfFieldEnabled(enabled: boolean);
  75184. /**
  75185. * @ignore
  75186. * Specifies if the lens flare pipeline is enabed
  75187. */
  75188. get LensFlareEnabled(): boolean;
  75189. set LensFlareEnabled(enabled: boolean);
  75190. /**
  75191. * @ignore
  75192. * Specifies if the HDR pipeline is enabled
  75193. */
  75194. get HDREnabled(): boolean;
  75195. set HDREnabled(enabled: boolean);
  75196. /**
  75197. * @ignore
  75198. * Specifies if the volumetric lights scattering effect is enabled
  75199. */
  75200. get VLSEnabled(): boolean;
  75201. set VLSEnabled(enabled: boolean);
  75202. /**
  75203. * @ignore
  75204. * Specifies if the motion blur effect is enabled
  75205. */
  75206. get MotionBlurEnabled(): boolean;
  75207. set MotionBlurEnabled(enabled: boolean);
  75208. /**
  75209. * Specifies if anti-aliasing is enabled
  75210. */
  75211. get fxaaEnabled(): boolean;
  75212. set fxaaEnabled(enabled: boolean);
  75213. /**
  75214. * Specifies if screen space reflections are enabled.
  75215. */
  75216. get screenSpaceReflectionsEnabled(): boolean;
  75217. set screenSpaceReflectionsEnabled(enabled: boolean);
  75218. /**
  75219. * Specifies the number of steps used to calculate the volumetric lights
  75220. * Typically in interval [50, 200]
  75221. */
  75222. get volumetricLightStepsCount(): number;
  75223. set volumetricLightStepsCount(count: number);
  75224. /**
  75225. * Specifies the number of samples used for the motion blur effect
  75226. * Typically in interval [16, 64]
  75227. */
  75228. get motionBlurSamples(): number;
  75229. set motionBlurSamples(samples: number);
  75230. /**
  75231. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  75232. */
  75233. get samples(): number;
  75234. set samples(sampleCount: number);
  75235. /**
  75236. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75237. * @constructor
  75238. * @param name The rendering pipeline name
  75239. * @param scene The scene linked to this pipeline
  75240. * @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)
  75241. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  75242. * @param cameras The array of cameras that the rendering pipeline will be attached to
  75243. */
  75244. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  75245. private _buildPipeline;
  75246. private _createDownSampleX4PostProcess;
  75247. private _createBrightPassPostProcess;
  75248. private _createBlurPostProcesses;
  75249. private _createTextureAdderPostProcess;
  75250. private _createVolumetricLightPostProcess;
  75251. private _createLuminancePostProcesses;
  75252. private _createHdrPostProcess;
  75253. private _createLensFlarePostProcess;
  75254. private _createDepthOfFieldPostProcess;
  75255. private _createMotionBlurPostProcess;
  75256. private _getDepthTexture;
  75257. private _disposePostProcesses;
  75258. /**
  75259. * Dispose of the pipeline and stop all post processes
  75260. */
  75261. dispose(): void;
  75262. /**
  75263. * Serialize the rendering pipeline (Used when exporting)
  75264. * @returns the serialized object
  75265. */
  75266. serialize(): any;
  75267. /**
  75268. * Parse the serialized pipeline
  75269. * @param source Source pipeline.
  75270. * @param scene The scene to load the pipeline to.
  75271. * @param rootUrl The URL of the serialized pipeline.
  75272. * @returns An instantiated pipeline from the serialized object.
  75273. */
  75274. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  75275. /**
  75276. * Luminance steps
  75277. */
  75278. static LuminanceSteps: number;
  75279. }
  75280. }
  75281. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  75282. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  75283. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  75284. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  75285. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  75286. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  75287. }
  75288. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  75289. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  75290. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  75291. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75292. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  75293. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75294. }
  75295. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  75296. /** @hidden */
  75297. export var stereoscopicInterlacePixelShader: {
  75298. name: string;
  75299. shader: string;
  75300. };
  75301. }
  75302. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  75303. import { Camera } from "babylonjs/Cameras/camera";
  75304. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75305. import { Engine } from "babylonjs/Engines/engine";
  75306. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  75307. /**
  75308. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  75309. */
  75310. export class StereoscopicInterlacePostProcessI extends PostProcess {
  75311. private _stepSize;
  75312. private _passedProcess;
  75313. /**
  75314. * Gets a string identifying the name of the class
  75315. * @returns "StereoscopicInterlacePostProcessI" string
  75316. */
  75317. getClassName(): string;
  75318. /**
  75319. * Initializes a StereoscopicInterlacePostProcessI
  75320. * @param name The name of the effect.
  75321. * @param rigCameras The rig cameras to be appled to the post process
  75322. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  75323. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  75324. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75325. * @param engine The engine which the post process will be applied. (default: current engine)
  75326. * @param reusable If the post process can be reused on the same frame. (default: false)
  75327. */
  75328. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75329. }
  75330. /**
  75331. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  75332. */
  75333. export class StereoscopicInterlacePostProcess extends PostProcess {
  75334. private _stepSize;
  75335. private _passedProcess;
  75336. /**
  75337. * Gets a string identifying the name of the class
  75338. * @returns "StereoscopicInterlacePostProcess" string
  75339. */
  75340. getClassName(): string;
  75341. /**
  75342. * Initializes a StereoscopicInterlacePostProcess
  75343. * @param name The name of the effect.
  75344. * @param rigCameras The rig cameras to be appled to the post process
  75345. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  75346. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75347. * @param engine The engine which the post process will be applied. (default: current engine)
  75348. * @param reusable If the post process can be reused on the same frame. (default: false)
  75349. */
  75350. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75351. }
  75352. }
  75353. declare module "babylonjs/Shaders/tonemap.fragment" {
  75354. /** @hidden */
  75355. export var tonemapPixelShader: {
  75356. name: string;
  75357. shader: string;
  75358. };
  75359. }
  75360. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  75361. import { Camera } from "babylonjs/Cameras/camera";
  75362. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75363. import "babylonjs/Shaders/tonemap.fragment";
  75364. import { Engine } from "babylonjs/Engines/engine";
  75365. /** Defines operator used for tonemapping */
  75366. export enum TonemappingOperator {
  75367. /** Hable */
  75368. Hable = 0,
  75369. /** Reinhard */
  75370. Reinhard = 1,
  75371. /** HejiDawson */
  75372. HejiDawson = 2,
  75373. /** Photographic */
  75374. Photographic = 3
  75375. }
  75376. /**
  75377. * Defines a post process to apply tone mapping
  75378. */
  75379. export class TonemapPostProcess extends PostProcess {
  75380. private _operator;
  75381. /** Defines the required exposure adjustement */
  75382. exposureAdjustment: number;
  75383. /**
  75384. * Gets a string identifying the name of the class
  75385. * @returns "TonemapPostProcess" string
  75386. */
  75387. getClassName(): string;
  75388. /**
  75389. * Creates a new TonemapPostProcess
  75390. * @param name defines the name of the postprocess
  75391. * @param _operator defines the operator to use
  75392. * @param exposureAdjustment defines the required exposure adjustement
  75393. * @param camera defines the camera to use (can be null)
  75394. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  75395. * @param engine defines the hosting engine (can be ignore if camera is set)
  75396. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  75397. */
  75398. constructor(name: string, _operator: TonemappingOperator,
  75399. /** Defines the required exposure adjustement */
  75400. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  75401. }
  75402. }
  75403. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  75404. /** @hidden */
  75405. export var volumetricLightScatteringPixelShader: {
  75406. name: string;
  75407. shader: string;
  75408. };
  75409. }
  75410. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  75411. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75412. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75413. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75414. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75415. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75416. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75417. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75418. /** @hidden */
  75419. export var volumetricLightScatteringPassVertexShader: {
  75420. name: string;
  75421. shader: string;
  75422. };
  75423. }
  75424. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  75425. /** @hidden */
  75426. export var volumetricLightScatteringPassPixelShader: {
  75427. name: string;
  75428. shader: string;
  75429. };
  75430. }
  75431. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  75432. import { Vector3 } from "babylonjs/Maths/math.vector";
  75433. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75434. import { Mesh } from "babylonjs/Meshes/mesh";
  75435. import { Camera } from "babylonjs/Cameras/camera";
  75436. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  75437. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75438. import { Scene } from "babylonjs/scene";
  75439. import "babylonjs/Meshes/Builders/planeBuilder";
  75440. import "babylonjs/Shaders/depth.vertex";
  75441. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  75442. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  75443. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  75444. import { Engine } from "babylonjs/Engines/engine";
  75445. /**
  75446. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  75447. */
  75448. export class VolumetricLightScatteringPostProcess extends PostProcess {
  75449. private _volumetricLightScatteringPass;
  75450. private _volumetricLightScatteringRTT;
  75451. private _viewPort;
  75452. private _screenCoordinates;
  75453. private _cachedDefines;
  75454. /**
  75455. * If not undefined, the mesh position is computed from the attached node position
  75456. */
  75457. attachedNode: {
  75458. position: Vector3;
  75459. };
  75460. /**
  75461. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  75462. */
  75463. customMeshPosition: Vector3;
  75464. /**
  75465. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  75466. */
  75467. useCustomMeshPosition: boolean;
  75468. /**
  75469. * If the post-process should inverse the light scattering direction
  75470. */
  75471. invert: boolean;
  75472. /**
  75473. * The internal mesh used by the post-process
  75474. */
  75475. mesh: Mesh;
  75476. /**
  75477. * @hidden
  75478. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  75479. */
  75480. get useDiffuseColor(): boolean;
  75481. set useDiffuseColor(useDiffuseColor: boolean);
  75482. /**
  75483. * Array containing the excluded meshes not rendered in the internal pass
  75484. */
  75485. excludedMeshes: AbstractMesh[];
  75486. /**
  75487. * Controls the overall intensity of the post-process
  75488. */
  75489. exposure: number;
  75490. /**
  75491. * Dissipates each sample's contribution in range [0, 1]
  75492. */
  75493. decay: number;
  75494. /**
  75495. * Controls the overall intensity of each sample
  75496. */
  75497. weight: number;
  75498. /**
  75499. * Controls the density of each sample
  75500. */
  75501. density: number;
  75502. /**
  75503. * @constructor
  75504. * @param name The post-process name
  75505. * @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)
  75506. * @param camera The camera that the post-process will be attached to
  75507. * @param mesh The mesh used to create the light scattering
  75508. * @param samples The post-process quality, default 100
  75509. * @param samplingModeThe post-process filtering mode
  75510. * @param engine The babylon engine
  75511. * @param reusable If the post-process is reusable
  75512. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  75513. */
  75514. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  75515. /**
  75516. * Returns the string "VolumetricLightScatteringPostProcess"
  75517. * @returns "VolumetricLightScatteringPostProcess"
  75518. */
  75519. getClassName(): string;
  75520. private _isReady;
  75521. /**
  75522. * Sets the new light position for light scattering effect
  75523. * @param position The new custom light position
  75524. */
  75525. setCustomMeshPosition(position: Vector3): void;
  75526. /**
  75527. * Returns the light position for light scattering effect
  75528. * @return Vector3 The custom light position
  75529. */
  75530. getCustomMeshPosition(): Vector3;
  75531. /**
  75532. * Disposes the internal assets and detaches the post-process from the camera
  75533. */
  75534. dispose(camera: Camera): void;
  75535. /**
  75536. * Returns the render target texture used by the post-process
  75537. * @return the render target texture used by the post-process
  75538. */
  75539. getPass(): RenderTargetTexture;
  75540. private _meshExcluded;
  75541. private _createPass;
  75542. private _updateMeshScreenCoordinates;
  75543. /**
  75544. * Creates a default mesh for the Volumeric Light Scattering post-process
  75545. * @param name The mesh name
  75546. * @param scene The scene where to create the mesh
  75547. * @return the default mesh
  75548. */
  75549. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  75550. }
  75551. }
  75552. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  75553. /** @hidden */
  75554. export var screenSpaceCurvaturePixelShader: {
  75555. name: string;
  75556. shader: string;
  75557. };
  75558. }
  75559. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  75560. import { Nullable } from "babylonjs/types";
  75561. import { Camera } from "babylonjs/Cameras/camera";
  75562. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75563. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75564. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  75565. import { Engine } from "babylonjs/Engines/engine";
  75566. import { Scene } from "babylonjs/scene";
  75567. /**
  75568. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  75569. */
  75570. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  75571. /**
  75572. * Defines how much ridge the curvature effect displays.
  75573. */
  75574. ridge: number;
  75575. /**
  75576. * Defines how much valley the curvature effect displays.
  75577. */
  75578. valley: number;
  75579. private _geometryBufferRenderer;
  75580. /**
  75581. * Gets a string identifying the name of the class
  75582. * @returns "ScreenSpaceCurvaturePostProcess" string
  75583. */
  75584. getClassName(): string;
  75585. /**
  75586. * Creates a new instance ScreenSpaceCurvaturePostProcess
  75587. * @param name The name of the effect.
  75588. * @param scene The scene containing the objects to blur according to their velocity.
  75589. * @param options The required width/height ratio to downsize to before computing the render pass.
  75590. * @param camera The camera to apply the render pass to.
  75591. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75592. * @param engine The engine which the post process will be applied. (default: current engine)
  75593. * @param reusable If the post process can be reused on the same frame. (default: false)
  75594. * @param textureType Type of textures used when performing the post process. (default: 0)
  75595. * @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)
  75596. */
  75597. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75598. /**
  75599. * Support test.
  75600. */
  75601. static get IsSupported(): boolean;
  75602. /** @hidden */
  75603. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  75604. }
  75605. }
  75606. declare module "babylonjs/PostProcesses/index" {
  75607. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  75608. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  75609. export * from "babylonjs/PostProcesses/bloomEffect";
  75610. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  75611. export * from "babylonjs/PostProcesses/blurPostProcess";
  75612. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  75613. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  75614. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  75615. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  75616. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  75617. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  75618. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  75619. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  75620. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  75621. export * from "babylonjs/PostProcesses/filterPostProcess";
  75622. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  75623. export * from "babylonjs/PostProcesses/grainPostProcess";
  75624. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  75625. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  75626. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  75627. export * from "babylonjs/PostProcesses/passPostProcess";
  75628. export * from "babylonjs/PostProcesses/postProcess";
  75629. export * from "babylonjs/PostProcesses/postProcessManager";
  75630. export * from "babylonjs/PostProcesses/refractionPostProcess";
  75631. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  75632. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  75633. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  75634. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  75635. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  75636. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  75637. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  75638. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75639. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  75640. }
  75641. declare module "babylonjs/Probes/index" {
  75642. export * from "babylonjs/Probes/reflectionProbe";
  75643. }
  75644. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  75645. import { Scene } from "babylonjs/scene";
  75646. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75647. import { SmartArray } from "babylonjs/Misc/smartArray";
  75648. import { ISceneComponent } from "babylonjs/sceneComponent";
  75649. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  75650. import "babylonjs/Meshes/Builders/boxBuilder";
  75651. import "babylonjs/Shaders/color.fragment";
  75652. import "babylonjs/Shaders/color.vertex";
  75653. import { Color3 } from "babylonjs/Maths/math.color";
  75654. import { Observable } from "babylonjs/Misc/observable";
  75655. module "babylonjs/scene" {
  75656. interface Scene {
  75657. /** @hidden (Backing field) */
  75658. _boundingBoxRenderer: BoundingBoxRenderer;
  75659. /** @hidden (Backing field) */
  75660. _forceShowBoundingBoxes: boolean;
  75661. /**
  75662. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  75663. */
  75664. forceShowBoundingBoxes: boolean;
  75665. /**
  75666. * Gets the bounding box renderer associated with the scene
  75667. * @returns a BoundingBoxRenderer
  75668. */
  75669. getBoundingBoxRenderer(): BoundingBoxRenderer;
  75670. }
  75671. }
  75672. module "babylonjs/Meshes/abstractMesh" {
  75673. interface AbstractMesh {
  75674. /** @hidden (Backing field) */
  75675. _showBoundingBox: boolean;
  75676. /**
  75677. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  75678. */
  75679. showBoundingBox: boolean;
  75680. }
  75681. }
  75682. /**
  75683. * Component responsible of rendering the bounding box of the meshes in a scene.
  75684. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  75685. */
  75686. export class BoundingBoxRenderer implements ISceneComponent {
  75687. /**
  75688. * The component name helpfull to identify the component in the list of scene components.
  75689. */
  75690. readonly name: string;
  75691. /**
  75692. * The scene the component belongs to.
  75693. */
  75694. scene: Scene;
  75695. /**
  75696. * Color of the bounding box lines placed in front of an object
  75697. */
  75698. frontColor: Color3;
  75699. /**
  75700. * Color of the bounding box lines placed behind an object
  75701. */
  75702. backColor: Color3;
  75703. /**
  75704. * Defines if the renderer should show the back lines or not
  75705. */
  75706. showBackLines: boolean;
  75707. /**
  75708. * Observable raised before rendering a bounding box
  75709. */
  75710. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  75711. /**
  75712. * Observable raised after rendering a bounding box
  75713. */
  75714. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  75715. /**
  75716. * @hidden
  75717. */
  75718. renderList: SmartArray<BoundingBox>;
  75719. private _colorShader;
  75720. private _vertexBuffers;
  75721. private _indexBuffer;
  75722. private _fillIndexBuffer;
  75723. private _fillIndexData;
  75724. /**
  75725. * Instantiates a new bounding box renderer in a scene.
  75726. * @param scene the scene the renderer renders in
  75727. */
  75728. constructor(scene: Scene);
  75729. /**
  75730. * Registers the component in a given scene
  75731. */
  75732. register(): void;
  75733. private _evaluateSubMesh;
  75734. private _activeMesh;
  75735. private _prepareRessources;
  75736. private _createIndexBuffer;
  75737. /**
  75738. * Rebuilds the elements related to this component in case of
  75739. * context lost for instance.
  75740. */
  75741. rebuild(): void;
  75742. /**
  75743. * @hidden
  75744. */
  75745. reset(): void;
  75746. /**
  75747. * Render the bounding boxes of a specific rendering group
  75748. * @param renderingGroupId defines the rendering group to render
  75749. */
  75750. render(renderingGroupId: number): void;
  75751. /**
  75752. * In case of occlusion queries, we can render the occlusion bounding box through this method
  75753. * @param mesh Define the mesh to render the occlusion bounding box for
  75754. */
  75755. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  75756. /**
  75757. * Dispose and release the resources attached to this renderer.
  75758. */
  75759. dispose(): void;
  75760. }
  75761. }
  75762. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  75763. import { Nullable } from "babylonjs/types";
  75764. import { Scene } from "babylonjs/scene";
  75765. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  75766. import { Camera } from "babylonjs/Cameras/camera";
  75767. import { ISceneComponent } from "babylonjs/sceneComponent";
  75768. module "babylonjs/scene" {
  75769. interface Scene {
  75770. /** @hidden (Backing field) */
  75771. _depthRenderer: {
  75772. [id: string]: DepthRenderer;
  75773. };
  75774. /**
  75775. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  75776. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  75777. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  75778. * @returns the created depth renderer
  75779. */
  75780. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  75781. /**
  75782. * Disables a depth renderer for a given camera
  75783. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  75784. */
  75785. disableDepthRenderer(camera?: Nullable<Camera>): void;
  75786. }
  75787. }
  75788. /**
  75789. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  75790. * in several rendering techniques.
  75791. */
  75792. export class DepthRendererSceneComponent implements ISceneComponent {
  75793. /**
  75794. * The component name helpfull to identify the component in the list of scene components.
  75795. */
  75796. readonly name: string;
  75797. /**
  75798. * The scene the component belongs to.
  75799. */
  75800. scene: Scene;
  75801. /**
  75802. * Creates a new instance of the component for the given scene
  75803. * @param scene Defines the scene to register the component in
  75804. */
  75805. constructor(scene: Scene);
  75806. /**
  75807. * Registers the component in a given scene
  75808. */
  75809. register(): void;
  75810. /**
  75811. * Rebuilds the elements related to this component in case of
  75812. * context lost for instance.
  75813. */
  75814. rebuild(): void;
  75815. /**
  75816. * Disposes the component and the associated ressources
  75817. */
  75818. dispose(): void;
  75819. private _gatherRenderTargets;
  75820. private _gatherActiveCameraRenderTargets;
  75821. }
  75822. }
  75823. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  75824. import { Nullable } from "babylonjs/types";
  75825. import { Scene } from "babylonjs/scene";
  75826. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  75827. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  75828. import { AbstractScene } from "babylonjs/abstractScene";
  75829. module "babylonjs/abstractScene" {
  75830. interface AbstractScene {
  75831. /** @hidden (Backing field) */
  75832. _prePassRenderer: Nullable<PrePassRenderer>;
  75833. /**
  75834. * Gets or Sets the current prepass renderer associated to the scene.
  75835. */
  75836. prePassRenderer: Nullable<PrePassRenderer>;
  75837. /**
  75838. * Enables the prepass and associates it with the scene
  75839. * @returns the PrePassRenderer
  75840. */
  75841. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  75842. /**
  75843. * Disables the prepass associated with the scene
  75844. */
  75845. disablePrePassRenderer(): void;
  75846. }
  75847. }
  75848. /**
  75849. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  75850. * in several rendering techniques.
  75851. */
  75852. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  75853. /**
  75854. * The component name helpful to identify the component in the list of scene components.
  75855. */
  75856. readonly name: string;
  75857. /**
  75858. * The scene the component belongs to.
  75859. */
  75860. scene: Scene;
  75861. /**
  75862. * Creates a new instance of the component for the given scene
  75863. * @param scene Defines the scene to register the component in
  75864. */
  75865. constructor(scene: Scene);
  75866. /**
  75867. * Registers the component in a given scene
  75868. */
  75869. register(): void;
  75870. private _beforeCameraDraw;
  75871. private _afterCameraDraw;
  75872. private _beforeClearStage;
  75873. /**
  75874. * Serializes the component data to the specified json object
  75875. * @param serializationObject The object to serialize to
  75876. */
  75877. serialize(serializationObject: any): void;
  75878. /**
  75879. * Adds all the elements from the container to the scene
  75880. * @param container the container holding the elements
  75881. */
  75882. addFromContainer(container: AbstractScene): void;
  75883. /**
  75884. * Removes all the elements in the container from the scene
  75885. * @param container contains the elements to remove
  75886. * @param dispose if the removed element should be disposed (default: false)
  75887. */
  75888. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  75889. /**
  75890. * Rebuilds the elements related to this component in case of
  75891. * context lost for instance.
  75892. */
  75893. rebuild(): void;
  75894. /**
  75895. * Disposes the component and the associated ressources
  75896. */
  75897. dispose(): void;
  75898. }
  75899. }
  75900. declare module "babylonjs/Shaders/outline.fragment" {
  75901. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75902. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  75903. /** @hidden */
  75904. export var outlinePixelShader: {
  75905. name: string;
  75906. shader: string;
  75907. };
  75908. }
  75909. declare module "babylonjs/Shaders/outline.vertex" {
  75910. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75911. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75912. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75913. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75914. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75915. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75916. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75917. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75918. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  75919. /** @hidden */
  75920. export var outlineVertexShader: {
  75921. name: string;
  75922. shader: string;
  75923. };
  75924. }
  75925. declare module "babylonjs/Rendering/outlineRenderer" {
  75926. import { SubMesh } from "babylonjs/Meshes/subMesh";
  75927. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  75928. import { Scene } from "babylonjs/scene";
  75929. import { ISceneComponent } from "babylonjs/sceneComponent";
  75930. import "babylonjs/Shaders/outline.fragment";
  75931. import "babylonjs/Shaders/outline.vertex";
  75932. module "babylonjs/scene" {
  75933. interface Scene {
  75934. /** @hidden */
  75935. _outlineRenderer: OutlineRenderer;
  75936. /**
  75937. * Gets the outline renderer associated with the scene
  75938. * @returns a OutlineRenderer
  75939. */
  75940. getOutlineRenderer(): OutlineRenderer;
  75941. }
  75942. }
  75943. module "babylonjs/Meshes/abstractMesh" {
  75944. interface AbstractMesh {
  75945. /** @hidden (Backing field) */
  75946. _renderOutline: boolean;
  75947. /**
  75948. * Gets or sets a boolean indicating if the outline must be rendered as well
  75949. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  75950. */
  75951. renderOutline: boolean;
  75952. /** @hidden (Backing field) */
  75953. _renderOverlay: boolean;
  75954. /**
  75955. * Gets or sets a boolean indicating if the overlay must be rendered as well
  75956. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  75957. */
  75958. renderOverlay: boolean;
  75959. }
  75960. }
  75961. /**
  75962. * This class is responsible to draw bothe outline/overlay of meshes.
  75963. * It should not be used directly but through the available method on mesh.
  75964. */
  75965. export class OutlineRenderer implements ISceneComponent {
  75966. /**
  75967. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  75968. */
  75969. private static _StencilReference;
  75970. /**
  75971. * The name of the component. Each component must have a unique name.
  75972. */
  75973. name: string;
  75974. /**
  75975. * The scene the component belongs to.
  75976. */
  75977. scene: Scene;
  75978. /**
  75979. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  75980. */
  75981. zOffset: number;
  75982. private _engine;
  75983. private _effect;
  75984. private _cachedDefines;
  75985. private _savedDepthWrite;
  75986. /**
  75987. * Instantiates a new outline renderer. (There could be only one per scene).
  75988. * @param scene Defines the scene it belongs to
  75989. */
  75990. constructor(scene: Scene);
  75991. /**
  75992. * Register the component to one instance of a scene.
  75993. */
  75994. register(): void;
  75995. /**
  75996. * Rebuilds the elements related to this component in case of
  75997. * context lost for instance.
  75998. */
  75999. rebuild(): void;
  76000. /**
  76001. * Disposes the component and the associated ressources.
  76002. */
  76003. dispose(): void;
  76004. /**
  76005. * Renders the outline in the canvas.
  76006. * @param subMesh Defines the sumesh to render
  76007. * @param batch Defines the batch of meshes in case of instances
  76008. * @param useOverlay Defines if the rendering is for the overlay or the outline
  76009. */
  76010. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  76011. /**
  76012. * Returns whether or not the outline renderer is ready for a given submesh.
  76013. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  76014. * @param subMesh Defines the submesh to check readyness for
  76015. * @param useInstances Defines wheter wee are trying to render instances or not
  76016. * @returns true if ready otherwise false
  76017. */
  76018. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  76019. private _beforeRenderingMesh;
  76020. private _afterRenderingMesh;
  76021. }
  76022. }
  76023. declare module "babylonjs/Rendering/index" {
  76024. export * from "babylonjs/Rendering/boundingBoxRenderer";
  76025. export * from "babylonjs/Rendering/depthRenderer";
  76026. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  76027. export * from "babylonjs/Rendering/edgesRenderer";
  76028. export * from "babylonjs/Rendering/geometryBufferRenderer";
  76029. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  76030. export * from "babylonjs/Rendering/prePassRenderer";
  76031. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  76032. export * from "babylonjs/Rendering/outlineRenderer";
  76033. export * from "babylonjs/Rendering/renderingGroup";
  76034. export * from "babylonjs/Rendering/renderingManager";
  76035. export * from "babylonjs/Rendering/utilityLayerRenderer";
  76036. }
  76037. declare module "babylonjs/Sprites/ISprites" {
  76038. /**
  76039. * Defines the basic options interface of a Sprite Frame Source Size.
  76040. */
  76041. export interface ISpriteJSONSpriteSourceSize {
  76042. /**
  76043. * number of the original width of the Frame
  76044. */
  76045. w: number;
  76046. /**
  76047. * number of the original height of the Frame
  76048. */
  76049. h: number;
  76050. }
  76051. /**
  76052. * Defines the basic options interface of a Sprite Frame Data.
  76053. */
  76054. export interface ISpriteJSONSpriteFrameData {
  76055. /**
  76056. * number of the x offset of the Frame
  76057. */
  76058. x: number;
  76059. /**
  76060. * number of the y offset of the Frame
  76061. */
  76062. y: number;
  76063. /**
  76064. * number of the width of the Frame
  76065. */
  76066. w: number;
  76067. /**
  76068. * number of the height of the Frame
  76069. */
  76070. h: number;
  76071. }
  76072. /**
  76073. * Defines the basic options interface of a JSON Sprite.
  76074. */
  76075. export interface ISpriteJSONSprite {
  76076. /**
  76077. * string name of the Frame
  76078. */
  76079. filename: string;
  76080. /**
  76081. * ISpriteJSONSpriteFrame basic object of the frame data
  76082. */
  76083. frame: ISpriteJSONSpriteFrameData;
  76084. /**
  76085. * boolean to flag is the frame was rotated.
  76086. */
  76087. rotated: boolean;
  76088. /**
  76089. * boolean to flag is the frame was trimmed.
  76090. */
  76091. trimmed: boolean;
  76092. /**
  76093. * ISpriteJSONSpriteFrame basic object of the source data
  76094. */
  76095. spriteSourceSize: ISpriteJSONSpriteFrameData;
  76096. /**
  76097. * ISpriteJSONSpriteFrame basic object of the source data
  76098. */
  76099. sourceSize: ISpriteJSONSpriteSourceSize;
  76100. }
  76101. /**
  76102. * Defines the basic options interface of a JSON atlas.
  76103. */
  76104. export interface ISpriteJSONAtlas {
  76105. /**
  76106. * Array of objects that contain the frame data.
  76107. */
  76108. frames: Array<ISpriteJSONSprite>;
  76109. /**
  76110. * object basic object containing the sprite meta data.
  76111. */
  76112. meta?: object;
  76113. }
  76114. }
  76115. declare module "babylonjs/Shaders/spriteMap.fragment" {
  76116. /** @hidden */
  76117. export var spriteMapPixelShader: {
  76118. name: string;
  76119. shader: string;
  76120. };
  76121. }
  76122. declare module "babylonjs/Shaders/spriteMap.vertex" {
  76123. /** @hidden */
  76124. export var spriteMapVertexShader: {
  76125. name: string;
  76126. shader: string;
  76127. };
  76128. }
  76129. declare module "babylonjs/Sprites/spriteMap" {
  76130. import { IDisposable, Scene } from "babylonjs/scene";
  76131. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  76132. import { Texture } from "babylonjs/Materials/Textures/texture";
  76133. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  76134. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  76135. import "babylonjs/Meshes/Builders/planeBuilder";
  76136. import "babylonjs/Shaders/spriteMap.fragment";
  76137. import "babylonjs/Shaders/spriteMap.vertex";
  76138. /**
  76139. * Defines the basic options interface of a SpriteMap
  76140. */
  76141. export interface ISpriteMapOptions {
  76142. /**
  76143. * Vector2 of the number of cells in the grid.
  76144. */
  76145. stageSize?: Vector2;
  76146. /**
  76147. * Vector2 of the size of the output plane in World Units.
  76148. */
  76149. outputSize?: Vector2;
  76150. /**
  76151. * Vector3 of the position of the output plane in World Units.
  76152. */
  76153. outputPosition?: Vector3;
  76154. /**
  76155. * Vector3 of the rotation of the output plane.
  76156. */
  76157. outputRotation?: Vector3;
  76158. /**
  76159. * number of layers that the system will reserve in resources.
  76160. */
  76161. layerCount?: number;
  76162. /**
  76163. * number of max animation frames a single cell will reserve in resources.
  76164. */
  76165. maxAnimationFrames?: number;
  76166. /**
  76167. * number cell index of the base tile when the system compiles.
  76168. */
  76169. baseTile?: number;
  76170. /**
  76171. * boolean flip the sprite after its been repositioned by the framing data.
  76172. */
  76173. flipU?: boolean;
  76174. /**
  76175. * Vector3 scalar of the global RGB values of the SpriteMap.
  76176. */
  76177. colorMultiply?: Vector3;
  76178. }
  76179. /**
  76180. * Defines the IDisposable interface in order to be cleanable from resources.
  76181. */
  76182. export interface ISpriteMap extends IDisposable {
  76183. /**
  76184. * String name of the SpriteMap.
  76185. */
  76186. name: string;
  76187. /**
  76188. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  76189. */
  76190. atlasJSON: ISpriteJSONAtlas;
  76191. /**
  76192. * Texture of the SpriteMap.
  76193. */
  76194. spriteSheet: Texture;
  76195. /**
  76196. * The parameters to initialize the SpriteMap with.
  76197. */
  76198. options: ISpriteMapOptions;
  76199. }
  76200. /**
  76201. * Class used to manage a grid restricted sprite deployment on an Output plane.
  76202. */
  76203. export class SpriteMap implements ISpriteMap {
  76204. /** The Name of the spriteMap */
  76205. name: string;
  76206. /** The JSON file with the frame and meta data */
  76207. atlasJSON: ISpriteJSONAtlas;
  76208. /** The systems Sprite Sheet Texture */
  76209. spriteSheet: Texture;
  76210. /** Arguments passed with the Constructor */
  76211. options: ISpriteMapOptions;
  76212. /** Public Sprite Storage array, parsed from atlasJSON */
  76213. sprites: Array<ISpriteJSONSprite>;
  76214. /** Returns the Number of Sprites in the System */
  76215. get spriteCount(): number;
  76216. /** Returns the Position of Output Plane*/
  76217. get position(): Vector3;
  76218. /** Returns the Position of Output Plane*/
  76219. set position(v: Vector3);
  76220. /** Returns the Rotation of Output Plane*/
  76221. get rotation(): Vector3;
  76222. /** Returns the Rotation of Output Plane*/
  76223. set rotation(v: Vector3);
  76224. /** Sets the AnimationMap*/
  76225. get animationMap(): RawTexture;
  76226. /** Sets the AnimationMap*/
  76227. set animationMap(v: RawTexture);
  76228. /** Scene that the SpriteMap was created in */
  76229. private _scene;
  76230. /** Texture Buffer of Float32 that holds tile frame data*/
  76231. private _frameMap;
  76232. /** Texture Buffers of Float32 that holds tileMap data*/
  76233. private _tileMaps;
  76234. /** Texture Buffer of Float32 that holds Animation Data*/
  76235. private _animationMap;
  76236. /** Custom ShaderMaterial Central to the System*/
  76237. private _material;
  76238. /** Custom ShaderMaterial Central to the System*/
  76239. private _output;
  76240. /** Systems Time Ticker*/
  76241. private _time;
  76242. /**
  76243. * Creates a new SpriteMap
  76244. * @param name defines the SpriteMaps Name
  76245. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  76246. * @param spriteSheet is the Texture that the Sprites are on.
  76247. * @param options a basic deployment configuration
  76248. * @param scene The Scene that the map is deployed on
  76249. */
  76250. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  76251. /**
  76252. * Returns tileID location
  76253. * @returns Vector2 the cell position ID
  76254. */
  76255. getTileID(): Vector2;
  76256. /**
  76257. * Gets the UV location of the mouse over the SpriteMap.
  76258. * @returns Vector2 the UV position of the mouse interaction
  76259. */
  76260. getMousePosition(): Vector2;
  76261. /**
  76262. * Creates the "frame" texture Buffer
  76263. * -------------------------------------
  76264. * Structure of frames
  76265. * "filename": "Falling-Water-2.png",
  76266. * "frame": {"x":69,"y":103,"w":24,"h":32},
  76267. * "rotated": true,
  76268. * "trimmed": true,
  76269. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  76270. * "sourceSize": {"w":32,"h":32}
  76271. * @returns RawTexture of the frameMap
  76272. */
  76273. private _createFrameBuffer;
  76274. /**
  76275. * Creates the tileMap texture Buffer
  76276. * @param buffer normally and array of numbers, or a false to generate from scratch
  76277. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  76278. * @returns RawTexture of the tileMap
  76279. */
  76280. private _createTileBuffer;
  76281. /**
  76282. * Modifies the data of the tileMaps
  76283. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  76284. * @param pos is the iVector2 Coordinates of the Tile
  76285. * @param tile The SpriteIndex of the new Tile
  76286. */
  76287. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  76288. /**
  76289. * Creates the animationMap texture Buffer
  76290. * @param buffer normally and array of numbers, or a false to generate from scratch
  76291. * @returns RawTexture of the animationMap
  76292. */
  76293. private _createTileAnimationBuffer;
  76294. /**
  76295. * Modifies the data of the animationMap
  76296. * @param cellID is the Index of the Sprite
  76297. * @param _frame is the target Animation frame
  76298. * @param toCell is the Target Index of the next frame of the animation
  76299. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  76300. * @param speed is a global scalar of the time variable on the map.
  76301. */
  76302. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  76303. /**
  76304. * Exports the .tilemaps file
  76305. */
  76306. saveTileMaps(): void;
  76307. /**
  76308. * Imports the .tilemaps file
  76309. * @param url of the .tilemaps file
  76310. */
  76311. loadTileMaps(url: string): void;
  76312. /**
  76313. * Release associated resources
  76314. */
  76315. dispose(): void;
  76316. }
  76317. }
  76318. declare module "babylonjs/Sprites/spritePackedManager" {
  76319. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  76320. import { Scene } from "babylonjs/scene";
  76321. /**
  76322. * Class used to manage multiple sprites of different sizes on the same spritesheet
  76323. * @see https://doc.babylonjs.com/babylon101/sprites
  76324. */
  76325. export class SpritePackedManager extends SpriteManager {
  76326. /** defines the packed manager's name */
  76327. name: string;
  76328. /**
  76329. * Creates a new sprite manager from a packed sprite sheet
  76330. * @param name defines the manager's name
  76331. * @param imgUrl defines the sprite sheet url
  76332. * @param capacity defines the maximum allowed number of sprites
  76333. * @param scene defines the hosting scene
  76334. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  76335. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  76336. * @param samplingMode defines the smapling mode to use with spritesheet
  76337. * @param fromPacked set to true; do not alter
  76338. */
  76339. constructor(
  76340. /** defines the packed manager's name */
  76341. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  76342. }
  76343. }
  76344. declare module "babylonjs/Sprites/index" {
  76345. export * from "babylonjs/Sprites/sprite";
  76346. export * from "babylonjs/Sprites/ISprites";
  76347. export * from "babylonjs/Sprites/spriteManager";
  76348. export * from "babylonjs/Sprites/spriteMap";
  76349. export * from "babylonjs/Sprites/spritePackedManager";
  76350. export * from "babylonjs/Sprites/spriteSceneComponent";
  76351. }
  76352. declare module "babylonjs/States/index" {
  76353. export * from "babylonjs/States/alphaCullingState";
  76354. export * from "babylonjs/States/depthCullingState";
  76355. export * from "babylonjs/States/stencilState";
  76356. }
  76357. declare module "babylonjs/Misc/assetsManager" {
  76358. import { Scene } from "babylonjs/scene";
  76359. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  76360. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  76361. import { Skeleton } from "babylonjs/Bones/skeleton";
  76362. import { Observable } from "babylonjs/Misc/observable";
  76363. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  76364. import { Texture } from "babylonjs/Materials/Textures/texture";
  76365. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  76366. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  76367. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  76368. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  76369. import { AssetContainer } from "babylonjs/assetContainer";
  76370. /**
  76371. * Defines the list of states available for a task inside a AssetsManager
  76372. */
  76373. export enum AssetTaskState {
  76374. /**
  76375. * Initialization
  76376. */
  76377. INIT = 0,
  76378. /**
  76379. * Running
  76380. */
  76381. RUNNING = 1,
  76382. /**
  76383. * Done
  76384. */
  76385. DONE = 2,
  76386. /**
  76387. * Error
  76388. */
  76389. ERROR = 3
  76390. }
  76391. /**
  76392. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  76393. */
  76394. export abstract class AbstractAssetTask {
  76395. /**
  76396. * Task name
  76397. */ name: string;
  76398. /**
  76399. * Callback called when the task is successful
  76400. */
  76401. onSuccess: (task: any) => void;
  76402. /**
  76403. * Callback called when the task is not successful
  76404. */
  76405. onError: (task: any, message?: string, exception?: any) => void;
  76406. /**
  76407. * Creates a new AssetsManager
  76408. * @param name defines the name of the task
  76409. */
  76410. constructor(
  76411. /**
  76412. * Task name
  76413. */ name: string);
  76414. private _isCompleted;
  76415. private _taskState;
  76416. private _errorObject;
  76417. /**
  76418. * Get if the task is completed
  76419. */
  76420. get isCompleted(): boolean;
  76421. /**
  76422. * Gets the current state of the task
  76423. */
  76424. get taskState(): AssetTaskState;
  76425. /**
  76426. * Gets the current error object (if task is in error)
  76427. */
  76428. get errorObject(): {
  76429. message?: string;
  76430. exception?: any;
  76431. };
  76432. /**
  76433. * Internal only
  76434. * @hidden
  76435. */
  76436. _setErrorObject(message?: string, exception?: any): void;
  76437. /**
  76438. * Execute the current task
  76439. * @param scene defines the scene where you want your assets to be loaded
  76440. * @param onSuccess is a callback called when the task is successfully executed
  76441. * @param onError is a callback called if an error occurs
  76442. */
  76443. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76444. /**
  76445. * Execute the current task
  76446. * @param scene defines the scene where you want your assets to be loaded
  76447. * @param onSuccess is a callback called when the task is successfully executed
  76448. * @param onError is a callback called if an error occurs
  76449. */
  76450. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76451. /**
  76452. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  76453. * This can be used with failed tasks that have the reason for failure fixed.
  76454. */
  76455. reset(): void;
  76456. private onErrorCallback;
  76457. private onDoneCallback;
  76458. }
  76459. /**
  76460. * Define the interface used by progress events raised during assets loading
  76461. */
  76462. export interface IAssetsProgressEvent {
  76463. /**
  76464. * Defines the number of remaining tasks to process
  76465. */
  76466. remainingCount: number;
  76467. /**
  76468. * Defines the total number of tasks
  76469. */
  76470. totalCount: number;
  76471. /**
  76472. * Defines the task that was just processed
  76473. */
  76474. task: AbstractAssetTask;
  76475. }
  76476. /**
  76477. * Class used to share progress information about assets loading
  76478. */
  76479. export class AssetsProgressEvent implements IAssetsProgressEvent {
  76480. /**
  76481. * Defines the number of remaining tasks to process
  76482. */
  76483. remainingCount: number;
  76484. /**
  76485. * Defines the total number of tasks
  76486. */
  76487. totalCount: number;
  76488. /**
  76489. * Defines the task that was just processed
  76490. */
  76491. task: AbstractAssetTask;
  76492. /**
  76493. * Creates a AssetsProgressEvent
  76494. * @param remainingCount defines the number of remaining tasks to process
  76495. * @param totalCount defines the total number of tasks
  76496. * @param task defines the task that was just processed
  76497. */
  76498. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  76499. }
  76500. /**
  76501. * Define a task used by AssetsManager to load assets into a container
  76502. */
  76503. export class ContainerAssetTask extends AbstractAssetTask {
  76504. /**
  76505. * Defines the name of the task
  76506. */
  76507. name: string;
  76508. /**
  76509. * Defines the list of mesh's names you want to load
  76510. */
  76511. meshesNames: any;
  76512. /**
  76513. * Defines the root url to use as a base to load your meshes and associated resources
  76514. */
  76515. rootUrl: string;
  76516. /**
  76517. * Defines the filename or File of the scene to load from
  76518. */
  76519. sceneFilename: string | File;
  76520. /**
  76521. * Get the loaded asset container
  76522. */
  76523. loadedContainer: AssetContainer;
  76524. /**
  76525. * Gets the list of loaded meshes
  76526. */
  76527. loadedMeshes: Array<AbstractMesh>;
  76528. /**
  76529. * Gets the list of loaded particle systems
  76530. */
  76531. loadedParticleSystems: Array<IParticleSystem>;
  76532. /**
  76533. * Gets the list of loaded skeletons
  76534. */
  76535. loadedSkeletons: Array<Skeleton>;
  76536. /**
  76537. * Gets the list of loaded animation groups
  76538. */
  76539. loadedAnimationGroups: Array<AnimationGroup>;
  76540. /**
  76541. * Callback called when the task is successful
  76542. */
  76543. onSuccess: (task: ContainerAssetTask) => void;
  76544. /**
  76545. * Callback called when the task is successful
  76546. */
  76547. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  76548. /**
  76549. * Creates a new ContainerAssetTask
  76550. * @param name defines the name of the task
  76551. * @param meshesNames defines the list of mesh's names you want to load
  76552. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76553. * @param sceneFilename defines the filename or File of the scene to load from
  76554. */
  76555. constructor(
  76556. /**
  76557. * Defines the name of the task
  76558. */
  76559. name: string,
  76560. /**
  76561. * Defines the list of mesh's names you want to load
  76562. */
  76563. meshesNames: any,
  76564. /**
  76565. * Defines the root url to use as a base to load your meshes and associated resources
  76566. */
  76567. rootUrl: string,
  76568. /**
  76569. * Defines the filename or File of the scene to load from
  76570. */
  76571. sceneFilename: string | File);
  76572. /**
  76573. * Execute the current task
  76574. * @param scene defines the scene where you want your assets to be loaded
  76575. * @param onSuccess is a callback called when the task is successfully executed
  76576. * @param onError is a callback called if an error occurs
  76577. */
  76578. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76579. }
  76580. /**
  76581. * Define a task used by AssetsManager to load meshes
  76582. */
  76583. export class MeshAssetTask extends AbstractAssetTask {
  76584. /**
  76585. * Defines the name of the task
  76586. */
  76587. name: string;
  76588. /**
  76589. * Defines the list of mesh's names you want to load
  76590. */
  76591. meshesNames: any;
  76592. /**
  76593. * Defines the root url to use as a base to load your meshes and associated resources
  76594. */
  76595. rootUrl: string;
  76596. /**
  76597. * Defines the filename or File of the scene to load from
  76598. */
  76599. sceneFilename: string | File;
  76600. /**
  76601. * Gets the list of loaded meshes
  76602. */
  76603. loadedMeshes: Array<AbstractMesh>;
  76604. /**
  76605. * Gets the list of loaded particle systems
  76606. */
  76607. loadedParticleSystems: Array<IParticleSystem>;
  76608. /**
  76609. * Gets the list of loaded skeletons
  76610. */
  76611. loadedSkeletons: Array<Skeleton>;
  76612. /**
  76613. * Gets the list of loaded animation groups
  76614. */
  76615. loadedAnimationGroups: Array<AnimationGroup>;
  76616. /**
  76617. * Callback called when the task is successful
  76618. */
  76619. onSuccess: (task: MeshAssetTask) => void;
  76620. /**
  76621. * Callback called when the task is successful
  76622. */
  76623. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  76624. /**
  76625. * Creates a new MeshAssetTask
  76626. * @param name defines the name of the task
  76627. * @param meshesNames defines the list of mesh's names you want to load
  76628. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76629. * @param sceneFilename defines the filename or File of the scene to load from
  76630. */
  76631. constructor(
  76632. /**
  76633. * Defines the name of the task
  76634. */
  76635. name: string,
  76636. /**
  76637. * Defines the list of mesh's names you want to load
  76638. */
  76639. meshesNames: any,
  76640. /**
  76641. * Defines the root url to use as a base to load your meshes and associated resources
  76642. */
  76643. rootUrl: string,
  76644. /**
  76645. * Defines the filename or File of the scene to load from
  76646. */
  76647. sceneFilename: string | File);
  76648. /**
  76649. * Execute the current task
  76650. * @param scene defines the scene where you want your assets to be loaded
  76651. * @param onSuccess is a callback called when the task is successfully executed
  76652. * @param onError is a callback called if an error occurs
  76653. */
  76654. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76655. }
  76656. /**
  76657. * Define a task used by AssetsManager to load text content
  76658. */
  76659. export class TextFileAssetTask extends AbstractAssetTask {
  76660. /**
  76661. * Defines the name of the task
  76662. */
  76663. name: string;
  76664. /**
  76665. * Defines the location of the file to load
  76666. */
  76667. url: string;
  76668. /**
  76669. * Gets the loaded text string
  76670. */
  76671. text: string;
  76672. /**
  76673. * Callback called when the task is successful
  76674. */
  76675. onSuccess: (task: TextFileAssetTask) => void;
  76676. /**
  76677. * Callback called when the task is successful
  76678. */
  76679. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  76680. /**
  76681. * Creates a new TextFileAssetTask object
  76682. * @param name defines the name of the task
  76683. * @param url defines the location of the file to load
  76684. */
  76685. constructor(
  76686. /**
  76687. * Defines the name of the task
  76688. */
  76689. name: string,
  76690. /**
  76691. * Defines the location of the file to load
  76692. */
  76693. url: string);
  76694. /**
  76695. * Execute the current task
  76696. * @param scene defines the scene where you want your assets to be loaded
  76697. * @param onSuccess is a callback called when the task is successfully executed
  76698. * @param onError is a callback called if an error occurs
  76699. */
  76700. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76701. }
  76702. /**
  76703. * Define a task used by AssetsManager to load binary data
  76704. */
  76705. export class BinaryFileAssetTask extends AbstractAssetTask {
  76706. /**
  76707. * Defines the name of the task
  76708. */
  76709. name: string;
  76710. /**
  76711. * Defines the location of the file to load
  76712. */
  76713. url: string;
  76714. /**
  76715. * Gets the lodaded data (as an array buffer)
  76716. */
  76717. data: ArrayBuffer;
  76718. /**
  76719. * Callback called when the task is successful
  76720. */
  76721. onSuccess: (task: BinaryFileAssetTask) => void;
  76722. /**
  76723. * Callback called when the task is successful
  76724. */
  76725. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  76726. /**
  76727. * Creates a new BinaryFileAssetTask object
  76728. * @param name defines the name of the new task
  76729. * @param url defines the location of the file to load
  76730. */
  76731. constructor(
  76732. /**
  76733. * Defines the name of the task
  76734. */
  76735. name: string,
  76736. /**
  76737. * Defines the location of the file to load
  76738. */
  76739. url: string);
  76740. /**
  76741. * Execute the current task
  76742. * @param scene defines the scene where you want your assets to be loaded
  76743. * @param onSuccess is a callback called when the task is successfully executed
  76744. * @param onError is a callback called if an error occurs
  76745. */
  76746. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76747. }
  76748. /**
  76749. * Define a task used by AssetsManager to load images
  76750. */
  76751. export class ImageAssetTask extends AbstractAssetTask {
  76752. /**
  76753. * Defines the name of the task
  76754. */
  76755. name: string;
  76756. /**
  76757. * Defines the location of the image to load
  76758. */
  76759. url: string;
  76760. /**
  76761. * Gets the loaded images
  76762. */
  76763. image: HTMLImageElement;
  76764. /**
  76765. * Callback called when the task is successful
  76766. */
  76767. onSuccess: (task: ImageAssetTask) => void;
  76768. /**
  76769. * Callback called when the task is successful
  76770. */
  76771. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  76772. /**
  76773. * Creates a new ImageAssetTask
  76774. * @param name defines the name of the task
  76775. * @param url defines the location of the image to load
  76776. */
  76777. constructor(
  76778. /**
  76779. * Defines the name of the task
  76780. */
  76781. name: string,
  76782. /**
  76783. * Defines the location of the image to load
  76784. */
  76785. url: string);
  76786. /**
  76787. * Execute the current task
  76788. * @param scene defines the scene where you want your assets to be loaded
  76789. * @param onSuccess is a callback called when the task is successfully executed
  76790. * @param onError is a callback called if an error occurs
  76791. */
  76792. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76793. }
  76794. /**
  76795. * Defines the interface used by texture loading tasks
  76796. */
  76797. export interface ITextureAssetTask<TEX extends BaseTexture> {
  76798. /**
  76799. * Gets the loaded texture
  76800. */
  76801. texture: TEX;
  76802. }
  76803. /**
  76804. * Define a task used by AssetsManager to load 2D textures
  76805. */
  76806. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  76807. /**
  76808. * Defines the name of the task
  76809. */
  76810. name: string;
  76811. /**
  76812. * Defines the location of the file to load
  76813. */
  76814. url: string;
  76815. /**
  76816. * Defines if mipmap should not be generated (default is false)
  76817. */
  76818. noMipmap?: boolean | undefined;
  76819. /**
  76820. * Defines if texture must be inverted on Y axis (default is true)
  76821. */
  76822. invertY: boolean;
  76823. /**
  76824. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76825. */
  76826. samplingMode: number;
  76827. /**
  76828. * Gets the loaded texture
  76829. */
  76830. texture: Texture;
  76831. /**
  76832. * Callback called when the task is successful
  76833. */
  76834. onSuccess: (task: TextureAssetTask) => void;
  76835. /**
  76836. * Callback called when the task is successful
  76837. */
  76838. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  76839. /**
  76840. * Creates a new TextureAssetTask object
  76841. * @param name defines the name of the task
  76842. * @param url defines the location of the file to load
  76843. * @param noMipmap defines if mipmap should not be generated (default is false)
  76844. * @param invertY defines if texture must be inverted on Y axis (default is true)
  76845. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76846. */
  76847. constructor(
  76848. /**
  76849. * Defines the name of the task
  76850. */
  76851. name: string,
  76852. /**
  76853. * Defines the location of the file to load
  76854. */
  76855. url: string,
  76856. /**
  76857. * Defines if mipmap should not be generated (default is false)
  76858. */
  76859. noMipmap?: boolean | undefined,
  76860. /**
  76861. * Defines if texture must be inverted on Y axis (default is true)
  76862. */
  76863. invertY?: boolean,
  76864. /**
  76865. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76866. */
  76867. samplingMode?: number);
  76868. /**
  76869. * Execute the current task
  76870. * @param scene defines the scene where you want your assets to be loaded
  76871. * @param onSuccess is a callback called when the task is successfully executed
  76872. * @param onError is a callback called if an error occurs
  76873. */
  76874. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76875. }
  76876. /**
  76877. * Define a task used by AssetsManager to load cube textures
  76878. */
  76879. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  76880. /**
  76881. * Defines the name of the task
  76882. */
  76883. name: string;
  76884. /**
  76885. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76886. */
  76887. url: string;
  76888. /**
  76889. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76890. */
  76891. extensions?: string[] | undefined;
  76892. /**
  76893. * Defines if mipmaps should not be generated (default is false)
  76894. */
  76895. noMipmap?: boolean | undefined;
  76896. /**
  76897. * Defines the explicit list of files (undefined by default)
  76898. */
  76899. files?: string[] | undefined;
  76900. /**
  76901. * Gets the loaded texture
  76902. */
  76903. texture: CubeTexture;
  76904. /**
  76905. * Callback called when the task is successful
  76906. */
  76907. onSuccess: (task: CubeTextureAssetTask) => void;
  76908. /**
  76909. * Callback called when the task is successful
  76910. */
  76911. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  76912. /**
  76913. * Creates a new CubeTextureAssetTask
  76914. * @param name defines the name of the task
  76915. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76916. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76917. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76918. * @param files defines the explicit list of files (undefined by default)
  76919. */
  76920. constructor(
  76921. /**
  76922. * Defines the name of the task
  76923. */
  76924. name: string,
  76925. /**
  76926. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76927. */
  76928. url: string,
  76929. /**
  76930. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76931. */
  76932. extensions?: string[] | undefined,
  76933. /**
  76934. * Defines if mipmaps should not be generated (default is false)
  76935. */
  76936. noMipmap?: boolean | undefined,
  76937. /**
  76938. * Defines the explicit list of files (undefined by default)
  76939. */
  76940. files?: string[] | undefined);
  76941. /**
  76942. * Execute the current task
  76943. * @param scene defines the scene where you want your assets to be loaded
  76944. * @param onSuccess is a callback called when the task is successfully executed
  76945. * @param onError is a callback called if an error occurs
  76946. */
  76947. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76948. }
  76949. /**
  76950. * Define a task used by AssetsManager to load HDR cube textures
  76951. */
  76952. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  76953. /**
  76954. * Defines the name of the task
  76955. */
  76956. name: string;
  76957. /**
  76958. * Defines the location of the file to load
  76959. */
  76960. url: string;
  76961. /**
  76962. * Defines the desired size (the more it increases the longer the generation will be)
  76963. */
  76964. size: number;
  76965. /**
  76966. * Defines if mipmaps should not be generated (default is false)
  76967. */
  76968. noMipmap: boolean;
  76969. /**
  76970. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76971. */
  76972. generateHarmonics: boolean;
  76973. /**
  76974. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space) (default is false)
  76975. */
  76976. gammaSpace: boolean;
  76977. /**
  76978. * Internal Use Only
  76979. */
  76980. reserved: boolean;
  76981. /**
  76982. * Gets the loaded texture
  76983. */
  76984. texture: HDRCubeTexture;
  76985. /**
  76986. * Callback called when the task is successful
  76987. */
  76988. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  76989. /**
  76990. * Callback called when the task is successful
  76991. */
  76992. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  76993. /**
  76994. * Creates a new HDRCubeTextureAssetTask object
  76995. * @param name defines the name of the task
  76996. * @param url defines the location of the file to load
  76997. * @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.
  76998. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76999. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77000. * @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)
  77001. * @param reserved Internal use only
  77002. */
  77003. constructor(
  77004. /**
  77005. * Defines the name of the task
  77006. */
  77007. name: string,
  77008. /**
  77009. * Defines the location of the file to load
  77010. */
  77011. url: string,
  77012. /**
  77013. * Defines the desired size (the more it increases the longer the generation will be)
  77014. */
  77015. size: number,
  77016. /**
  77017. * Defines if mipmaps should not be generated (default is false)
  77018. */
  77019. noMipmap?: boolean,
  77020. /**
  77021. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77022. */
  77023. generateHarmonics?: boolean,
  77024. /**
  77025. * 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)
  77026. */
  77027. gammaSpace?: boolean,
  77028. /**
  77029. * Internal Use Only
  77030. */
  77031. reserved?: boolean);
  77032. /**
  77033. * Execute the current task
  77034. * @param scene defines the scene where you want your assets to be loaded
  77035. * @param onSuccess is a callback called when the task is successfully executed
  77036. * @param onError is a callback called if an error occurs
  77037. */
  77038. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77039. }
  77040. /**
  77041. * Define a task used by AssetsManager to load Equirectangular cube textures
  77042. */
  77043. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  77044. /**
  77045. * Defines the name of the task
  77046. */
  77047. name: string;
  77048. /**
  77049. * Defines the location of the file to load
  77050. */
  77051. url: string;
  77052. /**
  77053. * Defines the desired size (the more it increases the longer the generation will be)
  77054. */
  77055. size: number;
  77056. /**
  77057. * Defines if mipmaps should not be generated (default is false)
  77058. */
  77059. noMipmap: boolean;
  77060. /**
  77061. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77062. * but the standard material would require them in Gamma space) (default is true)
  77063. */
  77064. gammaSpace: boolean;
  77065. /**
  77066. * Gets the loaded texture
  77067. */
  77068. texture: EquiRectangularCubeTexture;
  77069. /**
  77070. * Callback called when the task is successful
  77071. */
  77072. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  77073. /**
  77074. * Callback called when the task is successful
  77075. */
  77076. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  77077. /**
  77078. * Creates a new EquiRectangularCubeTextureAssetTask object
  77079. * @param name defines the name of the task
  77080. * @param url defines the location of the file to load
  77081. * @param size defines the desired size (the more it increases the longer the generation will be)
  77082. * If the size is omitted this implies you are using a preprocessed cubemap.
  77083. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77084. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  77085. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  77086. * (default is true)
  77087. */
  77088. constructor(
  77089. /**
  77090. * Defines the name of the task
  77091. */
  77092. name: string,
  77093. /**
  77094. * Defines the location of the file to load
  77095. */
  77096. url: string,
  77097. /**
  77098. * Defines the desired size (the more it increases the longer the generation will be)
  77099. */
  77100. size: number,
  77101. /**
  77102. * Defines if mipmaps should not be generated (default is false)
  77103. */
  77104. noMipmap?: boolean,
  77105. /**
  77106. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77107. * but the standard material would require them in Gamma space) (default is true)
  77108. */
  77109. gammaSpace?: boolean);
  77110. /**
  77111. * Execute the current task
  77112. * @param scene defines the scene where you want your assets to be loaded
  77113. * @param onSuccess is a callback called when the task is successfully executed
  77114. * @param onError is a callback called if an error occurs
  77115. */
  77116. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77117. }
  77118. /**
  77119. * This class can be used to easily import assets into a scene
  77120. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  77121. */
  77122. export class AssetsManager {
  77123. private _scene;
  77124. private _isLoading;
  77125. protected _tasks: AbstractAssetTask[];
  77126. protected _waitingTasksCount: number;
  77127. protected _totalTasksCount: number;
  77128. /**
  77129. * Callback called when all tasks are processed
  77130. */
  77131. onFinish: (tasks: AbstractAssetTask[]) => void;
  77132. /**
  77133. * Callback called when a task is successful
  77134. */
  77135. onTaskSuccess: (task: AbstractAssetTask) => void;
  77136. /**
  77137. * Callback called when a task had an error
  77138. */
  77139. onTaskError: (task: AbstractAssetTask) => void;
  77140. /**
  77141. * Callback called when a task is done (whatever the result is)
  77142. */
  77143. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  77144. /**
  77145. * Observable called when all tasks are processed
  77146. */
  77147. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  77148. /**
  77149. * Observable called when a task had an error
  77150. */
  77151. onTaskErrorObservable: Observable<AbstractAssetTask>;
  77152. /**
  77153. * Observable called when all tasks were executed
  77154. */
  77155. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  77156. /**
  77157. * Observable called when a task is done (whatever the result is)
  77158. */
  77159. onProgressObservable: Observable<IAssetsProgressEvent>;
  77160. /**
  77161. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  77162. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  77163. */
  77164. useDefaultLoadingScreen: boolean;
  77165. /**
  77166. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  77167. * when all assets have been downloaded.
  77168. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  77169. */
  77170. autoHideLoadingUI: boolean;
  77171. /**
  77172. * Creates a new AssetsManager
  77173. * @param scene defines the scene to work on
  77174. */
  77175. constructor(scene: Scene);
  77176. /**
  77177. * Add a ContainerAssetTask to the list of active tasks
  77178. * @param taskName defines the name of the new task
  77179. * @param meshesNames defines the name of meshes to load
  77180. * @param rootUrl defines the root url to use to locate files
  77181. * @param sceneFilename defines the filename of the scene file
  77182. * @returns a new ContainerAssetTask object
  77183. */
  77184. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  77185. /**
  77186. * Add a MeshAssetTask 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 MeshAssetTask object
  77192. */
  77193. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  77194. /**
  77195. * Add a TextFileAssetTask to the list of active tasks
  77196. * @param taskName defines the name of the new task
  77197. * @param url defines the url of the file to load
  77198. * @returns a new TextFileAssetTask object
  77199. */
  77200. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  77201. /**
  77202. * Add a BinaryFileAssetTask to the list of active tasks
  77203. * @param taskName defines the name of the new task
  77204. * @param url defines the url of the file to load
  77205. * @returns a new BinaryFileAssetTask object
  77206. */
  77207. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  77208. /**
  77209. * Add a ImageAssetTask to the list of active tasks
  77210. * @param taskName defines the name of the new task
  77211. * @param url defines the url of the file to load
  77212. * @returns a new ImageAssetTask object
  77213. */
  77214. addImageTask(taskName: string, url: string): ImageAssetTask;
  77215. /**
  77216. * Add a TextureAssetTask to the list of active tasks
  77217. * @param taskName defines the name of the new task
  77218. * @param url defines the url of the file to load
  77219. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77220. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  77221. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  77222. * @returns a new TextureAssetTask object
  77223. */
  77224. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  77225. /**
  77226. * Add a CubeTextureAssetTask to the list of active tasks
  77227. * @param taskName defines the name of the new task
  77228. * @param url defines the url of the file to load
  77229. * @param extensions defines the extension to use to load the cube map (can be null)
  77230. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77231. * @param files defines the list of files to load (can be null)
  77232. * @returns a new CubeTextureAssetTask object
  77233. */
  77234. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  77235. /**
  77236. *
  77237. * Add a HDRCubeTextureAssetTask to the list of active tasks
  77238. * @param taskName defines the name of the new task
  77239. * @param url defines the url of the file to load
  77240. * @param size defines the size you want for the cubemap (can be null)
  77241. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77242. * @param generateHarmonics defines if you want to automatically generate (true by default)
  77243. * @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)
  77244. * @param reserved Internal use only
  77245. * @returns a new HDRCubeTextureAssetTask object
  77246. */
  77247. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  77248. /**
  77249. *
  77250. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  77251. * @param taskName defines the name of the new task
  77252. * @param url defines the url of the file to load
  77253. * @param size defines the size you want for the cubemap (can be null)
  77254. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77255. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  77256. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  77257. * @returns a new EquiRectangularCubeTextureAssetTask object
  77258. */
  77259. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  77260. /**
  77261. * Remove a task from the assets manager.
  77262. * @param task the task to remove
  77263. */
  77264. removeTask(task: AbstractAssetTask): void;
  77265. private _decreaseWaitingTasksCount;
  77266. private _runTask;
  77267. /**
  77268. * Reset the AssetsManager and remove all tasks
  77269. * @return the current instance of the AssetsManager
  77270. */
  77271. reset(): AssetsManager;
  77272. /**
  77273. * Start the loading process
  77274. * @return the current instance of the AssetsManager
  77275. */
  77276. load(): AssetsManager;
  77277. /**
  77278. * Start the loading process as an async operation
  77279. * @return a promise returning the list of failed tasks
  77280. */
  77281. loadAsync(): Promise<void>;
  77282. }
  77283. }
  77284. declare module "babylonjs/Misc/deferred" {
  77285. /**
  77286. * Wrapper class for promise with external resolve and reject.
  77287. */
  77288. export class Deferred<T> {
  77289. /**
  77290. * The promise associated with this deferred object.
  77291. */
  77292. readonly promise: Promise<T>;
  77293. private _resolve;
  77294. private _reject;
  77295. /**
  77296. * The resolve method of the promise associated with this deferred object.
  77297. */
  77298. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  77299. /**
  77300. * The reject method of the promise associated with this deferred object.
  77301. */
  77302. get reject(): (reason?: any) => void;
  77303. /**
  77304. * Constructor for this deferred object.
  77305. */
  77306. constructor();
  77307. }
  77308. }
  77309. declare module "babylonjs/Misc/meshExploder" {
  77310. import { Mesh } from "babylonjs/Meshes/mesh";
  77311. /**
  77312. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  77313. */
  77314. export class MeshExploder {
  77315. private _centerMesh;
  77316. private _meshes;
  77317. private _meshesOrigins;
  77318. private _toCenterVectors;
  77319. private _scaledDirection;
  77320. private _newPosition;
  77321. private _centerPosition;
  77322. /**
  77323. * Explodes meshes from a center mesh.
  77324. * @param meshes The meshes to explode.
  77325. * @param centerMesh The mesh to be center of explosion.
  77326. */
  77327. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  77328. private _setCenterMesh;
  77329. /**
  77330. * Get class name
  77331. * @returns "MeshExploder"
  77332. */
  77333. getClassName(): string;
  77334. /**
  77335. * "Exploded meshes"
  77336. * @returns Array of meshes with the centerMesh at index 0.
  77337. */
  77338. getMeshes(): Array<Mesh>;
  77339. /**
  77340. * Explodes meshes giving a specific direction
  77341. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  77342. */
  77343. explode(direction?: number): void;
  77344. }
  77345. }
  77346. declare module "babylonjs/Misc/filesInput" {
  77347. import { Engine } from "babylonjs/Engines/engine";
  77348. import { Scene } from "babylonjs/scene";
  77349. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  77350. import { Nullable } from "babylonjs/types";
  77351. /**
  77352. * Class used to help managing file picking and drag'n'drop
  77353. */
  77354. export class FilesInput {
  77355. /**
  77356. * List of files ready to be loaded
  77357. */
  77358. static get FilesToLoad(): {
  77359. [key: string]: File;
  77360. };
  77361. /**
  77362. * Callback called when a file is processed
  77363. */
  77364. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  77365. private _engine;
  77366. private _currentScene;
  77367. private _sceneLoadedCallback;
  77368. private _progressCallback;
  77369. private _additionalRenderLoopLogicCallback;
  77370. private _textureLoadingCallback;
  77371. private _startingProcessingFilesCallback;
  77372. private _onReloadCallback;
  77373. private _errorCallback;
  77374. private _elementToMonitor;
  77375. private _sceneFileToLoad;
  77376. private _filesToLoad;
  77377. /**
  77378. * Creates a new FilesInput
  77379. * @param engine defines the rendering engine
  77380. * @param scene defines the hosting scene
  77381. * @param sceneLoadedCallback callback called when scene is loaded
  77382. * @param progressCallback callback called to track progress
  77383. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  77384. * @param textureLoadingCallback callback called when a texture is loading
  77385. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  77386. * @param onReloadCallback callback called when a reload is requested
  77387. * @param errorCallback callback call if an error occurs
  77388. */
  77389. 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>);
  77390. private _dragEnterHandler;
  77391. private _dragOverHandler;
  77392. private _dropHandler;
  77393. /**
  77394. * Calls this function to listen to drag'n'drop events on a specific DOM element
  77395. * @param elementToMonitor defines the DOM element to track
  77396. */
  77397. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  77398. /** Gets the current list of files to load */
  77399. get filesToLoad(): File[];
  77400. /**
  77401. * Release all associated resources
  77402. */
  77403. dispose(): void;
  77404. private renderFunction;
  77405. private drag;
  77406. private drop;
  77407. private _traverseFolder;
  77408. private _processFiles;
  77409. /**
  77410. * Load files from a drop event
  77411. * @param event defines the drop event to use as source
  77412. */
  77413. loadFiles(event: any): void;
  77414. private _processReload;
  77415. /**
  77416. * Reload the current scene from the loaded files
  77417. */
  77418. reload(): void;
  77419. }
  77420. }
  77421. declare module "babylonjs/Misc/HighDynamicRange/index" {
  77422. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  77423. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  77424. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  77425. }
  77426. declare module "babylonjs/Misc/sceneOptimizer" {
  77427. import { Scene, IDisposable } from "babylonjs/scene";
  77428. import { Observable } from "babylonjs/Misc/observable";
  77429. /**
  77430. * Defines the root class used to create scene optimization to use with SceneOptimizer
  77431. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77432. */
  77433. export class SceneOptimization {
  77434. /**
  77435. * Defines the priority of this optimization (0 by default which means first in the list)
  77436. */
  77437. priority: number;
  77438. /**
  77439. * Gets a string describing the action executed by the current optimization
  77440. * @returns description string
  77441. */
  77442. getDescription(): string;
  77443. /**
  77444. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77445. * @param scene defines the current scene where to apply this optimization
  77446. * @param optimizer defines the current optimizer
  77447. * @returns true if everything that can be done was applied
  77448. */
  77449. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77450. /**
  77451. * Creates the SceneOptimization object
  77452. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77453. * @param desc defines the description associated with the optimization
  77454. */
  77455. constructor(
  77456. /**
  77457. * Defines the priority of this optimization (0 by default which means first in the list)
  77458. */
  77459. priority?: number);
  77460. }
  77461. /**
  77462. * Defines an optimization used to reduce the size of render target textures
  77463. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77464. */
  77465. export class TextureOptimization extends SceneOptimization {
  77466. /**
  77467. * Defines the priority of this optimization (0 by default which means first in the list)
  77468. */
  77469. priority: number;
  77470. /**
  77471. * 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
  77472. */
  77473. maximumSize: number;
  77474. /**
  77475. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77476. */
  77477. step: number;
  77478. /**
  77479. * Gets a string describing the action executed by the current optimization
  77480. * @returns description string
  77481. */
  77482. getDescription(): string;
  77483. /**
  77484. * Creates the TextureOptimization object
  77485. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77486. * @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
  77487. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77488. */
  77489. constructor(
  77490. /**
  77491. * Defines the priority of this optimization (0 by default which means first in the list)
  77492. */
  77493. priority?: number,
  77494. /**
  77495. * 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. */
  77497. maximumSize?: number,
  77498. /**
  77499. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77500. */
  77501. step?: number);
  77502. /**
  77503. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77504. * @param scene defines the current scene where to apply this optimization
  77505. * @param optimizer defines the current optimizer
  77506. * @returns true if everything that can be done was applied
  77507. */
  77508. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77509. }
  77510. /**
  77511. * Defines an optimization used to increase or decrease the rendering resolution
  77512. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77513. */
  77514. export class HardwareScalingOptimization extends SceneOptimization {
  77515. /**
  77516. * Defines the priority of this optimization (0 by default which means first in the list)
  77517. */
  77518. priority: number;
  77519. /**
  77520. * Defines the maximum scale to use (2 by default)
  77521. */
  77522. maximumScale: number;
  77523. /**
  77524. * Defines the step to use between two passes (0.5 by default)
  77525. */
  77526. step: number;
  77527. private _currentScale;
  77528. private _directionOffset;
  77529. /**
  77530. * Gets a string describing the action executed by the current optimization
  77531. * @return description string
  77532. */
  77533. getDescription(): string;
  77534. /**
  77535. * Creates the HardwareScalingOptimization object
  77536. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77537. * @param maximumScale defines the maximum scale to use (2 by default)
  77538. * @param step defines the step to use between two passes (0.5 by default)
  77539. */
  77540. constructor(
  77541. /**
  77542. * Defines the priority of this optimization (0 by default which means first in the list)
  77543. */
  77544. priority?: number,
  77545. /**
  77546. * Defines the maximum scale to use (2 by default)
  77547. */
  77548. maximumScale?: number,
  77549. /**
  77550. * Defines the step to use between two passes (0.5 by default)
  77551. */
  77552. step?: number);
  77553. /**
  77554. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77555. * @param scene defines the current scene where to apply this optimization
  77556. * @param optimizer defines the current optimizer
  77557. * @returns true if everything that can be done was applied
  77558. */
  77559. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77560. }
  77561. /**
  77562. * Defines an optimization used to remove shadows
  77563. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77564. */
  77565. export class ShadowsOptimization extends SceneOptimization {
  77566. /**
  77567. * Gets a string describing the action executed by the current optimization
  77568. * @return description string
  77569. */
  77570. getDescription(): string;
  77571. /**
  77572. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77573. * @param scene defines the current scene where to apply this optimization
  77574. * @param optimizer defines the current optimizer
  77575. * @returns true if everything that can be done was applied
  77576. */
  77577. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77578. }
  77579. /**
  77580. * Defines an optimization used to turn post-processes off
  77581. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77582. */
  77583. export class PostProcessesOptimization extends SceneOptimization {
  77584. /**
  77585. * Gets a string describing the action executed by the current optimization
  77586. * @return description string
  77587. */
  77588. getDescription(): string;
  77589. /**
  77590. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77591. * @param scene defines the current scene where to apply this optimization
  77592. * @param optimizer defines the current optimizer
  77593. * @returns true if everything that can be done was applied
  77594. */
  77595. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77596. }
  77597. /**
  77598. * Defines an optimization used to turn lens flares off
  77599. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77600. */
  77601. export class LensFlaresOptimization extends SceneOptimization {
  77602. /**
  77603. * Gets a string describing the action executed by the current optimization
  77604. * @return description string
  77605. */
  77606. getDescription(): string;
  77607. /**
  77608. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77609. * @param scene defines the current scene where to apply this optimization
  77610. * @param optimizer defines the current optimizer
  77611. * @returns true if everything that can be done was applied
  77612. */
  77613. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77614. }
  77615. /**
  77616. * Defines an optimization based on user defined callback.
  77617. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77618. */
  77619. export class CustomOptimization extends SceneOptimization {
  77620. /**
  77621. * Callback called to apply the custom optimization.
  77622. */
  77623. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  77624. /**
  77625. * Callback called to get custom description
  77626. */
  77627. onGetDescription: () => string;
  77628. /**
  77629. * Gets a string describing the action executed by the current optimization
  77630. * @returns description string
  77631. */
  77632. getDescription(): string;
  77633. /**
  77634. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77635. * @param scene defines the current scene where to apply this optimization
  77636. * @param optimizer defines the current optimizer
  77637. * @returns true if everything that can be done was applied
  77638. */
  77639. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77640. }
  77641. /**
  77642. * Defines an optimization used to turn particles off
  77643. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77644. */
  77645. export class ParticlesOptimization extends SceneOptimization {
  77646. /**
  77647. * Gets a string describing the action executed by the current optimization
  77648. * @return description string
  77649. */
  77650. getDescription(): string;
  77651. /**
  77652. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77653. * @param scene defines the current scene where to apply this optimization
  77654. * @param optimizer defines the current optimizer
  77655. * @returns true if everything that can be done was applied
  77656. */
  77657. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77658. }
  77659. /**
  77660. * Defines an optimization used to turn render targets off
  77661. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77662. */
  77663. export class RenderTargetsOptimization extends SceneOptimization {
  77664. /**
  77665. * Gets a string describing the action executed by the current optimization
  77666. * @return description string
  77667. */
  77668. getDescription(): string;
  77669. /**
  77670. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77671. * @param scene defines the current scene where to apply this optimization
  77672. * @param optimizer defines the current optimizer
  77673. * @returns true if everything that can be done was applied
  77674. */
  77675. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77676. }
  77677. /**
  77678. * Defines an optimization used to merge meshes with compatible materials
  77679. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77680. */
  77681. export class MergeMeshesOptimization extends SceneOptimization {
  77682. private static _UpdateSelectionTree;
  77683. /**
  77684. * Gets or sets a boolean which defines if optimization octree has to be updated
  77685. */
  77686. static get UpdateSelectionTree(): boolean;
  77687. /**
  77688. * Gets or sets a boolean which defines if optimization octree has to be updated
  77689. */
  77690. static set UpdateSelectionTree(value: boolean);
  77691. /**
  77692. * Gets a string describing the action executed by the current optimization
  77693. * @return description string
  77694. */
  77695. getDescription(): string;
  77696. private _canBeMerged;
  77697. /**
  77698. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77699. * @param scene defines the current scene where to apply this optimization
  77700. * @param optimizer defines the current optimizer
  77701. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  77702. * @returns true if everything that can be done was applied
  77703. */
  77704. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  77705. }
  77706. /**
  77707. * Defines a list of options used by SceneOptimizer
  77708. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77709. */
  77710. export class SceneOptimizerOptions {
  77711. /**
  77712. * Defines the target frame rate to reach (60 by default)
  77713. */
  77714. targetFrameRate: number;
  77715. /**
  77716. * Defines the interval between two checkes (2000ms by default)
  77717. */
  77718. trackerDuration: number;
  77719. /**
  77720. * Gets the list of optimizations to apply
  77721. */
  77722. optimizations: SceneOptimization[];
  77723. /**
  77724. * Creates a new list of options used by SceneOptimizer
  77725. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  77726. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  77727. */
  77728. constructor(
  77729. /**
  77730. * Defines the target frame rate to reach (60 by default)
  77731. */
  77732. targetFrameRate?: number,
  77733. /**
  77734. * Defines the interval between two checkes (2000ms by default)
  77735. */
  77736. trackerDuration?: number);
  77737. /**
  77738. * Add a new optimization
  77739. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  77740. * @returns the current SceneOptimizerOptions
  77741. */
  77742. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  77743. /**
  77744. * Add a new custom optimization
  77745. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  77746. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  77747. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77748. * @returns the current SceneOptimizerOptions
  77749. */
  77750. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  77751. /**
  77752. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  77753. * @param targetFrameRate defines the target frame rate (60 by default)
  77754. * @returns a SceneOptimizerOptions object
  77755. */
  77756. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77757. /**
  77758. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  77759. * @param targetFrameRate defines the target frame rate (60 by default)
  77760. * @returns a SceneOptimizerOptions object
  77761. */
  77762. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77763. /**
  77764. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  77765. * @param targetFrameRate defines the target frame rate (60 by default)
  77766. * @returns a SceneOptimizerOptions object
  77767. */
  77768. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77769. }
  77770. /**
  77771. * Class used to run optimizations in order to reach a target frame rate
  77772. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77773. */
  77774. export class SceneOptimizer implements IDisposable {
  77775. private _isRunning;
  77776. private _options;
  77777. private _scene;
  77778. private _currentPriorityLevel;
  77779. private _targetFrameRate;
  77780. private _trackerDuration;
  77781. private _currentFrameRate;
  77782. private _sceneDisposeObserver;
  77783. private _improvementMode;
  77784. /**
  77785. * Defines an observable called when the optimizer reaches the target frame rate
  77786. */
  77787. onSuccessObservable: Observable<SceneOptimizer>;
  77788. /**
  77789. * Defines an observable called when the optimizer enables an optimization
  77790. */
  77791. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  77792. /**
  77793. * Defines an observable called when the optimizer is not able to reach the target frame rate
  77794. */
  77795. onFailureObservable: Observable<SceneOptimizer>;
  77796. /**
  77797. * Gets a boolean indicating if the optimizer is in improvement mode
  77798. */
  77799. get isInImprovementMode(): boolean;
  77800. /**
  77801. * Gets the current priority level (0 at start)
  77802. */
  77803. get currentPriorityLevel(): number;
  77804. /**
  77805. * Gets the current frame rate checked by the SceneOptimizer
  77806. */
  77807. get currentFrameRate(): number;
  77808. /**
  77809. * Gets or sets the current target frame rate (60 by default)
  77810. */
  77811. get targetFrameRate(): number;
  77812. /**
  77813. * Gets or sets the current target frame rate (60 by default)
  77814. */
  77815. set targetFrameRate(value: number);
  77816. /**
  77817. * Gets or sets the current interval between two checks (every 2000ms by default)
  77818. */
  77819. get trackerDuration(): number;
  77820. /**
  77821. * Gets or sets the current interval between two checks (every 2000ms by default)
  77822. */
  77823. set trackerDuration(value: number);
  77824. /**
  77825. * Gets the list of active optimizations
  77826. */
  77827. get optimizations(): SceneOptimization[];
  77828. /**
  77829. * Creates a new SceneOptimizer
  77830. * @param scene defines the scene to work on
  77831. * @param options defines the options to use with the SceneOptimizer
  77832. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  77833. * @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)
  77834. */
  77835. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  77836. /**
  77837. * Stops the current optimizer
  77838. */
  77839. stop(): void;
  77840. /**
  77841. * Reset the optimizer to initial step (current priority level = 0)
  77842. */
  77843. reset(): void;
  77844. /**
  77845. * Start the optimizer. By default it will try to reach a specific framerate
  77846. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  77847. */
  77848. start(): void;
  77849. private _checkCurrentState;
  77850. /**
  77851. * Release all resources
  77852. */
  77853. dispose(): void;
  77854. /**
  77855. * Helper function to create a SceneOptimizer with one single line of code
  77856. * @param scene defines the scene to work on
  77857. * @param options defines the options to use with the SceneOptimizer
  77858. * @param onSuccess defines a callback to call on success
  77859. * @param onFailure defines a callback to call on failure
  77860. * @returns the new SceneOptimizer object
  77861. */
  77862. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  77863. }
  77864. }
  77865. declare module "babylonjs/Misc/sceneSerializer" {
  77866. import { Scene } from "babylonjs/scene";
  77867. /**
  77868. * Class used to serialize a scene into a string
  77869. */
  77870. export class SceneSerializer {
  77871. /**
  77872. * Clear cache used by a previous serialization
  77873. */
  77874. static ClearCache(): void;
  77875. /**
  77876. * Serialize a scene into a JSON compatible object
  77877. * @param scene defines the scene to serialize
  77878. * @returns a JSON compatible object
  77879. */
  77880. static Serialize(scene: Scene): any;
  77881. /**
  77882. * Serialize a mesh into a JSON compatible object
  77883. * @param toSerialize defines the mesh to serialize
  77884. * @param withParents defines if parents must be serialized as well
  77885. * @param withChildren defines if children must be serialized as well
  77886. * @returns a JSON compatible object
  77887. */
  77888. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  77889. }
  77890. }
  77891. declare module "babylonjs/Misc/textureTools" {
  77892. import { Texture } from "babylonjs/Materials/Textures/texture";
  77893. /**
  77894. * Class used to host texture specific utilities
  77895. */
  77896. export class TextureTools {
  77897. /**
  77898. * Uses the GPU to create a copy texture rescaled at a given size
  77899. * @param texture Texture to copy from
  77900. * @param width defines the desired width
  77901. * @param height defines the desired height
  77902. * @param useBilinearMode defines if bilinear mode has to be used
  77903. * @return the generated texture
  77904. */
  77905. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  77906. }
  77907. }
  77908. declare module "babylonjs/Misc/videoRecorder" {
  77909. import { Nullable } from "babylonjs/types";
  77910. import { Engine } from "babylonjs/Engines/engine";
  77911. /**
  77912. * This represents the different options available for the video capture.
  77913. */
  77914. export interface VideoRecorderOptions {
  77915. /** Defines the mime type of the video. */
  77916. mimeType: string;
  77917. /** Defines the FPS the video should be recorded at. */
  77918. fps: number;
  77919. /** Defines the chunk size for the recording data. */
  77920. recordChunckSize: number;
  77921. /** The audio tracks to attach to the recording. */
  77922. audioTracks?: MediaStreamTrack[];
  77923. }
  77924. /**
  77925. * This can help with recording videos from BabylonJS.
  77926. * This is based on the available WebRTC functionalities of the browser.
  77927. *
  77928. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  77929. */
  77930. export class VideoRecorder {
  77931. private static readonly _defaultOptions;
  77932. /**
  77933. * Returns whether or not the VideoRecorder is available in your browser.
  77934. * @param engine Defines the Babylon Engine.
  77935. * @returns true if supported otherwise false.
  77936. */
  77937. static IsSupported(engine: Engine): boolean;
  77938. private readonly _options;
  77939. private _canvas;
  77940. private _mediaRecorder;
  77941. private _recordedChunks;
  77942. private _fileName;
  77943. private _resolve;
  77944. private _reject;
  77945. /**
  77946. * True when a recording is already in progress.
  77947. */
  77948. get isRecording(): boolean;
  77949. /**
  77950. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  77951. * @param engine Defines the BabylonJS Engine you wish to record.
  77952. * @param options Defines options that can be used to customize the capture.
  77953. */
  77954. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  77955. /**
  77956. * Stops the current recording before the default capture timeout passed in the startRecording function.
  77957. */
  77958. stopRecording(): void;
  77959. /**
  77960. * Starts recording the canvas for a max duration specified in parameters.
  77961. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  77962. * If null no automatic download will start and you can rely on the promise to get the data back.
  77963. * @param maxDuration Defines the maximum recording time in seconds.
  77964. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  77965. * @return A promise callback at the end of the recording with the video data in Blob.
  77966. */
  77967. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  77968. /**
  77969. * Releases internal resources used during the recording.
  77970. */
  77971. dispose(): void;
  77972. private _handleDataAvailable;
  77973. private _handleError;
  77974. private _handleStop;
  77975. }
  77976. }
  77977. declare module "babylonjs/Misc/screenshotTools" {
  77978. import { Camera } from "babylonjs/Cameras/camera";
  77979. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  77980. import { Engine } from "babylonjs/Engines/engine";
  77981. /**
  77982. * Class containing a set of static utilities functions for screenshots
  77983. */
  77984. export class ScreenshotTools {
  77985. /**
  77986. * Captures a screenshot of the current rendering
  77987. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77988. * @param engine defines the rendering engine
  77989. * @param camera defines the source camera
  77990. * @param size This parameter can be set to a single number or to an object with the
  77991. * following (optional) properties: precision, width, height. If a single number is passed,
  77992. * it will be used for both width and height. If an object is passed, the screenshot size
  77993. * will be derived from the parameters. The precision property is a multiplier allowing
  77994. * rendering at a higher or lower resolution
  77995. * @param successCallback defines the callback receives a single parameter which contains the
  77996. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  77997. * src parameter of an <img> to display it
  77998. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  77999. * Check your browser for supported MIME types
  78000. */
  78001. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  78002. /**
  78003. * Captures a screenshot of the current rendering
  78004. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78005. * @param engine defines the rendering engine
  78006. * @param camera defines the source camera
  78007. * @param size This parameter can be set to a single number or to an object with the
  78008. * following (optional) properties: precision, width, height. If a single number is passed,
  78009. * it will be used for both width and height. If an object is passed, the screenshot size
  78010. * will be derived from the parameters. The precision property is a multiplier allowing
  78011. * rendering at a higher or lower resolution
  78012. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78013. * Check your browser for supported MIME types
  78014. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78015. * to the src parameter of an <img> to display it
  78016. */
  78017. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  78018. /**
  78019. * Generates an image screenshot from the specified camera.
  78020. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78021. * @param engine The engine to use for rendering
  78022. * @param camera The camera to use for rendering
  78023. * @param size This parameter can be set to a single number or to an object with the
  78024. * following (optional) properties: precision, width, height. If a single number is passed,
  78025. * it will be used for both width and height. If an object is passed, the screenshot size
  78026. * will be derived from the parameters. The precision property is a multiplier allowing
  78027. * rendering at a higher or lower resolution
  78028. * @param successCallback The callback receives a single parameter which contains the
  78029. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78030. * src parameter of an <img> to display it
  78031. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78032. * Check your browser for supported MIME types
  78033. * @param samples Texture samples (default: 1)
  78034. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78035. * @param fileName A name for for the downloaded file.
  78036. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78037. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  78038. */
  78039. 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;
  78040. /**
  78041. * Generates an image screenshot from the specified camera.
  78042. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78043. * @param engine The engine to use for rendering
  78044. * @param camera The camera to use for rendering
  78045. * @param size This parameter can be set to a single number or to an object with the
  78046. * following (optional) properties: precision, width, height. If a single number is passed,
  78047. * it will be used for both width and height. If an object is passed, the screenshot size
  78048. * will be derived from the parameters. The precision property is a multiplier allowing
  78049. * rendering at a higher or lower resolution
  78050. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78051. * Check your browser for supported MIME types
  78052. * @param samples Texture samples (default: 1)
  78053. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78054. * @param fileName A name for for the downloaded file.
  78055. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78056. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78057. * to the src parameter of an <img> to display it
  78058. */
  78059. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  78060. /**
  78061. * Gets height and width for screenshot size
  78062. * @private
  78063. */
  78064. private static _getScreenshotSize;
  78065. }
  78066. }
  78067. declare module "babylonjs/Misc/dataReader" {
  78068. /**
  78069. * Interface for a data buffer
  78070. */
  78071. export interface IDataBuffer {
  78072. /**
  78073. * Reads bytes from the data buffer.
  78074. * @param byteOffset The byte offset to read
  78075. * @param byteLength The byte length to read
  78076. * @returns A promise that resolves when the bytes are read
  78077. */
  78078. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  78079. /**
  78080. * The byte length of the buffer.
  78081. */
  78082. readonly byteLength: number;
  78083. }
  78084. /**
  78085. * Utility class for reading from a data buffer
  78086. */
  78087. export class DataReader {
  78088. /**
  78089. * The data buffer associated with this data reader.
  78090. */
  78091. readonly buffer: IDataBuffer;
  78092. /**
  78093. * The current byte offset from the beginning of the data buffer.
  78094. */
  78095. byteOffset: number;
  78096. private _dataView;
  78097. private _dataByteOffset;
  78098. /**
  78099. * Constructor
  78100. * @param buffer The buffer to read
  78101. */
  78102. constructor(buffer: IDataBuffer);
  78103. /**
  78104. * Loads the given byte length.
  78105. * @param byteLength The byte length to load
  78106. * @returns A promise that resolves when the load is complete
  78107. */
  78108. loadAsync(byteLength: number): Promise<void>;
  78109. /**
  78110. * Read a unsigned 32-bit integer from the currently loaded data range.
  78111. * @returns The 32-bit integer read
  78112. */
  78113. readUint32(): number;
  78114. /**
  78115. * Read a byte array from the currently loaded data range.
  78116. * @param byteLength The byte length to read
  78117. * @returns The byte array read
  78118. */
  78119. readUint8Array(byteLength: number): Uint8Array;
  78120. /**
  78121. * Read a string from the currently loaded data range.
  78122. * @param byteLength The byte length to read
  78123. * @returns The string read
  78124. */
  78125. readString(byteLength: number): string;
  78126. /**
  78127. * Skips the given byte length the currently loaded data range.
  78128. * @param byteLength The byte length to skip
  78129. */
  78130. skipBytes(byteLength: number): void;
  78131. }
  78132. }
  78133. declare module "babylonjs/Misc/dataStorage" {
  78134. /**
  78135. * Class for storing data to local storage if available or in-memory storage otherwise
  78136. */
  78137. export class DataStorage {
  78138. private static _Storage;
  78139. private static _GetStorage;
  78140. /**
  78141. * Reads a string from the data storage
  78142. * @param key The key to read
  78143. * @param defaultValue The value if the key doesn't exist
  78144. * @returns The string value
  78145. */
  78146. static ReadString(key: string, defaultValue: string): string;
  78147. /**
  78148. * Writes a string to the data storage
  78149. * @param key The key to write
  78150. * @param value The value to write
  78151. */
  78152. static WriteString(key: string, value: string): void;
  78153. /**
  78154. * Reads a boolean from the data storage
  78155. * @param key The key to read
  78156. * @param defaultValue The value if the key doesn't exist
  78157. * @returns The boolean value
  78158. */
  78159. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  78160. /**
  78161. * Writes a boolean to the data storage
  78162. * @param key The key to write
  78163. * @param value The value to write
  78164. */
  78165. static WriteBoolean(key: string, value: boolean): void;
  78166. /**
  78167. * Reads a number from the data storage
  78168. * @param key The key to read
  78169. * @param defaultValue The value if the key doesn't exist
  78170. * @returns The number value
  78171. */
  78172. static ReadNumber(key: string, defaultValue: number): number;
  78173. /**
  78174. * Writes a number to the data storage
  78175. * @param key The key to write
  78176. * @param value The value to write
  78177. */
  78178. static WriteNumber(key: string, value: number): void;
  78179. }
  78180. }
  78181. declare module "babylonjs/Misc/sceneRecorder" {
  78182. import { Scene } from "babylonjs/scene";
  78183. /**
  78184. * Class used to record delta files between 2 scene states
  78185. */
  78186. export class SceneRecorder {
  78187. private _trackedScene;
  78188. private _savedJSON;
  78189. /**
  78190. * Track a given scene. This means the current scene state will be considered the original state
  78191. * @param scene defines the scene to track
  78192. */
  78193. track(scene: Scene): void;
  78194. /**
  78195. * Get the delta between current state and original state
  78196. * @returns a string containing the delta
  78197. */
  78198. getDelta(): any;
  78199. private _compareArray;
  78200. private _compareObjects;
  78201. private _compareCollections;
  78202. private static GetShadowGeneratorById;
  78203. /**
  78204. * Apply a given delta to a given scene
  78205. * @param deltaJSON defines the JSON containing the delta
  78206. * @param scene defines the scene to apply the delta to
  78207. */
  78208. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  78209. private static _ApplyPropertiesToEntity;
  78210. private static _ApplyDeltaForEntity;
  78211. }
  78212. }
  78213. declare module "babylonjs/Misc/index" {
  78214. export * from "babylonjs/Misc/andOrNotEvaluator";
  78215. export * from "babylonjs/Misc/assetsManager";
  78216. export * from "babylonjs/Misc/basis";
  78217. export * from "babylonjs/Misc/dds";
  78218. export * from "babylonjs/Misc/decorators";
  78219. export * from "babylonjs/Misc/deferred";
  78220. export * from "babylonjs/Misc/environmentTextureTools";
  78221. export * from "babylonjs/Misc/meshExploder";
  78222. export * from "babylonjs/Misc/filesInput";
  78223. export * from "babylonjs/Misc/HighDynamicRange/index";
  78224. export * from "babylonjs/Misc/khronosTextureContainer";
  78225. export * from "babylonjs/Misc/observable";
  78226. export * from "babylonjs/Misc/performanceMonitor";
  78227. export * from "babylonjs/Misc/promise";
  78228. export * from "babylonjs/Misc/sceneOptimizer";
  78229. export * from "babylonjs/Misc/sceneSerializer";
  78230. export * from "babylonjs/Misc/smartArray";
  78231. export * from "babylonjs/Misc/stringDictionary";
  78232. export * from "babylonjs/Misc/tags";
  78233. export * from "babylonjs/Misc/textureTools";
  78234. export * from "babylonjs/Misc/tga";
  78235. export * from "babylonjs/Misc/tools";
  78236. export * from "babylonjs/Misc/videoRecorder";
  78237. export * from "babylonjs/Misc/virtualJoystick";
  78238. export * from "babylonjs/Misc/workerPool";
  78239. export * from "babylonjs/Misc/logger";
  78240. export * from "babylonjs/Misc/typeStore";
  78241. export * from "babylonjs/Misc/filesInputStore";
  78242. export * from "babylonjs/Misc/deepCopier";
  78243. export * from "babylonjs/Misc/pivotTools";
  78244. export * from "babylonjs/Misc/precisionDate";
  78245. export * from "babylonjs/Misc/screenshotTools";
  78246. export * from "babylonjs/Misc/typeStore";
  78247. export * from "babylonjs/Misc/webRequest";
  78248. export * from "babylonjs/Misc/iInspectable";
  78249. export * from "babylonjs/Misc/brdfTextureTools";
  78250. export * from "babylonjs/Misc/rgbdTextureTools";
  78251. export * from "babylonjs/Misc/gradients";
  78252. export * from "babylonjs/Misc/perfCounter";
  78253. export * from "babylonjs/Misc/fileRequest";
  78254. export * from "babylonjs/Misc/customAnimationFrameRequester";
  78255. export * from "babylonjs/Misc/retryStrategy";
  78256. export * from "babylonjs/Misc/interfaces/screenshotSize";
  78257. export * from "babylonjs/Misc/canvasGenerator";
  78258. export * from "babylonjs/Misc/fileTools";
  78259. export * from "babylonjs/Misc/stringTools";
  78260. export * from "babylonjs/Misc/dataReader";
  78261. export * from "babylonjs/Misc/minMaxReducer";
  78262. export * from "babylonjs/Misc/depthReducer";
  78263. export * from "babylonjs/Misc/dataStorage";
  78264. export * from "babylonjs/Misc/sceneRecorder";
  78265. }
  78266. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  78267. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  78268. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78269. import { Observable } from "babylonjs/Misc/observable";
  78270. import { Matrix } from "babylonjs/Maths/math.vector";
  78271. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78272. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78273. /**
  78274. * An interface for all Hit test features
  78275. */
  78276. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  78277. /**
  78278. * Triggered when new babylon (transformed) hit test results are available
  78279. */
  78280. onHitTestResultObservable: Observable<T[]>;
  78281. }
  78282. /**
  78283. * Options used for hit testing
  78284. */
  78285. export interface IWebXRLegacyHitTestOptions {
  78286. /**
  78287. * Only test when user interacted with the scene. Default - hit test every frame
  78288. */
  78289. testOnPointerDownOnly?: boolean;
  78290. /**
  78291. * The node to use to transform the local results to world coordinates
  78292. */
  78293. worldParentNode?: TransformNode;
  78294. }
  78295. /**
  78296. * Interface defining the babylon result of raycasting/hit-test
  78297. */
  78298. export interface IWebXRLegacyHitResult {
  78299. /**
  78300. * Transformation matrix that can be applied to a node that will put it in the hit point location
  78301. */
  78302. transformationMatrix: Matrix;
  78303. /**
  78304. * The native hit test result
  78305. */
  78306. xrHitResult: XRHitResult | XRHitTestResult;
  78307. }
  78308. /**
  78309. * The currently-working hit-test module.
  78310. * Hit test (or Ray-casting) is used to interact with the real world.
  78311. * For further information read here - https://github.com/immersive-web/hit-test
  78312. */
  78313. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  78314. /**
  78315. * options to use when constructing this feature
  78316. */
  78317. readonly options: IWebXRLegacyHitTestOptions;
  78318. private _direction;
  78319. private _mat;
  78320. private _onSelectEnabled;
  78321. private _origin;
  78322. /**
  78323. * The module's name
  78324. */
  78325. static readonly Name: string;
  78326. /**
  78327. * The (Babylon) version of this module.
  78328. * This is an integer representing the implementation version.
  78329. * This number does not correspond to the WebXR specs version
  78330. */
  78331. static readonly Version: number;
  78332. /**
  78333. * Populated with the last native XR Hit Results
  78334. */
  78335. lastNativeXRHitResults: XRHitResult[];
  78336. /**
  78337. * Triggered when new babylon (transformed) hit test results are available
  78338. */
  78339. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  78340. /**
  78341. * Creates a new instance of the (legacy version) hit test feature
  78342. * @param _xrSessionManager an instance of WebXRSessionManager
  78343. * @param options options to use when constructing this feature
  78344. */
  78345. constructor(_xrSessionManager: WebXRSessionManager,
  78346. /**
  78347. * options to use when constructing this feature
  78348. */
  78349. options?: IWebXRLegacyHitTestOptions);
  78350. /**
  78351. * execute a hit test with an XR Ray
  78352. *
  78353. * @param xrSession a native xrSession that will execute this hit test
  78354. * @param xrRay the ray (position and direction) to use for ray-casting
  78355. * @param referenceSpace native XR reference space to use for the hit-test
  78356. * @param filter filter function that will filter the results
  78357. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78358. */
  78359. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  78360. /**
  78361. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  78362. * @param event the (select) event to use to select with
  78363. * @param referenceSpace the reference space to use for this hit test
  78364. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78365. */
  78366. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  78367. /**
  78368. * attach this feature
  78369. * Will usually be called by the features manager
  78370. *
  78371. * @returns true if successful.
  78372. */
  78373. attach(): boolean;
  78374. /**
  78375. * detach this feature.
  78376. * Will usually be called by the features manager
  78377. *
  78378. * @returns true if successful.
  78379. */
  78380. detach(): boolean;
  78381. /**
  78382. * Dispose this feature and all of the resources attached
  78383. */
  78384. dispose(): void;
  78385. protected _onXRFrame(frame: XRFrame): void;
  78386. private _onHitTestResults;
  78387. private _onSelect;
  78388. }
  78389. }
  78390. declare module "babylonjs/XR/features/WebXRHitTest" {
  78391. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78392. import { Observable } from "babylonjs/Misc/observable";
  78393. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78394. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78395. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  78396. /**
  78397. * Options used for hit testing (version 2)
  78398. */
  78399. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  78400. /**
  78401. * Do not create a permanent hit test. Will usually be used when only
  78402. * transient inputs are needed.
  78403. */
  78404. disablePermanentHitTest?: boolean;
  78405. /**
  78406. * Enable transient (for example touch-based) hit test inspections
  78407. */
  78408. enableTransientHitTest?: boolean;
  78409. /**
  78410. * Offset ray for the permanent hit test
  78411. */
  78412. offsetRay?: Vector3;
  78413. /**
  78414. * Offset ray for the transient hit test
  78415. */
  78416. transientOffsetRay?: Vector3;
  78417. /**
  78418. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  78419. */
  78420. useReferenceSpace?: boolean;
  78421. /**
  78422. * Override the default entity type(s) of the hit-test result
  78423. */
  78424. entityTypes?: XRHitTestTrackableType[];
  78425. }
  78426. /**
  78427. * Interface defining the babylon result of hit-test
  78428. */
  78429. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  78430. /**
  78431. * The input source that generated this hit test (if transient)
  78432. */
  78433. inputSource?: XRInputSource;
  78434. /**
  78435. * Is this a transient hit test
  78436. */
  78437. isTransient?: boolean;
  78438. /**
  78439. * Position of the hit test result
  78440. */
  78441. position: Vector3;
  78442. /**
  78443. * Rotation of the hit test result
  78444. */
  78445. rotationQuaternion: Quaternion;
  78446. /**
  78447. * The native hit test result
  78448. */
  78449. xrHitResult: XRHitTestResult;
  78450. }
  78451. /**
  78452. * The currently-working hit-test module.
  78453. * Hit test (or Ray-casting) is used to interact with the real world.
  78454. * For further information read here - https://github.com/immersive-web/hit-test
  78455. *
  78456. * Tested on chrome (mobile) 80.
  78457. */
  78458. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  78459. /**
  78460. * options to use when constructing this feature
  78461. */
  78462. readonly options: IWebXRHitTestOptions;
  78463. private _tmpMat;
  78464. private _tmpPos;
  78465. private _tmpQuat;
  78466. private _transientXrHitTestSource;
  78467. private _xrHitTestSource;
  78468. private initHitTestSource;
  78469. /**
  78470. * The module's name
  78471. */
  78472. static readonly Name: string;
  78473. /**
  78474. * The (Babylon) version of this module.
  78475. * This is an integer representing the implementation version.
  78476. * This number does not correspond to the WebXR specs version
  78477. */
  78478. static readonly Version: number;
  78479. /**
  78480. * When set to true, each hit test will have its own position/rotation objects
  78481. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  78482. * the developers will clone them or copy them as they see fit.
  78483. */
  78484. autoCloneTransformation: boolean;
  78485. /**
  78486. * Triggered when new babylon (transformed) hit test results are available
  78487. */
  78488. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  78489. /**
  78490. * Use this to temporarily pause hit test checks.
  78491. */
  78492. paused: boolean;
  78493. /**
  78494. * Creates a new instance of the hit test feature
  78495. * @param _xrSessionManager an instance of WebXRSessionManager
  78496. * @param options options to use when constructing this feature
  78497. */
  78498. constructor(_xrSessionManager: WebXRSessionManager,
  78499. /**
  78500. * options to use when constructing this feature
  78501. */
  78502. options?: IWebXRHitTestOptions);
  78503. /**
  78504. * attach this feature
  78505. * Will usually be called by the features manager
  78506. *
  78507. * @returns true if successful.
  78508. */
  78509. attach(): boolean;
  78510. /**
  78511. * detach this feature.
  78512. * Will usually be called by the features manager
  78513. *
  78514. * @returns true if successful.
  78515. */
  78516. detach(): boolean;
  78517. /**
  78518. * Dispose this feature and all of the resources attached
  78519. */
  78520. dispose(): void;
  78521. protected _onXRFrame(frame: XRFrame): void;
  78522. private _processWebXRHitTestResult;
  78523. }
  78524. }
  78525. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  78526. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78527. import { Observable } from "babylonjs/Misc/observable";
  78528. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78529. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78530. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78531. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  78532. /**
  78533. * Configuration options of the anchor system
  78534. */
  78535. export interface IWebXRAnchorSystemOptions {
  78536. /**
  78537. * a node that will be used to convert local to world coordinates
  78538. */
  78539. worldParentNode?: TransformNode;
  78540. /**
  78541. * If set to true a reference of the created anchors will be kept until the next session starts
  78542. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  78543. */
  78544. doNotRemoveAnchorsOnSessionEnded?: boolean;
  78545. }
  78546. /**
  78547. * A babylon container for an XR Anchor
  78548. */
  78549. export interface IWebXRAnchor {
  78550. /**
  78551. * A babylon-assigned ID for this anchor
  78552. */
  78553. id: number;
  78554. /**
  78555. * Transformation matrix to apply to an object attached to this anchor
  78556. */
  78557. transformationMatrix: Matrix;
  78558. /**
  78559. * The native anchor object
  78560. */
  78561. xrAnchor: XRAnchor;
  78562. /**
  78563. * if defined, this object will be constantly updated by the anchor's position and rotation
  78564. */
  78565. attachedNode?: TransformNode;
  78566. }
  78567. /**
  78568. * An implementation of the anchor system for WebXR.
  78569. * For further information see https://github.com/immersive-web/anchors/
  78570. */
  78571. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  78572. private _options;
  78573. private _lastFrameDetected;
  78574. private _trackedAnchors;
  78575. private _referenceSpaceForFrameAnchors;
  78576. private _futureAnchors;
  78577. /**
  78578. * The module's name
  78579. */
  78580. static readonly Name: string;
  78581. /**
  78582. * The (Babylon) version of this module.
  78583. * This is an integer representing the implementation version.
  78584. * This number does not correspond to the WebXR specs version
  78585. */
  78586. static readonly Version: number;
  78587. /**
  78588. * Observers registered here will be executed when a new anchor was added to the session
  78589. */
  78590. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  78591. /**
  78592. * Observers registered here will be executed when an anchor was removed from the session
  78593. */
  78594. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  78595. /**
  78596. * Observers registered here will be executed when an existing anchor updates
  78597. * This can execute N times every frame
  78598. */
  78599. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  78600. /**
  78601. * Set the reference space to use for anchor creation, when not using a hit test.
  78602. * Will default to the session's reference space if not defined
  78603. */
  78604. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  78605. /**
  78606. * constructs a new anchor system
  78607. * @param _xrSessionManager an instance of WebXRSessionManager
  78608. * @param _options configuration object for this feature
  78609. */
  78610. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  78611. private _tmpVector;
  78612. private _tmpQuaternion;
  78613. private _populateTmpTransformation;
  78614. /**
  78615. * Create a new anchor point using a hit test result at a specific point in the scene
  78616. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78617. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78618. *
  78619. * @param hitTestResult The hit test result to use for this anchor creation
  78620. * @param position an optional position offset for this anchor
  78621. * @param rotationQuaternion an optional rotation offset for this anchor
  78622. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78623. */
  78624. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  78625. /**
  78626. * Add a new anchor at a specific position and rotation
  78627. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  78628. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  78629. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78630. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78631. *
  78632. * @param position the position in which to add an anchor
  78633. * @param rotationQuaternion an optional rotation for the anchor transformation
  78634. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  78635. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78636. */
  78637. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  78638. /**
  78639. * detach this feature.
  78640. * Will usually be called by the features manager
  78641. *
  78642. * @returns true if successful.
  78643. */
  78644. detach(): boolean;
  78645. /**
  78646. * Dispose this feature and all of the resources attached
  78647. */
  78648. dispose(): void;
  78649. protected _onXRFrame(frame: XRFrame): void;
  78650. /**
  78651. * avoiding using Array.find for global support.
  78652. * @param xrAnchor the plane to find in the array
  78653. */
  78654. private _findIndexInAnchorArray;
  78655. private _updateAnchorWithXRFrame;
  78656. private _createAnchorAtTransformation;
  78657. }
  78658. }
  78659. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  78660. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78661. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78662. import { Observable } from "babylonjs/Misc/observable";
  78663. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  78664. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78665. /**
  78666. * Options used in the plane detector module
  78667. */
  78668. export interface IWebXRPlaneDetectorOptions {
  78669. /**
  78670. * The node to use to transform the local results to world coordinates
  78671. */
  78672. worldParentNode?: TransformNode;
  78673. /**
  78674. * If set to true a reference of the created planes will be kept until the next session starts
  78675. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  78676. */
  78677. doNotRemovePlanesOnSessionEnded?: boolean;
  78678. }
  78679. /**
  78680. * A babylon interface for a WebXR plane.
  78681. * A Plane is actually a polygon, built from N points in space
  78682. *
  78683. * Supported in chrome 79, not supported in canary 81 ATM
  78684. */
  78685. export interface IWebXRPlane {
  78686. /**
  78687. * a babylon-assigned ID for this polygon
  78688. */
  78689. id: number;
  78690. /**
  78691. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  78692. */
  78693. polygonDefinition: Array<Vector3>;
  78694. /**
  78695. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  78696. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  78697. */
  78698. transformationMatrix: Matrix;
  78699. /**
  78700. * the native xr-plane object
  78701. */
  78702. xrPlane: XRPlane;
  78703. }
  78704. /**
  78705. * The plane detector is used to detect planes in the real world when in AR
  78706. * For more information see https://github.com/immersive-web/real-world-geometry/
  78707. */
  78708. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  78709. private _options;
  78710. private _detectedPlanes;
  78711. private _enabled;
  78712. private _lastFrameDetected;
  78713. /**
  78714. * The module's name
  78715. */
  78716. static readonly Name: string;
  78717. /**
  78718. * The (Babylon) version of this module.
  78719. * This is an integer representing the implementation version.
  78720. * This number does not correspond to the WebXR specs version
  78721. */
  78722. static readonly Version: number;
  78723. /**
  78724. * Observers registered here will be executed when a new plane was added to the session
  78725. */
  78726. onPlaneAddedObservable: Observable<IWebXRPlane>;
  78727. /**
  78728. * Observers registered here will be executed when a plane is no longer detected in the session
  78729. */
  78730. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  78731. /**
  78732. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  78733. * This can execute N times every frame
  78734. */
  78735. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  78736. /**
  78737. * construct a new Plane Detector
  78738. * @param _xrSessionManager an instance of xr Session manager
  78739. * @param _options configuration to use when constructing this feature
  78740. */
  78741. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  78742. /**
  78743. * detach this feature.
  78744. * Will usually be called by the features manager
  78745. *
  78746. * @returns true if successful.
  78747. */
  78748. detach(): boolean;
  78749. /**
  78750. * Dispose this feature and all of the resources attached
  78751. */
  78752. dispose(): void;
  78753. protected _onXRFrame(frame: XRFrame): void;
  78754. private _init;
  78755. private _updatePlaneWithXRPlane;
  78756. /**
  78757. * avoiding using Array.find for global support.
  78758. * @param xrPlane the plane to find in the array
  78759. */
  78760. private findIndexInPlaneArray;
  78761. }
  78762. }
  78763. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  78764. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78765. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78766. import { Observable } from "babylonjs/Misc/observable";
  78767. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78768. /**
  78769. * Options interface for the background remover plugin
  78770. */
  78771. export interface IWebXRBackgroundRemoverOptions {
  78772. /**
  78773. * Further background meshes to disable when entering AR
  78774. */
  78775. backgroundMeshes?: AbstractMesh[];
  78776. /**
  78777. * flags to configure the removal of the environment helper.
  78778. * If not set, the entire background will be removed. If set, flags should be set as well.
  78779. */
  78780. environmentHelperRemovalFlags?: {
  78781. /**
  78782. * Should the skybox be removed (default false)
  78783. */
  78784. skyBox?: boolean;
  78785. /**
  78786. * Should the ground be removed (default false)
  78787. */
  78788. ground?: boolean;
  78789. };
  78790. /**
  78791. * don't disable the environment helper
  78792. */
  78793. ignoreEnvironmentHelper?: boolean;
  78794. }
  78795. /**
  78796. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  78797. */
  78798. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  78799. /**
  78800. * read-only options to be used in this module
  78801. */
  78802. readonly options: IWebXRBackgroundRemoverOptions;
  78803. /**
  78804. * The module's name
  78805. */
  78806. static readonly Name: string;
  78807. /**
  78808. * The (Babylon) version of this module.
  78809. * This is an integer representing the implementation version.
  78810. * This number does not correspond to the WebXR specs version
  78811. */
  78812. static readonly Version: number;
  78813. /**
  78814. * registered observers will be triggered when the background state changes
  78815. */
  78816. onBackgroundStateChangedObservable: Observable<boolean>;
  78817. /**
  78818. * constructs a new background remover module
  78819. * @param _xrSessionManager the session manager for this module
  78820. * @param options read-only options to be used in this module
  78821. */
  78822. constructor(_xrSessionManager: WebXRSessionManager,
  78823. /**
  78824. * read-only options to be used in this module
  78825. */
  78826. options?: IWebXRBackgroundRemoverOptions);
  78827. /**
  78828. * attach this feature
  78829. * Will usually be called by the features manager
  78830. *
  78831. * @returns true if successful.
  78832. */
  78833. attach(): boolean;
  78834. /**
  78835. * detach this feature.
  78836. * Will usually be called by the features manager
  78837. *
  78838. * @returns true if successful.
  78839. */
  78840. detach(): boolean;
  78841. /**
  78842. * Dispose this feature and all of the resources attached
  78843. */
  78844. dispose(): void;
  78845. protected _onXRFrame(_xrFrame: XRFrame): void;
  78846. private _setBackgroundState;
  78847. }
  78848. }
  78849. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  78850. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78851. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  78852. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  78853. import { WebXRInput } from "babylonjs/XR/webXRInput";
  78854. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78855. import { Nullable } from "babylonjs/types";
  78856. /**
  78857. * Options for the controller physics feature
  78858. */
  78859. export class IWebXRControllerPhysicsOptions {
  78860. /**
  78861. * Should the headset get its own impostor
  78862. */
  78863. enableHeadsetImpostor?: boolean;
  78864. /**
  78865. * Optional parameters for the headset impostor
  78866. */
  78867. headsetImpostorParams?: {
  78868. /**
  78869. * The type of impostor to create. Default is sphere
  78870. */
  78871. impostorType: number;
  78872. /**
  78873. * the size of the impostor. Defaults to 10cm
  78874. */
  78875. impostorSize?: number | {
  78876. width: number;
  78877. height: number;
  78878. depth: number;
  78879. };
  78880. /**
  78881. * Friction definitions
  78882. */
  78883. friction?: number;
  78884. /**
  78885. * Restitution
  78886. */
  78887. restitution?: number;
  78888. };
  78889. /**
  78890. * The physics properties of the future impostors
  78891. */
  78892. physicsProperties?: {
  78893. /**
  78894. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  78895. * Note that this requires a physics engine that supports mesh impostors!
  78896. */
  78897. useControllerMesh?: boolean;
  78898. /**
  78899. * The type of impostor to create. Default is sphere
  78900. */
  78901. impostorType?: number;
  78902. /**
  78903. * the size of the impostor. Defaults to 10cm
  78904. */
  78905. impostorSize?: number | {
  78906. width: number;
  78907. height: number;
  78908. depth: number;
  78909. };
  78910. /**
  78911. * Friction definitions
  78912. */
  78913. friction?: number;
  78914. /**
  78915. * Restitution
  78916. */
  78917. restitution?: number;
  78918. };
  78919. /**
  78920. * the xr input to use with this pointer selection
  78921. */
  78922. xrInput: WebXRInput;
  78923. }
  78924. /**
  78925. * Add physics impostor to your webxr controllers,
  78926. * including naive calculation of their linear and angular velocity
  78927. */
  78928. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  78929. private readonly _options;
  78930. private _attachController;
  78931. private _controllers;
  78932. private _debugMode;
  78933. private _delta;
  78934. private _headsetImpostor?;
  78935. private _headsetMesh?;
  78936. private _lastTimestamp;
  78937. private _tmpQuaternion;
  78938. private _tmpVector;
  78939. /**
  78940. * The module's name
  78941. */
  78942. static readonly Name: string;
  78943. /**
  78944. * The (Babylon) version of this module.
  78945. * This is an integer representing the implementation version.
  78946. * This number does not correspond to the webxr specs version
  78947. */
  78948. static readonly Version: number;
  78949. /**
  78950. * Construct a new Controller Physics Feature
  78951. * @param _xrSessionManager the corresponding xr session manager
  78952. * @param _options options to create this feature with
  78953. */
  78954. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  78955. /**
  78956. * @hidden
  78957. * enable debugging - will show console outputs and the impostor mesh
  78958. */
  78959. _enablePhysicsDebug(): void;
  78960. /**
  78961. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  78962. * @param xrController the controller to add
  78963. */
  78964. addController(xrController: WebXRInputSource): void;
  78965. /**
  78966. * attach this feature
  78967. * Will usually be called by the features manager
  78968. *
  78969. * @returns true if successful.
  78970. */
  78971. attach(): boolean;
  78972. /**
  78973. * detach this feature.
  78974. * Will usually be called by the features manager
  78975. *
  78976. * @returns true if successful.
  78977. */
  78978. detach(): boolean;
  78979. /**
  78980. * Get the headset impostor, if enabled
  78981. * @returns the impostor
  78982. */
  78983. getHeadsetImpostor(): PhysicsImpostor | undefined;
  78984. /**
  78985. * Get the physics impostor of a specific controller.
  78986. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  78987. * @param controller the controller or the controller id of which to get the impostor
  78988. * @returns the impostor or null
  78989. */
  78990. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  78991. /**
  78992. * Update the physics properties provided in the constructor
  78993. * @param newProperties the new properties object
  78994. */
  78995. setPhysicsProperties(newProperties: {
  78996. impostorType?: number;
  78997. impostorSize?: number | {
  78998. width: number;
  78999. height: number;
  79000. depth: number;
  79001. };
  79002. friction?: number;
  79003. restitution?: number;
  79004. }): void;
  79005. protected _onXRFrame(_xrFrame: any): void;
  79006. private _detachController;
  79007. }
  79008. }
  79009. declare module "babylonjs/XR/features/WebXRFeaturePointSystem" {
  79010. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79011. import { Observable } from "babylonjs/Misc/observable";
  79012. import { Vector3 } from "babylonjs/Maths/math.vector";
  79013. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79014. /**
  79015. * A babylon interface for a "WebXR" feature point.
  79016. * Represents the position and confidence value of a given feature point.
  79017. */
  79018. export interface IWebXRFeaturePoint {
  79019. /**
  79020. * Represents the position of the feature point in world space.
  79021. */
  79022. position: Vector3;
  79023. /**
  79024. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  79025. */
  79026. confidenceValue: number;
  79027. }
  79028. /**
  79029. * The feature point system is used to detect feature points from real world geometry.
  79030. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  79031. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  79032. */
  79033. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  79034. private _enabled;
  79035. private _featurePointCloud;
  79036. /**
  79037. * The module's name
  79038. */
  79039. static readonly Name: string;
  79040. /**
  79041. * The (Babylon) version of this module.
  79042. * This is an integer representing the implementation version.
  79043. * This number does not correspond to the WebXR specs version
  79044. */
  79045. static readonly Version: number;
  79046. /**
  79047. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  79048. * Will notify the observers about which feature points have been added.
  79049. */
  79050. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  79051. /**
  79052. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  79053. * Will notify the observers about which feature points have been updated.
  79054. */
  79055. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  79056. /**
  79057. * The current feature point cloud maintained across frames.
  79058. */
  79059. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  79060. /**
  79061. * construct the feature point system
  79062. * @param _xrSessionManager an instance of xr Session manager
  79063. */
  79064. constructor(_xrSessionManager: WebXRSessionManager);
  79065. /**
  79066. * Detach this feature.
  79067. * Will usually be called by the features manager
  79068. *
  79069. * @returns true if successful.
  79070. */
  79071. detach(): boolean;
  79072. /**
  79073. * Dispose this feature and all of the resources attached
  79074. */
  79075. dispose(): void;
  79076. /**
  79077. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  79078. */
  79079. protected _onXRFrame(frame: XRFrame): void;
  79080. /**
  79081. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  79082. */
  79083. private _init;
  79084. }
  79085. }
  79086. declare module "babylonjs/XR/features/WebXRHandTracking" {
  79087. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79088. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79089. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79090. import { Mesh } from "babylonjs/Meshes/mesh";
  79091. import { WebXRInput } from "babylonjs/XR/webXRInput";
  79092. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  79093. import { Nullable } from "babylonjs/types";
  79094. import { IDisposable } from "babylonjs/scene";
  79095. import { Observable } from "babylonjs/Misc/observable";
  79096. /**
  79097. * Configuration interface for the hand tracking feature
  79098. */
  79099. export interface IWebXRHandTrackingOptions {
  79100. /**
  79101. * The xrInput that will be used as source for new hands
  79102. */
  79103. xrInput: WebXRInput;
  79104. /**
  79105. * Configuration object for the joint meshes
  79106. */
  79107. jointMeshes?: {
  79108. /**
  79109. * Should the meshes created be invisible (defaults to false)
  79110. */
  79111. invisible?: boolean;
  79112. /**
  79113. * A source mesh to be used to create instances. Defaults to a sphere.
  79114. * This mesh will be the source for all other (25) meshes.
  79115. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  79116. */
  79117. sourceMesh?: Mesh;
  79118. /**
  79119. * Should the source mesh stay visible. Defaults to false
  79120. */
  79121. keepOriginalVisible?: boolean;
  79122. /**
  79123. * Scale factor for all instances (defaults to 2)
  79124. */
  79125. scaleFactor?: number;
  79126. /**
  79127. * Should each instance have its own physics impostor
  79128. */
  79129. enablePhysics?: boolean;
  79130. /**
  79131. * If enabled, override default physics properties
  79132. */
  79133. physicsProps?: {
  79134. friction?: number;
  79135. restitution?: number;
  79136. impostorType?: number;
  79137. };
  79138. /**
  79139. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  79140. */
  79141. handMesh?: AbstractMesh;
  79142. };
  79143. }
  79144. /**
  79145. * Parts of the hands divided to writs and finger names
  79146. */
  79147. export const enum HandPart {
  79148. /**
  79149. * HandPart - Wrist
  79150. */
  79151. WRIST = "wrist",
  79152. /**
  79153. * HandPart - The THumb
  79154. */
  79155. THUMB = "thumb",
  79156. /**
  79157. * HandPart - Index finger
  79158. */
  79159. INDEX = "index",
  79160. /**
  79161. * HandPart - Middle finger
  79162. */
  79163. MIDDLE = "middle",
  79164. /**
  79165. * HandPart - Ring finger
  79166. */
  79167. RING = "ring",
  79168. /**
  79169. * HandPart - Little finger
  79170. */
  79171. LITTLE = "little"
  79172. }
  79173. /**
  79174. * Representing a single hand (with its corresponding native XRHand object)
  79175. */
  79176. export class WebXRHand implements IDisposable {
  79177. /** the controller to which the hand correlates */
  79178. readonly xrController: WebXRInputSource;
  79179. /** the meshes to be used to track the hand joints */
  79180. readonly trackedMeshes: AbstractMesh[];
  79181. /**
  79182. * Hand-parts definition (key is HandPart)
  79183. */
  79184. static HandPartsDefinition: {
  79185. [key: string]: number[];
  79186. };
  79187. /**
  79188. * Populate the HandPartsDefinition object.
  79189. * This is called as a side effect since certain browsers don't have XRHand defined.
  79190. */
  79191. static _PopulateHandPartsDefinition(): void;
  79192. /**
  79193. * Construct a new hand object
  79194. * @param xrController the controller to which the hand correlates
  79195. * @param trackedMeshes the meshes to be used to track the hand joints
  79196. */
  79197. constructor(
  79198. /** the controller to which the hand correlates */
  79199. xrController: WebXRInputSource,
  79200. /** the meshes to be used to track the hand joints */
  79201. trackedMeshes: AbstractMesh[]);
  79202. /**
  79203. * Update this hand from the latest xr frame
  79204. * @param xrFrame xrFrame to update from
  79205. * @param referenceSpace The current viewer reference space
  79206. * @param scaleFactor optional scale factor for the meshes
  79207. */
  79208. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  79209. /**
  79210. * Get meshes of part of the hand
  79211. * @param part the part of hand to get
  79212. * @returns An array of meshes that correlate to the hand part requested
  79213. */
  79214. getHandPartMeshes(part: HandPart): AbstractMesh[];
  79215. /**
  79216. * Dispose this Hand object
  79217. */
  79218. dispose(): void;
  79219. }
  79220. /**
  79221. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  79222. */
  79223. export class WebXRHandTracking extends WebXRAbstractFeature {
  79224. /**
  79225. * options to use when constructing this feature
  79226. */
  79227. readonly options: IWebXRHandTrackingOptions;
  79228. private static _idCounter;
  79229. /**
  79230. * The module's name
  79231. */
  79232. static readonly Name: string;
  79233. /**
  79234. * The (Babylon) version of this module.
  79235. * This is an integer representing the implementation version.
  79236. * This number does not correspond to the WebXR specs version
  79237. */
  79238. static readonly Version: number;
  79239. /**
  79240. * This observable will notify registered observers when a new hand object was added and initialized
  79241. */
  79242. onHandAddedObservable: Observable<WebXRHand>;
  79243. /**
  79244. * This observable will notify its observers right before the hand object is disposed
  79245. */
  79246. onHandRemovedObservable: Observable<WebXRHand>;
  79247. private _hands;
  79248. /**
  79249. * Creates a new instance of the hit test feature
  79250. * @param _xrSessionManager an instance of WebXRSessionManager
  79251. * @param options options to use when constructing this feature
  79252. */
  79253. constructor(_xrSessionManager: WebXRSessionManager,
  79254. /**
  79255. * options to use when constructing this feature
  79256. */
  79257. options: IWebXRHandTrackingOptions);
  79258. /**
  79259. * Check if the needed objects are defined.
  79260. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  79261. */
  79262. isCompatible(): boolean;
  79263. /**
  79264. * attach this feature
  79265. * Will usually be called by the features manager
  79266. *
  79267. * @returns true if successful.
  79268. */
  79269. attach(): boolean;
  79270. /**
  79271. * detach this feature.
  79272. * Will usually be called by the features manager
  79273. *
  79274. * @returns true if successful.
  79275. */
  79276. detach(): boolean;
  79277. /**
  79278. * Dispose this feature and all of the resources attached
  79279. */
  79280. dispose(): void;
  79281. /**
  79282. * Get the hand object according to the controller id
  79283. * @param controllerId the controller id to which we want to get the hand
  79284. * @returns null if not found or the WebXRHand object if found
  79285. */
  79286. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  79287. /**
  79288. * Get a hand object according to the requested handedness
  79289. * @param handedness the handedness to request
  79290. * @returns null if not found or the WebXRHand object if found
  79291. */
  79292. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  79293. protected _onXRFrame(_xrFrame: XRFrame): void;
  79294. private _attachHand;
  79295. private _detachHand;
  79296. }
  79297. }
  79298. declare module "babylonjs/XR/features/index" {
  79299. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  79300. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  79301. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  79302. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  79303. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  79304. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  79305. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  79306. export * from "babylonjs/XR/features/WebXRHitTest";
  79307. export * from "babylonjs/XR/features/WebXRFeaturePointSystem";
  79308. export * from "babylonjs/XR/features/WebXRHandTracking";
  79309. }
  79310. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  79311. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79312. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79313. import { Scene } from "babylonjs/scene";
  79314. /**
  79315. * The motion controller class for all microsoft mixed reality controllers
  79316. */
  79317. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  79318. protected readonly _mapping: {
  79319. defaultButton: {
  79320. valueNodeName: string;
  79321. unpressedNodeName: string;
  79322. pressedNodeName: string;
  79323. };
  79324. defaultAxis: {
  79325. valueNodeName: string;
  79326. minNodeName: string;
  79327. maxNodeName: string;
  79328. };
  79329. buttons: {
  79330. "xr-standard-trigger": {
  79331. rootNodeName: string;
  79332. componentProperty: string;
  79333. states: string[];
  79334. };
  79335. "xr-standard-squeeze": {
  79336. rootNodeName: string;
  79337. componentProperty: string;
  79338. states: string[];
  79339. };
  79340. "xr-standard-touchpad": {
  79341. rootNodeName: string;
  79342. labelAnchorNodeName: string;
  79343. touchPointNodeName: string;
  79344. };
  79345. "xr-standard-thumbstick": {
  79346. rootNodeName: string;
  79347. componentProperty: string;
  79348. states: string[];
  79349. };
  79350. };
  79351. axes: {
  79352. "xr-standard-touchpad": {
  79353. "x-axis": {
  79354. rootNodeName: string;
  79355. };
  79356. "y-axis": {
  79357. rootNodeName: string;
  79358. };
  79359. };
  79360. "xr-standard-thumbstick": {
  79361. "x-axis": {
  79362. rootNodeName: string;
  79363. };
  79364. "y-axis": {
  79365. rootNodeName: string;
  79366. };
  79367. };
  79368. };
  79369. };
  79370. /**
  79371. * The base url used to load the left and right controller models
  79372. */
  79373. static MODEL_BASE_URL: string;
  79374. /**
  79375. * The name of the left controller model file
  79376. */
  79377. static MODEL_LEFT_FILENAME: string;
  79378. /**
  79379. * The name of the right controller model file
  79380. */
  79381. static MODEL_RIGHT_FILENAME: string;
  79382. profileId: string;
  79383. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79384. protected _getFilenameAndPath(): {
  79385. filename: string;
  79386. path: string;
  79387. };
  79388. protected _getModelLoadingConstraints(): boolean;
  79389. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79390. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79391. protected _updateModel(): void;
  79392. }
  79393. }
  79394. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  79395. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79396. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79397. import { Scene } from "babylonjs/scene";
  79398. /**
  79399. * The motion controller class for oculus touch (quest, rift).
  79400. * This class supports legacy mapping as well the standard xr mapping
  79401. */
  79402. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  79403. private _forceLegacyControllers;
  79404. private _modelRootNode;
  79405. /**
  79406. * The base url used to load the left and right controller models
  79407. */
  79408. static MODEL_BASE_URL: string;
  79409. /**
  79410. * The name of the left controller model file
  79411. */
  79412. static MODEL_LEFT_FILENAME: string;
  79413. /**
  79414. * The name of the right controller model file
  79415. */
  79416. static MODEL_RIGHT_FILENAME: string;
  79417. /**
  79418. * Base Url for the Quest controller model.
  79419. */
  79420. static QUEST_MODEL_BASE_URL: string;
  79421. profileId: string;
  79422. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  79423. protected _getFilenameAndPath(): {
  79424. filename: string;
  79425. path: string;
  79426. };
  79427. protected _getModelLoadingConstraints(): boolean;
  79428. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79429. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79430. protected _updateModel(): void;
  79431. /**
  79432. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  79433. * between the touch and touch 2.
  79434. */
  79435. private _isQuest;
  79436. }
  79437. }
  79438. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  79439. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79440. import { Scene } from "babylonjs/scene";
  79441. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79442. /**
  79443. * The motion controller class for the standard HTC-Vive controllers
  79444. */
  79445. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  79446. private _modelRootNode;
  79447. /**
  79448. * The base url used to load the left and right controller models
  79449. */
  79450. static MODEL_BASE_URL: string;
  79451. /**
  79452. * File name for the controller model.
  79453. */
  79454. static MODEL_FILENAME: string;
  79455. profileId: string;
  79456. /**
  79457. * Create a new Vive motion controller object
  79458. * @param scene the scene to use to create this controller
  79459. * @param gamepadObject the corresponding gamepad object
  79460. * @param handedness the handedness of the controller
  79461. */
  79462. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79463. protected _getFilenameAndPath(): {
  79464. filename: string;
  79465. path: string;
  79466. };
  79467. protected _getModelLoadingConstraints(): boolean;
  79468. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79469. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79470. protected _updateModel(): void;
  79471. }
  79472. }
  79473. declare module "babylonjs/XR/motionController/index" {
  79474. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79475. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  79476. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  79477. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  79478. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  79479. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  79480. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  79481. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  79482. }
  79483. declare module "babylonjs/XR/index" {
  79484. export * from "babylonjs/XR/webXRCamera";
  79485. export * from "babylonjs/XR/webXREnterExitUI";
  79486. export * from "babylonjs/XR/webXRExperienceHelper";
  79487. export * from "babylonjs/XR/webXRInput";
  79488. export * from "babylonjs/XR/webXRInputSource";
  79489. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  79490. export * from "babylonjs/XR/webXRTypes";
  79491. export * from "babylonjs/XR/webXRSessionManager";
  79492. export * from "babylonjs/XR/webXRDefaultExperience";
  79493. export * from "babylonjs/XR/webXRFeaturesManager";
  79494. export * from "babylonjs/XR/features/index";
  79495. export * from "babylonjs/XR/motionController/index";
  79496. }
  79497. declare module "babylonjs/index" {
  79498. export * from "babylonjs/abstractScene";
  79499. export * from "babylonjs/Actions/index";
  79500. export * from "babylonjs/Animations/index";
  79501. export * from "babylonjs/assetContainer";
  79502. export * from "babylonjs/Audio/index";
  79503. export * from "babylonjs/Behaviors/index";
  79504. export * from "babylonjs/Bones/index";
  79505. export * from "babylonjs/Cameras/index";
  79506. export * from "babylonjs/Collisions/index";
  79507. export * from "babylonjs/Culling/index";
  79508. export * from "babylonjs/Debug/index";
  79509. export * from "babylonjs/DeviceInput/index";
  79510. export * from "babylonjs/Engines/index";
  79511. export * from "babylonjs/Events/index";
  79512. export * from "babylonjs/Gamepads/index";
  79513. export * from "babylonjs/Gizmos/index";
  79514. export * from "babylonjs/Helpers/index";
  79515. export * from "babylonjs/Instrumentation/index";
  79516. export * from "babylonjs/Layers/index";
  79517. export * from "babylonjs/LensFlares/index";
  79518. export * from "babylonjs/Lights/index";
  79519. export * from "babylonjs/Loading/index";
  79520. export * from "babylonjs/Materials/index";
  79521. export * from "babylonjs/Maths/index";
  79522. export * from "babylonjs/Meshes/index";
  79523. export * from "babylonjs/Morph/index";
  79524. export * from "babylonjs/Navigation/index";
  79525. export * from "babylonjs/node";
  79526. export * from "babylonjs/Offline/index";
  79527. export * from "babylonjs/Particles/index";
  79528. export * from "babylonjs/Physics/index";
  79529. export * from "babylonjs/PostProcesses/index";
  79530. export * from "babylonjs/Probes/index";
  79531. export * from "babylonjs/Rendering/index";
  79532. export * from "babylonjs/scene";
  79533. export * from "babylonjs/sceneComponent";
  79534. export * from "babylonjs/Sprites/index";
  79535. export * from "babylonjs/States/index";
  79536. export * from "babylonjs/Misc/index";
  79537. export * from "babylonjs/XR/index";
  79538. export * from "babylonjs/types";
  79539. }
  79540. declare module "babylonjs/Animations/pathCursor" {
  79541. import { Vector3 } from "babylonjs/Maths/math.vector";
  79542. import { Path2 } from "babylonjs/Maths/math.path";
  79543. /**
  79544. * A cursor which tracks a point on a path
  79545. */
  79546. export class PathCursor {
  79547. private path;
  79548. /**
  79549. * Stores path cursor callbacks for when an onchange event is triggered
  79550. */
  79551. private _onchange;
  79552. /**
  79553. * The value of the path cursor
  79554. */
  79555. value: number;
  79556. /**
  79557. * The animation array of the path cursor
  79558. */
  79559. animations: Animation[];
  79560. /**
  79561. * Initializes the path cursor
  79562. * @param path The path to track
  79563. */
  79564. constructor(path: Path2);
  79565. /**
  79566. * Gets the cursor point on the path
  79567. * @returns A point on the path cursor at the cursor location
  79568. */
  79569. getPoint(): Vector3;
  79570. /**
  79571. * Moves the cursor ahead by the step amount
  79572. * @param step The amount to move the cursor forward
  79573. * @returns This path cursor
  79574. */
  79575. moveAhead(step?: number): PathCursor;
  79576. /**
  79577. * Moves the cursor behind by the step amount
  79578. * @param step The amount to move the cursor back
  79579. * @returns This path cursor
  79580. */
  79581. moveBack(step?: number): PathCursor;
  79582. /**
  79583. * Moves the cursor by the step amount
  79584. * If the step amount is greater than one, an exception is thrown
  79585. * @param step The amount to move the cursor
  79586. * @returns This path cursor
  79587. */
  79588. move(step: number): PathCursor;
  79589. /**
  79590. * Ensures that the value is limited between zero and one
  79591. * @returns This path cursor
  79592. */
  79593. private ensureLimits;
  79594. /**
  79595. * Runs onchange callbacks on change (used by the animation engine)
  79596. * @returns This path cursor
  79597. */
  79598. private raiseOnChange;
  79599. /**
  79600. * Executes a function on change
  79601. * @param f A path cursor onchange callback
  79602. * @returns This path cursor
  79603. */
  79604. onchange(f: (cursor: PathCursor) => void): PathCursor;
  79605. }
  79606. }
  79607. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  79608. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  79609. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  79610. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  79611. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  79612. }
  79613. declare module "babylonjs/Engines/Processors/Expressions/index" {
  79614. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  79615. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  79616. }
  79617. declare module "babylonjs/Engines/Processors/index" {
  79618. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  79619. export * from "babylonjs/Engines/Processors/Expressions/index";
  79620. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  79621. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  79622. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  79623. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  79624. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  79625. export * from "babylonjs/Engines/Processors/shaderProcessor";
  79626. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  79627. }
  79628. declare module "babylonjs/Legacy/legacy" {
  79629. import * as Babylon from "babylonjs/index";
  79630. export * from "babylonjs/index";
  79631. }
  79632. declare module "babylonjs/Shaders/blur.fragment" {
  79633. /** @hidden */
  79634. export var blurPixelShader: {
  79635. name: string;
  79636. shader: string;
  79637. };
  79638. }
  79639. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  79640. /** @hidden */
  79641. export var pointCloudVertexDeclaration: {
  79642. name: string;
  79643. shader: string;
  79644. };
  79645. }
  79646. declare module "babylonjs" {
  79647. export * from "babylonjs/Legacy/legacy";
  79648. }
  79649. declare module BABYLON {
  79650. /** Alias type for value that can be null */
  79651. export type Nullable<T> = T | null;
  79652. /**
  79653. * Alias type for number that are floats
  79654. * @ignorenaming
  79655. */
  79656. export type float = number;
  79657. /**
  79658. * Alias type for number that are doubles.
  79659. * @ignorenaming
  79660. */
  79661. export type double = number;
  79662. /**
  79663. * Alias type for number that are integer
  79664. * @ignorenaming
  79665. */
  79666. export type int = number;
  79667. /** Alias type for number array or Float32Array */
  79668. export type FloatArray = number[] | Float32Array;
  79669. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  79670. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  79671. /**
  79672. * Alias for types that can be used by a Buffer or VertexBuffer.
  79673. */
  79674. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  79675. /**
  79676. * Alias type for primitive types
  79677. * @ignorenaming
  79678. */
  79679. type Primitive = undefined | null | boolean | string | number | Function;
  79680. /**
  79681. * Type modifier to make all the properties of an object Readonly
  79682. */
  79683. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  79684. /**
  79685. * Type modifier to make all the properties of an object Readonly recursively
  79686. */
  79687. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  79688. /**
  79689. * Type modifier to make object properties readonly.
  79690. */
  79691. export type DeepImmutableObject<T> = {
  79692. readonly [K in keyof T]: DeepImmutable<T[K]>;
  79693. };
  79694. /** @hidden */
  79695. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  79696. }
  79697. }
  79698. declare module BABYLON {
  79699. /**
  79700. * A class serves as a medium between the observable and its observers
  79701. */
  79702. export class EventState {
  79703. /**
  79704. * Create a new EventState
  79705. * @param mask defines the mask associated with this state
  79706. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79707. * @param target defines the original target of the state
  79708. * @param currentTarget defines the current target of the state
  79709. */
  79710. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  79711. /**
  79712. * Initialize the current event state
  79713. * @param mask defines the mask associated with this state
  79714. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79715. * @param target defines the original target of the state
  79716. * @param currentTarget defines the current target of the state
  79717. * @returns the current event state
  79718. */
  79719. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  79720. /**
  79721. * An Observer can set this property to true to prevent subsequent observers of being notified
  79722. */
  79723. skipNextObservers: boolean;
  79724. /**
  79725. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79726. */
  79727. mask: number;
  79728. /**
  79729. * The object that originally notified the event
  79730. */
  79731. target?: any;
  79732. /**
  79733. * The current object in the bubbling phase
  79734. */
  79735. currentTarget?: any;
  79736. /**
  79737. * This will be populated with the return value of the last function that was executed.
  79738. * If it is the first function in the callback chain it will be the event data.
  79739. */
  79740. lastReturnValue?: any;
  79741. }
  79742. /**
  79743. * Represent an Observer registered to a given Observable object.
  79744. */
  79745. export class Observer<T> {
  79746. /**
  79747. * Defines the callback to call when the observer is notified
  79748. */
  79749. callback: (eventData: T, eventState: EventState) => void;
  79750. /**
  79751. * Defines the mask of the observer (used to filter notifications)
  79752. */
  79753. mask: number;
  79754. /**
  79755. * Defines the current scope used to restore the JS context
  79756. */
  79757. scope: any;
  79758. /** @hidden */
  79759. _willBeUnregistered: boolean;
  79760. /**
  79761. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  79762. */
  79763. unregisterOnNextCall: boolean;
  79764. /**
  79765. * Creates a new observer
  79766. * @param callback defines the callback to call when the observer is notified
  79767. * @param mask defines the mask of the observer (used to filter notifications)
  79768. * @param scope defines the current scope used to restore the JS context
  79769. */
  79770. constructor(
  79771. /**
  79772. * Defines the callback to call when the observer is notified
  79773. */
  79774. callback: (eventData: T, eventState: EventState) => void,
  79775. /**
  79776. * Defines the mask of the observer (used to filter notifications)
  79777. */
  79778. mask: number,
  79779. /**
  79780. * Defines the current scope used to restore the JS context
  79781. */
  79782. scope?: any);
  79783. }
  79784. /**
  79785. * Represent a list of observers registered to multiple Observables object.
  79786. */
  79787. export class MultiObserver<T> {
  79788. private _observers;
  79789. private _observables;
  79790. /**
  79791. * Release associated resources
  79792. */
  79793. dispose(): void;
  79794. /**
  79795. * Raise a callback when one of the observable will notify
  79796. * @param observables defines a list of observables to watch
  79797. * @param callback defines the callback to call on notification
  79798. * @param mask defines the mask used to filter notifications
  79799. * @param scope defines the current scope used to restore the JS context
  79800. * @returns the new MultiObserver
  79801. */
  79802. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  79803. }
  79804. /**
  79805. * The Observable class is a simple implementation of the Observable pattern.
  79806. *
  79807. * 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.
  79808. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  79809. * 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).
  79810. * 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.
  79811. */
  79812. export class Observable<T> {
  79813. private _observers;
  79814. private _eventState;
  79815. private _onObserverAdded;
  79816. /**
  79817. * Gets the list of observers
  79818. */
  79819. get observers(): Array<Observer<T>>;
  79820. /**
  79821. * Creates a new observable
  79822. * @param onObserverAdded defines a callback to call when a new observer is added
  79823. */
  79824. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  79825. /**
  79826. * Create a new Observer with the specified callback
  79827. * @param callback the callback that will be executed for that Observer
  79828. * @param mask the mask used to filter observers
  79829. * @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.
  79830. * @param scope optional scope for the callback to be called from
  79831. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  79832. * @returns the new observer created for the callback
  79833. */
  79834. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  79835. /**
  79836. * Create a new Observer with the specified callback and unregisters after the next notification
  79837. * @param callback the callback that will be executed for that Observer
  79838. * @returns the new observer created for the callback
  79839. */
  79840. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  79841. /**
  79842. * Remove an Observer from the Observable object
  79843. * @param observer the instance of the Observer to remove
  79844. * @returns false if it doesn't belong to this Observable
  79845. */
  79846. remove(observer: Nullable<Observer<T>>): boolean;
  79847. /**
  79848. * Remove a callback from the Observable object
  79849. * @param callback the callback to remove
  79850. * @param scope optional scope. If used only the callbacks with this scope will be removed
  79851. * @returns false if it doesn't belong to this Observable
  79852. */
  79853. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  79854. private _deferUnregister;
  79855. private _remove;
  79856. /**
  79857. * Moves the observable to the top of the observer list making it get called first when notified
  79858. * @param observer the observer to move
  79859. */
  79860. makeObserverTopPriority(observer: Observer<T>): void;
  79861. /**
  79862. * Moves the observable to the bottom of the observer list making it get called last when notified
  79863. * @param observer the observer to move
  79864. */
  79865. makeObserverBottomPriority(observer: Observer<T>): void;
  79866. /**
  79867. * Notify all Observers by calling their respective callback with the given data
  79868. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  79869. * @param eventData defines the data to send to all observers
  79870. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  79871. * @param target defines the original target of the state
  79872. * @param currentTarget defines the current target of the state
  79873. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  79874. */
  79875. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  79876. /**
  79877. * Calling this will execute each callback, expecting it to be a promise or return a value.
  79878. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  79879. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  79880. * and it is crucial that all callbacks will be executed.
  79881. * The order of the callbacks is kept, callbacks are not executed parallel.
  79882. *
  79883. * @param eventData The data to be sent to each callback
  79884. * @param mask is used to filter observers defaults to -1
  79885. * @param target defines the callback target (see EventState)
  79886. * @param currentTarget defines he current object in the bubbling phase
  79887. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  79888. */
  79889. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  79890. /**
  79891. * Notify a specific observer
  79892. * @param observer defines the observer to notify
  79893. * @param eventData defines the data to be sent to each callback
  79894. * @param mask is used to filter observers defaults to -1
  79895. */
  79896. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  79897. /**
  79898. * Gets a boolean indicating if the observable has at least one observer
  79899. * @returns true is the Observable has at least one Observer registered
  79900. */
  79901. hasObservers(): boolean;
  79902. /**
  79903. * Clear the list of observers
  79904. */
  79905. clear(): void;
  79906. /**
  79907. * Clone the current observable
  79908. * @returns a new observable
  79909. */
  79910. clone(): Observable<T>;
  79911. /**
  79912. * Does this observable handles observer registered with a given mask
  79913. * @param mask defines the mask to be tested
  79914. * @return whether or not one observer registered with the given mask is handeled
  79915. **/
  79916. hasSpecificMask(mask?: number): boolean;
  79917. }
  79918. }
  79919. declare module BABYLON {
  79920. /**
  79921. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  79922. * Babylon.js
  79923. */
  79924. export class DomManagement {
  79925. /**
  79926. * Checks if the window object exists
  79927. * @returns true if the window object exists
  79928. */
  79929. static IsWindowObjectExist(): boolean;
  79930. /**
  79931. * Checks if the navigator object exists
  79932. * @returns true if the navigator object exists
  79933. */
  79934. static IsNavigatorAvailable(): boolean;
  79935. /**
  79936. * Check if the document object exists
  79937. * @returns true if the document object exists
  79938. */
  79939. static IsDocumentAvailable(): boolean;
  79940. /**
  79941. * Extracts text content from a DOM element hierarchy
  79942. * @param element defines the root element
  79943. * @returns a string
  79944. */
  79945. static GetDOMTextContent(element: HTMLElement): string;
  79946. }
  79947. }
  79948. declare module BABYLON {
  79949. /**
  79950. * Logger used througouht the application to allow configuration of
  79951. * the log level required for the messages.
  79952. */
  79953. export class Logger {
  79954. /**
  79955. * No log
  79956. */
  79957. static readonly NoneLogLevel: number;
  79958. /**
  79959. * Only message logs
  79960. */
  79961. static readonly MessageLogLevel: number;
  79962. /**
  79963. * Only warning logs
  79964. */
  79965. static readonly WarningLogLevel: number;
  79966. /**
  79967. * Only error logs
  79968. */
  79969. static readonly ErrorLogLevel: number;
  79970. /**
  79971. * All logs
  79972. */
  79973. static readonly AllLogLevel: number;
  79974. private static _LogCache;
  79975. /**
  79976. * Gets a value indicating the number of loading errors
  79977. * @ignorenaming
  79978. */
  79979. static errorsCount: number;
  79980. /**
  79981. * Callback called when a new log is added
  79982. */
  79983. static OnNewCacheEntry: (entry: string) => void;
  79984. private static _AddLogEntry;
  79985. private static _FormatMessage;
  79986. private static _LogDisabled;
  79987. private static _LogEnabled;
  79988. private static _WarnDisabled;
  79989. private static _WarnEnabled;
  79990. private static _ErrorDisabled;
  79991. private static _ErrorEnabled;
  79992. /**
  79993. * Log a message to the console
  79994. */
  79995. static Log: (message: string) => void;
  79996. /**
  79997. * Write a warning message to the console
  79998. */
  79999. static Warn: (message: string) => void;
  80000. /**
  80001. * Write an error message to the console
  80002. */
  80003. static Error: (message: string) => void;
  80004. /**
  80005. * Gets current log cache (list of logs)
  80006. */
  80007. static get LogCache(): string;
  80008. /**
  80009. * Clears the log cache
  80010. */
  80011. static ClearLogCache(): void;
  80012. /**
  80013. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  80014. */
  80015. static set LogLevels(level: number);
  80016. }
  80017. }
  80018. declare module BABYLON {
  80019. /** @hidden */
  80020. export class _TypeStore {
  80021. /** @hidden */
  80022. static RegisteredTypes: {
  80023. [key: string]: Object;
  80024. };
  80025. /** @hidden */
  80026. static GetClass(fqdn: string): any;
  80027. }
  80028. }
  80029. declare module BABYLON {
  80030. /**
  80031. * Helper to manipulate strings
  80032. */
  80033. export class StringTools {
  80034. /**
  80035. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  80036. * @param str Source string
  80037. * @param suffix Suffix to search for in the source string
  80038. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80039. */
  80040. static EndsWith(str: string, suffix: string): boolean;
  80041. /**
  80042. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  80043. * @param str Source string
  80044. * @param suffix Suffix to search for in the source string
  80045. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80046. */
  80047. static StartsWith(str: string, suffix: string): boolean;
  80048. /**
  80049. * Decodes a buffer into a string
  80050. * @param buffer The buffer to decode
  80051. * @returns The decoded string
  80052. */
  80053. static Decode(buffer: Uint8Array | Uint16Array): string;
  80054. /**
  80055. * Encode a buffer to a base64 string
  80056. * @param buffer defines the buffer to encode
  80057. * @returns the encoded string
  80058. */
  80059. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  80060. /**
  80061. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  80062. * @param num the number to convert and pad
  80063. * @param length the expected length of the string
  80064. * @returns the padded string
  80065. */
  80066. static PadNumber(num: number, length: number): string;
  80067. }
  80068. }
  80069. declare module BABYLON {
  80070. /**
  80071. * Class containing a set of static utilities functions for deep copy.
  80072. */
  80073. export class DeepCopier {
  80074. /**
  80075. * Tries to copy an object by duplicating every property
  80076. * @param source defines the source object
  80077. * @param destination defines the target object
  80078. * @param doNotCopyList defines a list of properties to avoid
  80079. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  80080. */
  80081. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  80082. }
  80083. }
  80084. declare module BABYLON {
  80085. /**
  80086. * Class containing a set of static utilities functions for precision date
  80087. */
  80088. export class PrecisionDate {
  80089. /**
  80090. * Gets either window.performance.now() if supported or Date.now() else
  80091. */
  80092. static get Now(): number;
  80093. }
  80094. }
  80095. declare module BABYLON {
  80096. /** @hidden */
  80097. export class _DevTools {
  80098. static WarnImport(name: string): string;
  80099. }
  80100. }
  80101. declare module BABYLON {
  80102. /**
  80103. * Interface used to define the mechanism to get data from the network
  80104. */
  80105. export interface IWebRequest {
  80106. /**
  80107. * Returns client's response url
  80108. */
  80109. responseURL: string;
  80110. /**
  80111. * Returns client's status
  80112. */
  80113. status: number;
  80114. /**
  80115. * Returns client's status as a text
  80116. */
  80117. statusText: string;
  80118. }
  80119. }
  80120. declare module BABYLON {
  80121. /**
  80122. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  80123. */
  80124. export class WebRequest implements IWebRequest {
  80125. private _xhr;
  80126. /**
  80127. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  80128. * i.e. when loading files, where the server/service expects an Authorization header
  80129. */
  80130. static CustomRequestHeaders: {
  80131. [key: string]: string;
  80132. };
  80133. /**
  80134. * Add callback functions in this array to update all the requests before they get sent to the network
  80135. */
  80136. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  80137. private _injectCustomRequestHeaders;
  80138. /**
  80139. * Gets or sets a function to be called when loading progress changes
  80140. */
  80141. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  80142. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  80143. /**
  80144. * Returns client's state
  80145. */
  80146. get readyState(): number;
  80147. /**
  80148. * Returns client's status
  80149. */
  80150. get status(): number;
  80151. /**
  80152. * Returns client's status as a text
  80153. */
  80154. get statusText(): string;
  80155. /**
  80156. * Returns client's response
  80157. */
  80158. get response(): any;
  80159. /**
  80160. * Returns client's response url
  80161. */
  80162. get responseURL(): string;
  80163. /**
  80164. * Returns client's response as text
  80165. */
  80166. get responseText(): string;
  80167. /**
  80168. * Gets or sets the expected response type
  80169. */
  80170. get responseType(): XMLHttpRequestResponseType;
  80171. set responseType(value: XMLHttpRequestResponseType);
  80172. /** @hidden */
  80173. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  80174. /** @hidden */
  80175. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  80176. /**
  80177. * Cancels any network activity
  80178. */
  80179. abort(): void;
  80180. /**
  80181. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  80182. * @param body defines an optional request body
  80183. */
  80184. send(body?: Document | BodyInit | null): void;
  80185. /**
  80186. * Sets the request method, request URL
  80187. * @param method defines the method to use (GET, POST, etc..)
  80188. * @param url defines the url to connect with
  80189. */
  80190. open(method: string, url: string): void;
  80191. /**
  80192. * Sets the value of a request header.
  80193. * @param name The name of the header whose value is to be set
  80194. * @param value The value to set as the body of the header
  80195. */
  80196. setRequestHeader(name: string, value: string): void;
  80197. /**
  80198. * Get the string containing the text of a particular header's value.
  80199. * @param name The name of the header
  80200. * @returns The string containing the text of the given header name
  80201. */
  80202. getResponseHeader(name: string): Nullable<string>;
  80203. }
  80204. }
  80205. declare module BABYLON {
  80206. /**
  80207. * File request interface
  80208. */
  80209. export interface IFileRequest {
  80210. /**
  80211. * Raised when the request is complete (success or error).
  80212. */
  80213. onCompleteObservable: Observable<IFileRequest>;
  80214. /**
  80215. * Aborts the request for a file.
  80216. */
  80217. abort: () => void;
  80218. }
  80219. }
  80220. declare module BABYLON {
  80221. /**
  80222. * Define options used to create a render target texture
  80223. */
  80224. export class RenderTargetCreationOptions {
  80225. /**
  80226. * Specifies is mipmaps must be generated
  80227. */
  80228. generateMipMaps?: boolean;
  80229. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  80230. generateDepthBuffer?: boolean;
  80231. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  80232. generateStencilBuffer?: boolean;
  80233. /** Defines texture type (int by default) */
  80234. type?: number;
  80235. /** Defines sampling mode (trilinear by default) */
  80236. samplingMode?: number;
  80237. /** Defines format (RGBA by default) */
  80238. format?: number;
  80239. }
  80240. }
  80241. declare module BABYLON {
  80242. /** Defines the cross module used constants to avoid circular dependncies */
  80243. export class Constants {
  80244. /** Defines that alpha blending is disabled */
  80245. static readonly ALPHA_DISABLE: number;
  80246. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  80247. static readonly ALPHA_ADD: number;
  80248. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  80249. static readonly ALPHA_COMBINE: number;
  80250. /** Defines that alpha blending is DEST - SRC * DEST */
  80251. static readonly ALPHA_SUBTRACT: number;
  80252. /** Defines that alpha blending is SRC * DEST */
  80253. static readonly ALPHA_MULTIPLY: number;
  80254. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  80255. static readonly ALPHA_MAXIMIZED: number;
  80256. /** Defines that alpha blending is SRC + DEST */
  80257. static readonly ALPHA_ONEONE: number;
  80258. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  80259. static readonly ALPHA_PREMULTIPLIED: number;
  80260. /**
  80261. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  80262. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  80263. */
  80264. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  80265. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  80266. static readonly ALPHA_INTERPOLATE: number;
  80267. /**
  80268. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  80269. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  80270. */
  80271. static readonly ALPHA_SCREENMODE: number;
  80272. /**
  80273. * Defines that alpha blending is SRC + DST
  80274. * Alpha will be set to SRC ALPHA + DST ALPHA
  80275. */
  80276. static readonly ALPHA_ONEONE_ONEONE: number;
  80277. /**
  80278. * Defines that alpha blending is SRC * DST ALPHA + DST
  80279. * Alpha will be set to 0
  80280. */
  80281. static readonly ALPHA_ALPHATOCOLOR: number;
  80282. /**
  80283. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80284. */
  80285. static readonly ALPHA_REVERSEONEMINUS: number;
  80286. /**
  80287. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  80288. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  80289. */
  80290. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  80291. /**
  80292. * Defines that alpha blending is SRC + DST
  80293. * Alpha will be set to SRC ALPHA
  80294. */
  80295. static readonly ALPHA_ONEONE_ONEZERO: number;
  80296. /**
  80297. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80298. * Alpha will be set to DST ALPHA
  80299. */
  80300. static readonly ALPHA_EXCLUSION: number;
  80301. /** Defines that alpha blending equation a SUM */
  80302. static readonly ALPHA_EQUATION_ADD: number;
  80303. /** Defines that alpha blending equation a SUBSTRACTION */
  80304. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  80305. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  80306. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  80307. /** Defines that alpha blending equation a MAX operation */
  80308. static readonly ALPHA_EQUATION_MAX: number;
  80309. /** Defines that alpha blending equation a MIN operation */
  80310. static readonly ALPHA_EQUATION_MIN: number;
  80311. /**
  80312. * Defines that alpha blending equation a DARKEN operation:
  80313. * It takes the min of the src and sums the alpha channels.
  80314. */
  80315. static readonly ALPHA_EQUATION_DARKEN: number;
  80316. /** Defines that the ressource is not delayed*/
  80317. static readonly DELAYLOADSTATE_NONE: number;
  80318. /** Defines that the ressource was successfully delay loaded */
  80319. static readonly DELAYLOADSTATE_LOADED: number;
  80320. /** Defines that the ressource is currently delay loading */
  80321. static readonly DELAYLOADSTATE_LOADING: number;
  80322. /** Defines that the ressource is delayed and has not started loading */
  80323. static readonly DELAYLOADSTATE_NOTLOADED: number;
  80324. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  80325. static readonly NEVER: number;
  80326. /** 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 */
  80327. static readonly ALWAYS: number;
  80328. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  80329. static readonly LESS: number;
  80330. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  80331. static readonly EQUAL: number;
  80332. /** 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 */
  80333. static readonly LEQUAL: number;
  80334. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  80335. static readonly GREATER: number;
  80336. /** 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 */
  80337. static readonly GEQUAL: number;
  80338. /** 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 */
  80339. static readonly NOTEQUAL: number;
  80340. /** Passed to stencilOperation to specify that stencil value must be kept */
  80341. static readonly KEEP: number;
  80342. /** Passed to stencilOperation to specify that stencil value must be replaced */
  80343. static readonly REPLACE: number;
  80344. /** Passed to stencilOperation to specify that stencil value must be incremented */
  80345. static readonly INCR: number;
  80346. /** Passed to stencilOperation to specify that stencil value must be decremented */
  80347. static readonly DECR: number;
  80348. /** Passed to stencilOperation to specify that stencil value must be inverted */
  80349. static readonly INVERT: number;
  80350. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  80351. static readonly INCR_WRAP: number;
  80352. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  80353. static readonly DECR_WRAP: number;
  80354. /** Texture is not repeating outside of 0..1 UVs */
  80355. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  80356. /** Texture is repeating outside of 0..1 UVs */
  80357. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  80358. /** Texture is repeating and mirrored */
  80359. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  80360. /** ALPHA */
  80361. static readonly TEXTUREFORMAT_ALPHA: number;
  80362. /** LUMINANCE */
  80363. static readonly TEXTUREFORMAT_LUMINANCE: number;
  80364. /** LUMINANCE_ALPHA */
  80365. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  80366. /** RGB */
  80367. static readonly TEXTUREFORMAT_RGB: number;
  80368. /** RGBA */
  80369. static readonly TEXTUREFORMAT_RGBA: number;
  80370. /** RED */
  80371. static readonly TEXTUREFORMAT_RED: number;
  80372. /** RED (2nd reference) */
  80373. static readonly TEXTUREFORMAT_R: number;
  80374. /** RG */
  80375. static readonly TEXTUREFORMAT_RG: number;
  80376. /** RED_INTEGER */
  80377. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  80378. /** RED_INTEGER (2nd reference) */
  80379. static readonly TEXTUREFORMAT_R_INTEGER: number;
  80380. /** RG_INTEGER */
  80381. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  80382. /** RGB_INTEGER */
  80383. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  80384. /** RGBA_INTEGER */
  80385. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  80386. /** UNSIGNED_BYTE */
  80387. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  80388. /** UNSIGNED_BYTE (2nd reference) */
  80389. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  80390. /** FLOAT */
  80391. static readonly TEXTURETYPE_FLOAT: number;
  80392. /** HALF_FLOAT */
  80393. static readonly TEXTURETYPE_HALF_FLOAT: number;
  80394. /** BYTE */
  80395. static readonly TEXTURETYPE_BYTE: number;
  80396. /** SHORT */
  80397. static readonly TEXTURETYPE_SHORT: number;
  80398. /** UNSIGNED_SHORT */
  80399. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  80400. /** INT */
  80401. static readonly TEXTURETYPE_INT: number;
  80402. /** UNSIGNED_INT */
  80403. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  80404. /** UNSIGNED_SHORT_4_4_4_4 */
  80405. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  80406. /** UNSIGNED_SHORT_5_5_5_1 */
  80407. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  80408. /** UNSIGNED_SHORT_5_6_5 */
  80409. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  80410. /** UNSIGNED_INT_2_10_10_10_REV */
  80411. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  80412. /** UNSIGNED_INT_24_8 */
  80413. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  80414. /** UNSIGNED_INT_10F_11F_11F_REV */
  80415. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  80416. /** UNSIGNED_INT_5_9_9_9_REV */
  80417. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  80418. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  80419. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  80420. /** nearest is mag = nearest and min = nearest and no mip */
  80421. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  80422. /** mag = nearest and min = nearest and mip = none */
  80423. static readonly TEXTURE_NEAREST_NEAREST: number;
  80424. /** Bilinear is mag = linear and min = linear and no mip */
  80425. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  80426. /** mag = linear and min = linear and mip = none */
  80427. static readonly TEXTURE_LINEAR_LINEAR: number;
  80428. /** Trilinear is mag = linear and min = linear and mip = linear */
  80429. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  80430. /** Trilinear is mag = linear and min = linear and mip = linear */
  80431. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  80432. /** mag = nearest and min = nearest and mip = nearest */
  80433. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  80434. /** mag = nearest and min = linear and mip = nearest */
  80435. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  80436. /** mag = nearest and min = linear and mip = linear */
  80437. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  80438. /** mag = nearest and min = linear and mip = none */
  80439. static readonly TEXTURE_NEAREST_LINEAR: number;
  80440. /** nearest is mag = nearest and min = nearest and mip = linear */
  80441. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  80442. /** mag = linear and min = nearest and mip = nearest */
  80443. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  80444. /** mag = linear and min = nearest and mip = linear */
  80445. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  80446. /** Bilinear is mag = linear and min = linear and mip = nearest */
  80447. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  80448. /** mag = linear and min = nearest and mip = none */
  80449. static readonly TEXTURE_LINEAR_NEAREST: number;
  80450. /** Explicit coordinates mode */
  80451. static readonly TEXTURE_EXPLICIT_MODE: number;
  80452. /** Spherical coordinates mode */
  80453. static readonly TEXTURE_SPHERICAL_MODE: number;
  80454. /** Planar coordinates mode */
  80455. static readonly TEXTURE_PLANAR_MODE: number;
  80456. /** Cubic coordinates mode */
  80457. static readonly TEXTURE_CUBIC_MODE: number;
  80458. /** Projection coordinates mode */
  80459. static readonly TEXTURE_PROJECTION_MODE: number;
  80460. /** Skybox coordinates mode */
  80461. static readonly TEXTURE_SKYBOX_MODE: number;
  80462. /** Inverse Cubic coordinates mode */
  80463. static readonly TEXTURE_INVCUBIC_MODE: number;
  80464. /** Equirectangular coordinates mode */
  80465. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  80466. /** Equirectangular Fixed coordinates mode */
  80467. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  80468. /** Equirectangular Fixed Mirrored coordinates mode */
  80469. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  80470. /** Offline (baking) quality for texture filtering */
  80471. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  80472. /** High quality for texture filtering */
  80473. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  80474. /** Medium quality for texture filtering */
  80475. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  80476. /** Low quality for texture filtering */
  80477. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  80478. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  80479. static readonly SCALEMODE_FLOOR: number;
  80480. /** Defines that texture rescaling will look for the nearest power of 2 size */
  80481. static readonly SCALEMODE_NEAREST: number;
  80482. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  80483. static readonly SCALEMODE_CEILING: number;
  80484. /**
  80485. * The dirty texture flag value
  80486. */
  80487. static readonly MATERIAL_TextureDirtyFlag: number;
  80488. /**
  80489. * The dirty light flag value
  80490. */
  80491. static readonly MATERIAL_LightDirtyFlag: number;
  80492. /**
  80493. * The dirty fresnel flag value
  80494. */
  80495. static readonly MATERIAL_FresnelDirtyFlag: number;
  80496. /**
  80497. * The dirty attribute flag value
  80498. */
  80499. static readonly MATERIAL_AttributesDirtyFlag: number;
  80500. /**
  80501. * The dirty misc flag value
  80502. */
  80503. static readonly MATERIAL_MiscDirtyFlag: number;
  80504. /**
  80505. * The all dirty flag value
  80506. */
  80507. static readonly MATERIAL_AllDirtyFlag: number;
  80508. /**
  80509. * Returns the triangle fill mode
  80510. */
  80511. static readonly MATERIAL_TriangleFillMode: number;
  80512. /**
  80513. * Returns the wireframe mode
  80514. */
  80515. static readonly MATERIAL_WireFrameFillMode: number;
  80516. /**
  80517. * Returns the point fill mode
  80518. */
  80519. static readonly MATERIAL_PointFillMode: number;
  80520. /**
  80521. * Returns the point list draw mode
  80522. */
  80523. static readonly MATERIAL_PointListDrawMode: number;
  80524. /**
  80525. * Returns the line list draw mode
  80526. */
  80527. static readonly MATERIAL_LineListDrawMode: number;
  80528. /**
  80529. * Returns the line loop draw mode
  80530. */
  80531. static readonly MATERIAL_LineLoopDrawMode: number;
  80532. /**
  80533. * Returns the line strip draw mode
  80534. */
  80535. static readonly MATERIAL_LineStripDrawMode: number;
  80536. /**
  80537. * Returns the triangle strip draw mode
  80538. */
  80539. static readonly MATERIAL_TriangleStripDrawMode: number;
  80540. /**
  80541. * Returns the triangle fan draw mode
  80542. */
  80543. static readonly MATERIAL_TriangleFanDrawMode: number;
  80544. /**
  80545. * Stores the clock-wise side orientation
  80546. */
  80547. static readonly MATERIAL_ClockWiseSideOrientation: number;
  80548. /**
  80549. * Stores the counter clock-wise side orientation
  80550. */
  80551. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  80552. /**
  80553. * Nothing
  80554. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80555. */
  80556. static readonly ACTION_NothingTrigger: number;
  80557. /**
  80558. * On pick
  80559. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80560. */
  80561. static readonly ACTION_OnPickTrigger: number;
  80562. /**
  80563. * On left pick
  80564. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80565. */
  80566. static readonly ACTION_OnLeftPickTrigger: number;
  80567. /**
  80568. * On right pick
  80569. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80570. */
  80571. static readonly ACTION_OnRightPickTrigger: number;
  80572. /**
  80573. * On center pick
  80574. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80575. */
  80576. static readonly ACTION_OnCenterPickTrigger: number;
  80577. /**
  80578. * On pick down
  80579. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80580. */
  80581. static readonly ACTION_OnPickDownTrigger: number;
  80582. /**
  80583. * On double pick
  80584. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80585. */
  80586. static readonly ACTION_OnDoublePickTrigger: number;
  80587. /**
  80588. * On pick up
  80589. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80590. */
  80591. static readonly ACTION_OnPickUpTrigger: number;
  80592. /**
  80593. * On pick out.
  80594. * This trigger will only be raised if you also declared a OnPickDown
  80595. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80596. */
  80597. static readonly ACTION_OnPickOutTrigger: number;
  80598. /**
  80599. * On long press
  80600. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80601. */
  80602. static readonly ACTION_OnLongPressTrigger: number;
  80603. /**
  80604. * On pointer over
  80605. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80606. */
  80607. static readonly ACTION_OnPointerOverTrigger: number;
  80608. /**
  80609. * On pointer out
  80610. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80611. */
  80612. static readonly ACTION_OnPointerOutTrigger: number;
  80613. /**
  80614. * On every frame
  80615. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80616. */
  80617. static readonly ACTION_OnEveryFrameTrigger: number;
  80618. /**
  80619. * On intersection enter
  80620. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80621. */
  80622. static readonly ACTION_OnIntersectionEnterTrigger: number;
  80623. /**
  80624. * On intersection exit
  80625. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80626. */
  80627. static readonly ACTION_OnIntersectionExitTrigger: number;
  80628. /**
  80629. * On key down
  80630. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80631. */
  80632. static readonly ACTION_OnKeyDownTrigger: number;
  80633. /**
  80634. * On key up
  80635. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80636. */
  80637. static readonly ACTION_OnKeyUpTrigger: number;
  80638. /**
  80639. * Billboard mode will only apply to Y axis
  80640. */
  80641. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  80642. /**
  80643. * Billboard mode will apply to all axes
  80644. */
  80645. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  80646. /**
  80647. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  80648. */
  80649. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  80650. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  80651. * Test order :
  80652. * Is the bounding sphere outside the frustum ?
  80653. * If not, are the bounding box vertices outside the frustum ?
  80654. * It not, then the cullable object is in the frustum.
  80655. */
  80656. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  80657. /** Culling strategy : Bounding Sphere Only.
  80658. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  80659. * It's also less accurate than the standard because some not visible objects can still be selected.
  80660. * Test : is the bounding sphere outside the frustum ?
  80661. * If not, then the cullable object is in the frustum.
  80662. */
  80663. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  80664. /** Culling strategy : Optimistic Inclusion.
  80665. * This in an inclusion test first, then the standard exclusion test.
  80666. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  80667. * 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.
  80668. * Anyway, it's as accurate as the standard strategy.
  80669. * Test :
  80670. * Is the cullable object bounding sphere center in the frustum ?
  80671. * If not, apply the default culling strategy.
  80672. */
  80673. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  80674. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  80675. * This in an inclusion test first, then the bounding sphere only exclusion test.
  80676. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  80677. * 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.
  80678. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  80679. * Test :
  80680. * Is the cullable object bounding sphere center in the frustum ?
  80681. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  80682. */
  80683. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  80684. /**
  80685. * No logging while loading
  80686. */
  80687. static readonly SCENELOADER_NO_LOGGING: number;
  80688. /**
  80689. * Minimal logging while loading
  80690. */
  80691. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  80692. /**
  80693. * Summary logging while loading
  80694. */
  80695. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  80696. /**
  80697. * Detailled logging while loading
  80698. */
  80699. static readonly SCENELOADER_DETAILED_LOGGING: number;
  80700. /**
  80701. * Prepass texture index for color
  80702. */
  80703. static readonly PREPASS_COLOR_INDEX: number;
  80704. /**
  80705. * Prepass texture index for irradiance
  80706. */
  80707. static readonly PREPASS_IRRADIANCE_INDEX: number;
  80708. /**
  80709. * Prepass texture index for depth + normal
  80710. */
  80711. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  80712. /**
  80713. * Prepass texture index for albedo
  80714. */
  80715. static readonly PREPASS_ALBEDO_INDEX: number;
  80716. }
  80717. }
  80718. declare module BABYLON {
  80719. /**
  80720. * This represents the required contract to create a new type of texture loader.
  80721. */
  80722. export interface IInternalTextureLoader {
  80723. /**
  80724. * Defines wether the loader supports cascade loading the different faces.
  80725. */
  80726. supportCascades: boolean;
  80727. /**
  80728. * This returns if the loader support the current file information.
  80729. * @param extension defines the file extension of the file being loaded
  80730. * @param mimeType defines the optional mime type of the file being loaded
  80731. * @returns true if the loader can load the specified file
  80732. */
  80733. canLoad(extension: string, mimeType?: string): boolean;
  80734. /**
  80735. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  80736. * @param data contains the texture data
  80737. * @param texture defines the BabylonJS internal texture
  80738. * @param createPolynomials will be true if polynomials have been requested
  80739. * @param onLoad defines the callback to trigger once the texture is ready
  80740. * @param onError defines the callback to trigger in case of error
  80741. */
  80742. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  80743. /**
  80744. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  80745. * @param data contains the texture data
  80746. * @param texture defines the BabylonJS internal texture
  80747. * @param callback defines the method to call once ready to upload
  80748. */
  80749. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  80750. }
  80751. }
  80752. declare module BABYLON {
  80753. /**
  80754. * Class used to store and describe the pipeline context associated with an effect
  80755. */
  80756. export interface IPipelineContext {
  80757. /**
  80758. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  80759. */
  80760. isAsync: boolean;
  80761. /**
  80762. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  80763. */
  80764. isReady: boolean;
  80765. /** @hidden */
  80766. _getVertexShaderCode(): string | null;
  80767. /** @hidden */
  80768. _getFragmentShaderCode(): string | null;
  80769. /** @hidden */
  80770. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  80771. }
  80772. }
  80773. declare module BABYLON {
  80774. /**
  80775. * Class used to store gfx data (like WebGLBuffer)
  80776. */
  80777. export class DataBuffer {
  80778. /**
  80779. * Gets or sets the number of objects referencing this buffer
  80780. */
  80781. references: number;
  80782. /** Gets or sets the size of the underlying buffer */
  80783. capacity: number;
  80784. /**
  80785. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  80786. */
  80787. is32Bits: boolean;
  80788. /**
  80789. * Gets the underlying buffer
  80790. */
  80791. get underlyingResource(): any;
  80792. }
  80793. }
  80794. declare module BABYLON {
  80795. /** @hidden */
  80796. export interface IShaderProcessor {
  80797. attributeProcessor?: (attribute: string) => string;
  80798. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  80799. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  80800. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  80801. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  80802. lineProcessor?: (line: string, isFragment: boolean) => string;
  80803. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80804. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80805. }
  80806. }
  80807. declare module BABYLON {
  80808. /** @hidden */
  80809. export interface ProcessingOptions {
  80810. defines: string[];
  80811. indexParameters: any;
  80812. isFragment: boolean;
  80813. shouldUseHighPrecisionShader: boolean;
  80814. supportsUniformBuffers: boolean;
  80815. shadersRepository: string;
  80816. includesShadersStore: {
  80817. [key: string]: string;
  80818. };
  80819. processor?: IShaderProcessor;
  80820. version: string;
  80821. platformName: string;
  80822. lookForClosingBracketForUniformBuffer?: boolean;
  80823. }
  80824. }
  80825. declare module BABYLON {
  80826. /** @hidden */
  80827. export class ShaderCodeNode {
  80828. line: string;
  80829. children: ShaderCodeNode[];
  80830. additionalDefineKey?: string;
  80831. additionalDefineValue?: string;
  80832. isValid(preprocessors: {
  80833. [key: string]: string;
  80834. }): boolean;
  80835. process(preprocessors: {
  80836. [key: string]: string;
  80837. }, options: ProcessingOptions): string;
  80838. }
  80839. }
  80840. declare module BABYLON {
  80841. /** @hidden */
  80842. export class ShaderCodeCursor {
  80843. private _lines;
  80844. lineIndex: number;
  80845. get currentLine(): string;
  80846. get canRead(): boolean;
  80847. set lines(value: string[]);
  80848. }
  80849. }
  80850. declare module BABYLON {
  80851. /** @hidden */
  80852. export class ShaderCodeConditionNode extends ShaderCodeNode {
  80853. process(preprocessors: {
  80854. [key: string]: string;
  80855. }, options: ProcessingOptions): string;
  80856. }
  80857. }
  80858. declare module BABYLON {
  80859. /** @hidden */
  80860. export class ShaderDefineExpression {
  80861. isTrue(preprocessors: {
  80862. [key: string]: string;
  80863. }): boolean;
  80864. private static _OperatorPriority;
  80865. private static _Stack;
  80866. static postfixToInfix(postfix: string[]): string;
  80867. static infixToPostfix(infix: string): string[];
  80868. }
  80869. }
  80870. declare module BABYLON {
  80871. /** @hidden */
  80872. export class ShaderCodeTestNode extends ShaderCodeNode {
  80873. testExpression: ShaderDefineExpression;
  80874. isValid(preprocessors: {
  80875. [key: string]: string;
  80876. }): boolean;
  80877. }
  80878. }
  80879. declare module BABYLON {
  80880. /** @hidden */
  80881. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  80882. define: string;
  80883. not: boolean;
  80884. constructor(define: string, not?: boolean);
  80885. isTrue(preprocessors: {
  80886. [key: string]: string;
  80887. }): boolean;
  80888. }
  80889. }
  80890. declare module BABYLON {
  80891. /** @hidden */
  80892. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  80893. leftOperand: ShaderDefineExpression;
  80894. rightOperand: ShaderDefineExpression;
  80895. isTrue(preprocessors: {
  80896. [key: string]: string;
  80897. }): boolean;
  80898. }
  80899. }
  80900. declare module BABYLON {
  80901. /** @hidden */
  80902. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  80903. leftOperand: ShaderDefineExpression;
  80904. rightOperand: ShaderDefineExpression;
  80905. isTrue(preprocessors: {
  80906. [key: string]: string;
  80907. }): boolean;
  80908. }
  80909. }
  80910. declare module BABYLON {
  80911. /** @hidden */
  80912. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  80913. define: string;
  80914. operand: string;
  80915. testValue: string;
  80916. constructor(define: string, operand: string, testValue: string);
  80917. isTrue(preprocessors: {
  80918. [key: string]: string;
  80919. }): boolean;
  80920. }
  80921. }
  80922. declare module BABYLON {
  80923. /**
  80924. * Class used to enable access to offline support
  80925. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  80926. */
  80927. export interface IOfflineProvider {
  80928. /**
  80929. * Gets a boolean indicating if scene must be saved in the database
  80930. */
  80931. enableSceneOffline: boolean;
  80932. /**
  80933. * Gets a boolean indicating if textures must be saved in the database
  80934. */
  80935. enableTexturesOffline: boolean;
  80936. /**
  80937. * Open the offline support and make it available
  80938. * @param successCallback defines the callback to call on success
  80939. * @param errorCallback defines the callback to call on error
  80940. */
  80941. open(successCallback: () => void, errorCallback: () => void): void;
  80942. /**
  80943. * Loads an image from the offline support
  80944. * @param url defines the url to load from
  80945. * @param image defines the target DOM image
  80946. */
  80947. loadImage(url: string, image: HTMLImageElement): void;
  80948. /**
  80949. * Loads a file from offline support
  80950. * @param url defines the URL to load from
  80951. * @param sceneLoaded defines a callback to call on success
  80952. * @param progressCallBack defines a callback to call when progress changed
  80953. * @param errorCallback defines a callback to call on error
  80954. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  80955. */
  80956. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  80957. }
  80958. }
  80959. declare module BABYLON {
  80960. /**
  80961. * Class used to help managing file picking and drag'n'drop
  80962. * File Storage
  80963. */
  80964. export class FilesInputStore {
  80965. /**
  80966. * List of files ready to be loaded
  80967. */
  80968. static FilesToLoad: {
  80969. [key: string]: File;
  80970. };
  80971. }
  80972. }
  80973. declare module BABYLON {
  80974. /**
  80975. * Class used to define a retry strategy when error happens while loading assets
  80976. */
  80977. export class RetryStrategy {
  80978. /**
  80979. * Function used to defines an exponential back off strategy
  80980. * @param maxRetries defines the maximum number of retries (3 by default)
  80981. * @param baseInterval defines the interval between retries
  80982. * @returns the strategy function to use
  80983. */
  80984. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  80985. }
  80986. }
  80987. declare module BABYLON {
  80988. /**
  80989. * @ignore
  80990. * Application error to support additional information when loading a file
  80991. */
  80992. export abstract class BaseError extends Error {
  80993. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  80994. }
  80995. }
  80996. declare module BABYLON {
  80997. /** @ignore */
  80998. export class LoadFileError extends BaseError {
  80999. request?: WebRequest;
  81000. file?: File;
  81001. /**
  81002. * Creates a new LoadFileError
  81003. * @param message defines the message of the error
  81004. * @param request defines the optional web request
  81005. * @param file defines the optional file
  81006. */
  81007. constructor(message: string, object?: WebRequest | File);
  81008. }
  81009. /** @ignore */
  81010. export class RequestFileError extends BaseError {
  81011. request: WebRequest;
  81012. /**
  81013. * Creates a new LoadFileError
  81014. * @param message defines the message of the error
  81015. * @param request defines the optional web request
  81016. */
  81017. constructor(message: string, request: WebRequest);
  81018. }
  81019. /** @ignore */
  81020. export class ReadFileError extends BaseError {
  81021. file: File;
  81022. /**
  81023. * Creates a new ReadFileError
  81024. * @param message defines the message of the error
  81025. * @param file defines the optional file
  81026. */
  81027. constructor(message: string, file: File);
  81028. }
  81029. /**
  81030. * @hidden
  81031. */
  81032. export class FileTools {
  81033. /**
  81034. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  81035. */
  81036. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  81037. /**
  81038. * Gets or sets the base URL to use to load assets
  81039. */
  81040. static BaseUrl: string;
  81041. /**
  81042. * Default behaviour for cors in the application.
  81043. * It can be a string if the expected behavior is identical in the entire app.
  81044. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  81045. */
  81046. static CorsBehavior: string | ((url: string | string[]) => string);
  81047. /**
  81048. * Gets or sets a function used to pre-process url before using them to load assets
  81049. */
  81050. static PreprocessUrl: (url: string) => string;
  81051. /**
  81052. * Removes unwanted characters from an url
  81053. * @param url defines the url to clean
  81054. * @returns the cleaned url
  81055. */
  81056. private static _CleanUrl;
  81057. /**
  81058. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  81059. * @param url define the url we are trying
  81060. * @param element define the dom element where to configure the cors policy
  81061. */
  81062. static SetCorsBehavior(url: string | string[], element: {
  81063. crossOrigin: string | null;
  81064. }): void;
  81065. /**
  81066. * Loads an image as an HTMLImageElement.
  81067. * @param input url string, ArrayBuffer, or Blob to load
  81068. * @param onLoad callback called when the image successfully loads
  81069. * @param onError callback called when the image fails to load
  81070. * @param offlineProvider offline provider for caching
  81071. * @param mimeType optional mime type
  81072. * @returns the HTMLImageElement of the loaded image
  81073. */
  81074. 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>;
  81075. /**
  81076. * Reads a file from a File object
  81077. * @param file defines the file to load
  81078. * @param onSuccess defines the callback to call when data is loaded
  81079. * @param onProgress defines the callback to call during loading process
  81080. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  81081. * @param onError defines the callback to call when an error occurs
  81082. * @returns a file request object
  81083. */
  81084. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  81085. /**
  81086. * Loads a file from a url
  81087. * @param url url to load
  81088. * @param onSuccess callback called when the file successfully loads
  81089. * @param onProgress callback called while file is loading (if the server supports this mode)
  81090. * @param offlineProvider defines the offline provider for caching
  81091. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81092. * @param onError callback called when the file fails to load
  81093. * @returns a file request object
  81094. */
  81095. 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;
  81096. /**
  81097. * Loads a file
  81098. * @param url url to load
  81099. * @param onSuccess callback called when the file successfully loads
  81100. * @param onProgress callback called while file is loading (if the server supports this mode)
  81101. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81102. * @param onError callback called when the file fails to load
  81103. * @param onOpened callback called when the web request is opened
  81104. * @returns a file request object
  81105. */
  81106. 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;
  81107. /**
  81108. * Checks if the loaded document was accessed via `file:`-Protocol.
  81109. * @returns boolean
  81110. */
  81111. static IsFileURL(): boolean;
  81112. }
  81113. }
  81114. declare module BABYLON {
  81115. /** @hidden */
  81116. export class ShaderProcessor {
  81117. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  81118. private static _ProcessPrecision;
  81119. private static _ExtractOperation;
  81120. private static _BuildSubExpression;
  81121. private static _BuildExpression;
  81122. private static _MoveCursorWithinIf;
  81123. private static _MoveCursor;
  81124. private static _EvaluatePreProcessors;
  81125. private static _PreparePreProcessors;
  81126. private static _ProcessShaderConversion;
  81127. private static _ProcessIncludes;
  81128. /**
  81129. * Loads a file from a url
  81130. * @param url url to load
  81131. * @param onSuccess callback called when the file successfully loads
  81132. * @param onProgress callback called while file is loading (if the server supports this mode)
  81133. * @param offlineProvider defines the offline provider for caching
  81134. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81135. * @param onError callback called when the file fails to load
  81136. * @returns a file request object
  81137. * @hidden
  81138. */
  81139. 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;
  81140. }
  81141. }
  81142. declare module BABYLON {
  81143. /**
  81144. * @hidden
  81145. */
  81146. export interface IColor4Like {
  81147. r: float;
  81148. g: float;
  81149. b: float;
  81150. a: float;
  81151. }
  81152. /**
  81153. * @hidden
  81154. */
  81155. export interface IColor3Like {
  81156. r: float;
  81157. g: float;
  81158. b: float;
  81159. }
  81160. /**
  81161. * @hidden
  81162. */
  81163. export interface IVector4Like {
  81164. x: float;
  81165. y: float;
  81166. z: float;
  81167. w: float;
  81168. }
  81169. /**
  81170. * @hidden
  81171. */
  81172. export interface IVector3Like {
  81173. x: float;
  81174. y: float;
  81175. z: float;
  81176. }
  81177. /**
  81178. * @hidden
  81179. */
  81180. export interface IVector2Like {
  81181. x: float;
  81182. y: float;
  81183. }
  81184. /**
  81185. * @hidden
  81186. */
  81187. export interface IMatrixLike {
  81188. toArray(): DeepImmutable<Float32Array | Array<number>>;
  81189. updateFlag: int;
  81190. }
  81191. /**
  81192. * @hidden
  81193. */
  81194. export interface IViewportLike {
  81195. x: float;
  81196. y: float;
  81197. width: float;
  81198. height: float;
  81199. }
  81200. /**
  81201. * @hidden
  81202. */
  81203. export interface IPlaneLike {
  81204. normal: IVector3Like;
  81205. d: float;
  81206. normalize(): void;
  81207. }
  81208. }
  81209. declare module BABYLON {
  81210. /**
  81211. * Interface used to define common properties for effect fallbacks
  81212. */
  81213. export interface IEffectFallbacks {
  81214. /**
  81215. * Removes the defines that should be removed when falling back.
  81216. * @param currentDefines defines the current define statements for the shader.
  81217. * @param effect defines the current effect we try to compile
  81218. * @returns The resulting defines with defines of the current rank removed.
  81219. */
  81220. reduce(currentDefines: string, effect: Effect): string;
  81221. /**
  81222. * Removes the fallback from the bound mesh.
  81223. */
  81224. unBindMesh(): void;
  81225. /**
  81226. * Checks to see if more fallbacks are still availible.
  81227. */
  81228. hasMoreFallbacks: boolean;
  81229. }
  81230. }
  81231. declare module BABYLON {
  81232. /**
  81233. * Class used to evalaute queries containing `and` and `or` operators
  81234. */
  81235. export class AndOrNotEvaluator {
  81236. /**
  81237. * Evaluate a query
  81238. * @param query defines the query to evaluate
  81239. * @param evaluateCallback defines the callback used to filter result
  81240. * @returns true if the query matches
  81241. */
  81242. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  81243. private static _HandleParenthesisContent;
  81244. private static _SimplifyNegation;
  81245. }
  81246. }
  81247. declare module BABYLON {
  81248. /**
  81249. * Class used to store custom tags
  81250. */
  81251. export class Tags {
  81252. /**
  81253. * Adds support for tags on the given object
  81254. * @param obj defines the object to use
  81255. */
  81256. static EnableFor(obj: any): void;
  81257. /**
  81258. * Removes tags support
  81259. * @param obj defines the object to use
  81260. */
  81261. static DisableFor(obj: any): void;
  81262. /**
  81263. * Gets a boolean indicating if the given object has tags
  81264. * @param obj defines the object to use
  81265. * @returns a boolean
  81266. */
  81267. static HasTags(obj: any): boolean;
  81268. /**
  81269. * Gets the tags available on a given object
  81270. * @param obj defines the object to use
  81271. * @param asString defines if the tags must be returned as a string instead of an array of strings
  81272. * @returns the tags
  81273. */
  81274. static GetTags(obj: any, asString?: boolean): any;
  81275. /**
  81276. * Adds tags to an object
  81277. * @param obj defines the object to use
  81278. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  81279. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  81280. */
  81281. static AddTagsTo(obj: any, tagsString: string): void;
  81282. /**
  81283. * @hidden
  81284. */
  81285. static _AddTagTo(obj: any, tag: string): void;
  81286. /**
  81287. * Removes specific tags from a specific object
  81288. * @param obj defines the object to use
  81289. * @param tagsString defines the tags to remove
  81290. */
  81291. static RemoveTagsFrom(obj: any, tagsString: string): void;
  81292. /**
  81293. * @hidden
  81294. */
  81295. static _RemoveTagFrom(obj: any, tag: string): void;
  81296. /**
  81297. * Defines if tags hosted on an object match a given query
  81298. * @param obj defines the object to use
  81299. * @param tagsQuery defines the tag query
  81300. * @returns a boolean
  81301. */
  81302. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  81303. }
  81304. }
  81305. declare module BABYLON {
  81306. /**
  81307. * Scalar computation library
  81308. */
  81309. export class Scalar {
  81310. /**
  81311. * Two pi constants convenient for computation.
  81312. */
  81313. static TwoPi: number;
  81314. /**
  81315. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81316. * @param a number
  81317. * @param b number
  81318. * @param epsilon (default = 1.401298E-45)
  81319. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81320. */
  81321. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  81322. /**
  81323. * Returns a string : the upper case translation of the number i to hexadecimal.
  81324. * @param i number
  81325. * @returns the upper case translation of the number i to hexadecimal.
  81326. */
  81327. static ToHex(i: number): string;
  81328. /**
  81329. * Returns -1 if value is negative and +1 is value is positive.
  81330. * @param value the value
  81331. * @returns the value itself if it's equal to zero.
  81332. */
  81333. static Sign(value: number): number;
  81334. /**
  81335. * Returns the value itself if it's between min and max.
  81336. * Returns min if the value is lower than min.
  81337. * Returns max if the value is greater than max.
  81338. * @param value the value to clmap
  81339. * @param min the min value to clamp to (default: 0)
  81340. * @param max the max value to clamp to (default: 1)
  81341. * @returns the clamped value
  81342. */
  81343. static Clamp(value: number, min?: number, max?: number): number;
  81344. /**
  81345. * the log2 of value.
  81346. * @param value the value to compute log2 of
  81347. * @returns the log2 of value.
  81348. */
  81349. static Log2(value: number): number;
  81350. /**
  81351. * Loops the value, so that it is never larger than length and never smaller than 0.
  81352. *
  81353. * This is similar to the modulo operator but it works with floating point numbers.
  81354. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  81355. * With t = 5 and length = 2.5, the result would be 0.0.
  81356. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  81357. * @param value the value
  81358. * @param length the length
  81359. * @returns the looped value
  81360. */
  81361. static Repeat(value: number, length: number): number;
  81362. /**
  81363. * Normalize the value between 0.0 and 1.0 using min and max values
  81364. * @param value value to normalize
  81365. * @param min max to normalize between
  81366. * @param max min to normalize between
  81367. * @returns the normalized value
  81368. */
  81369. static Normalize(value: number, min: number, max: number): number;
  81370. /**
  81371. * Denormalize the value from 0.0 and 1.0 using min and max values
  81372. * @param normalized value to denormalize
  81373. * @param min max to denormalize between
  81374. * @param max min to denormalize between
  81375. * @returns the denormalized value
  81376. */
  81377. static Denormalize(normalized: number, min: number, max: number): number;
  81378. /**
  81379. * Calculates the shortest difference between two given angles given in degrees.
  81380. * @param current current angle in degrees
  81381. * @param target target angle in degrees
  81382. * @returns the delta
  81383. */
  81384. static DeltaAngle(current: number, target: number): number;
  81385. /**
  81386. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  81387. * @param tx value
  81388. * @param length length
  81389. * @returns The returned value will move back and forth between 0 and length
  81390. */
  81391. static PingPong(tx: number, length: number): number;
  81392. /**
  81393. * Interpolates between min and max with smoothing at the limits.
  81394. *
  81395. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  81396. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  81397. * @param from from
  81398. * @param to to
  81399. * @param tx value
  81400. * @returns the smooth stepped value
  81401. */
  81402. static SmoothStep(from: number, to: number, tx: number): number;
  81403. /**
  81404. * Moves a value current towards target.
  81405. *
  81406. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  81407. * Negative values of maxDelta pushes the value away from target.
  81408. * @param current current value
  81409. * @param target target value
  81410. * @param maxDelta max distance to move
  81411. * @returns resulting value
  81412. */
  81413. static MoveTowards(current: number, target: number, maxDelta: number): number;
  81414. /**
  81415. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81416. *
  81417. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  81418. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  81419. * @param current current value
  81420. * @param target target value
  81421. * @param maxDelta max distance to move
  81422. * @returns resulting angle
  81423. */
  81424. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  81425. /**
  81426. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  81427. * @param start start value
  81428. * @param end target value
  81429. * @param amount amount to lerp between
  81430. * @returns the lerped value
  81431. */
  81432. static Lerp(start: number, end: number, amount: number): number;
  81433. /**
  81434. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81435. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  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 LerpAngle(start: number, end: number, amount: number): number;
  81442. /**
  81443. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  81444. * @param a start value
  81445. * @param b target value
  81446. * @param value value between a and b
  81447. * @returns the inverseLerp value
  81448. */
  81449. static InverseLerp(a: number, b: number, value: number): number;
  81450. /**
  81451. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  81452. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  81453. * @param value1 spline value
  81454. * @param tangent1 spline value
  81455. * @param value2 spline value
  81456. * @param tangent2 spline value
  81457. * @param amount input value
  81458. * @returns hermite result
  81459. */
  81460. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  81461. /**
  81462. * Returns a random float number between and min and max values
  81463. * @param min min value of random
  81464. * @param max max value of random
  81465. * @returns random value
  81466. */
  81467. static RandomRange(min: number, max: number): number;
  81468. /**
  81469. * This function returns percentage of a number in a given range.
  81470. *
  81471. * RangeToPercent(40,20,60) will return 0.5 (50%)
  81472. * RangeToPercent(34,0,100) will return 0.34 (34%)
  81473. * @param number to convert to percentage
  81474. * @param min min range
  81475. * @param max max range
  81476. * @returns the percentage
  81477. */
  81478. static RangeToPercent(number: number, min: number, max: number): number;
  81479. /**
  81480. * This function returns number that corresponds to the percentage in a given range.
  81481. *
  81482. * PercentToRange(0.34,0,100) will return 34.
  81483. * @param percent to convert to number
  81484. * @param min min range
  81485. * @param max max range
  81486. * @returns the number
  81487. */
  81488. static PercentToRange(percent: number, min: number, max: number): number;
  81489. /**
  81490. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  81491. * @param angle The angle to normalize in radian.
  81492. * @return The converted angle.
  81493. */
  81494. static NormalizeRadians(angle: number): number;
  81495. }
  81496. }
  81497. declare module BABYLON {
  81498. /**
  81499. * Constant used to convert a value to gamma space
  81500. * @ignorenaming
  81501. */
  81502. export const ToGammaSpace: number;
  81503. /**
  81504. * Constant used to convert a value to linear space
  81505. * @ignorenaming
  81506. */
  81507. export const ToLinearSpace = 2.2;
  81508. /**
  81509. * Constant used to define the minimal number value in Babylon.js
  81510. * @ignorenaming
  81511. */
  81512. let Epsilon: number;
  81513. }
  81514. declare module BABYLON {
  81515. /**
  81516. * Class used to represent a viewport on screen
  81517. */
  81518. export class Viewport {
  81519. /** viewport left coordinate */
  81520. x: number;
  81521. /** viewport top coordinate */
  81522. y: number;
  81523. /**viewport width */
  81524. width: number;
  81525. /** viewport height */
  81526. height: number;
  81527. /**
  81528. * Creates a Viewport object located at (x, y) and sized (width, height)
  81529. * @param x defines viewport left coordinate
  81530. * @param y defines viewport top coordinate
  81531. * @param width defines the viewport width
  81532. * @param height defines the viewport height
  81533. */
  81534. constructor(
  81535. /** viewport left coordinate */
  81536. x: number,
  81537. /** viewport top coordinate */
  81538. y: number,
  81539. /**viewport width */
  81540. width: number,
  81541. /** viewport height */
  81542. height: number);
  81543. /**
  81544. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  81545. * @param renderWidth defines the rendering width
  81546. * @param renderHeight defines the rendering height
  81547. * @returns a new Viewport
  81548. */
  81549. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  81550. /**
  81551. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  81552. * @param renderWidth defines the rendering width
  81553. * @param renderHeight defines the rendering height
  81554. * @param ref defines the target viewport
  81555. * @returns the current viewport
  81556. */
  81557. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  81558. /**
  81559. * Returns a new Viewport copied from the current one
  81560. * @returns a new Viewport
  81561. */
  81562. clone(): Viewport;
  81563. }
  81564. }
  81565. declare module BABYLON {
  81566. /**
  81567. * Class containing a set of static utilities functions for arrays.
  81568. */
  81569. export class ArrayTools {
  81570. /**
  81571. * Returns an array of the given size filled with element built from the given constructor and the paramters
  81572. * @param size the number of element to construct and put in the array
  81573. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  81574. * @returns a new array filled with new objects
  81575. */
  81576. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  81577. }
  81578. }
  81579. declare module BABYLON {
  81580. /**
  81581. * Represents a plane by the equation ax + by + cz + d = 0
  81582. */
  81583. export class Plane {
  81584. private static _TmpMatrix;
  81585. /**
  81586. * Normal of the plane (a,b,c)
  81587. */
  81588. normal: Vector3;
  81589. /**
  81590. * d component of the plane
  81591. */
  81592. d: number;
  81593. /**
  81594. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  81595. * @param a a component of the plane
  81596. * @param b b component of the plane
  81597. * @param c c component of the plane
  81598. * @param d d component of the plane
  81599. */
  81600. constructor(a: number, b: number, c: number, d: number);
  81601. /**
  81602. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  81603. */
  81604. asArray(): number[];
  81605. /**
  81606. * @returns a new plane copied from the current Plane.
  81607. */
  81608. clone(): Plane;
  81609. /**
  81610. * @returns the string "Plane".
  81611. */
  81612. getClassName(): string;
  81613. /**
  81614. * @returns the Plane hash code.
  81615. */
  81616. getHashCode(): number;
  81617. /**
  81618. * Normalize the current Plane in place.
  81619. * @returns the updated Plane.
  81620. */
  81621. normalize(): Plane;
  81622. /**
  81623. * Applies a transformation the plane and returns the result
  81624. * @param transformation the transformation matrix to be applied to the plane
  81625. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  81626. */
  81627. transform(transformation: DeepImmutable<Matrix>): Plane;
  81628. /**
  81629. * Compute the dot product between the point and the plane normal
  81630. * @param point point to calculate the dot product with
  81631. * @returns the dot product (float) of the point coordinates and the plane normal.
  81632. */
  81633. dotCoordinate(point: DeepImmutable<Vector3>): number;
  81634. /**
  81635. * Updates the current Plane from the plane defined by the three given points.
  81636. * @param point1 one of the points used to contruct the plane
  81637. * @param point2 one of the points used to contruct the plane
  81638. * @param point3 one of the points used to contruct the plane
  81639. * @returns the updated Plane.
  81640. */
  81641. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81642. /**
  81643. * Checks if the plane is facing a given direction
  81644. * @param direction the direction to check if the plane is facing
  81645. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  81646. * @returns True is the vector "direction" is the same side than the plane normal.
  81647. */
  81648. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  81649. /**
  81650. * Calculates the distance to a point
  81651. * @param point point to calculate distance to
  81652. * @returns the signed distance (float) from the given point to the Plane.
  81653. */
  81654. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  81655. /**
  81656. * Creates a plane from an array
  81657. * @param array the array to create a plane from
  81658. * @returns a new Plane from the given array.
  81659. */
  81660. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  81661. /**
  81662. * Creates a plane from three points
  81663. * @param point1 point used to create the plane
  81664. * @param point2 point used to create the plane
  81665. * @param point3 point used to create the plane
  81666. * @returns a new Plane defined by the three given points.
  81667. */
  81668. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81669. /**
  81670. * Creates a plane from an origin point and a normal
  81671. * @param origin origin of the plane to be constructed
  81672. * @param normal normal of the plane to be constructed
  81673. * @returns a new Plane the normal vector to this plane at the given origin point.
  81674. * Note : the vector "normal" is updated because normalized.
  81675. */
  81676. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  81677. /**
  81678. * Calculates the distance from a plane and a point
  81679. * @param origin origin of the plane to be constructed
  81680. * @param normal normal of the plane to be constructed
  81681. * @param point point to calculate distance to
  81682. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  81683. */
  81684. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  81685. }
  81686. }
  81687. declare module BABYLON {
  81688. /** @hidden */
  81689. export class PerformanceConfigurator {
  81690. /** @hidden */
  81691. static MatrixUse64Bits: boolean;
  81692. /** @hidden */
  81693. static MatrixTrackPrecisionChange: boolean;
  81694. /** @hidden */
  81695. static MatrixCurrentType: any;
  81696. /** @hidden */
  81697. static MatrixTrackedMatrices: Array<any> | null;
  81698. /** @hidden */
  81699. static SetMatrixPrecision(use64bits: boolean): void;
  81700. }
  81701. }
  81702. declare module BABYLON {
  81703. /**
  81704. * Class representing a vector containing 2 coordinates
  81705. */
  81706. export class Vector2 {
  81707. /** defines the first coordinate */
  81708. x: number;
  81709. /** defines the second coordinate */
  81710. y: number;
  81711. /**
  81712. * Creates a new Vector2 from the given x and y coordinates
  81713. * @param x defines the first coordinate
  81714. * @param y defines the second coordinate
  81715. */
  81716. constructor(
  81717. /** defines the first coordinate */
  81718. x?: number,
  81719. /** defines the second coordinate */
  81720. y?: number);
  81721. /**
  81722. * Gets a string with the Vector2 coordinates
  81723. * @returns a string with the Vector2 coordinates
  81724. */
  81725. toString(): string;
  81726. /**
  81727. * Gets class name
  81728. * @returns the string "Vector2"
  81729. */
  81730. getClassName(): string;
  81731. /**
  81732. * Gets current vector hash code
  81733. * @returns the Vector2 hash code as a number
  81734. */
  81735. getHashCode(): number;
  81736. /**
  81737. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  81738. * @param array defines the source array
  81739. * @param index defines the offset in source array
  81740. * @returns the current Vector2
  81741. */
  81742. toArray(array: FloatArray, index?: number): Vector2;
  81743. /**
  81744. * Update the current vector from an array
  81745. * @param array defines the destination array
  81746. * @param index defines the offset in the destination array
  81747. * @returns the current Vector3
  81748. */
  81749. fromArray(array: FloatArray, index?: number): Vector2;
  81750. /**
  81751. * Copy the current vector to an array
  81752. * @returns a new array with 2 elements: the Vector2 coordinates.
  81753. */
  81754. asArray(): number[];
  81755. /**
  81756. * Sets the Vector2 coordinates with the given Vector2 coordinates
  81757. * @param source defines the source Vector2
  81758. * @returns the current updated Vector2
  81759. */
  81760. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  81761. /**
  81762. * Sets the Vector2 coordinates with the given floats
  81763. * @param x defines the first coordinate
  81764. * @param y defines the second coordinate
  81765. * @returns the current updated Vector2
  81766. */
  81767. copyFromFloats(x: number, y: number): Vector2;
  81768. /**
  81769. * Sets the Vector2 coordinates with the given floats
  81770. * @param x defines the first coordinate
  81771. * @param y defines the second coordinate
  81772. * @returns the current updated Vector2
  81773. */
  81774. set(x: number, y: number): Vector2;
  81775. /**
  81776. * Add another vector with the current one
  81777. * @param otherVector defines the other vector
  81778. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  81779. */
  81780. add(otherVector: DeepImmutable<Vector2>): Vector2;
  81781. /**
  81782. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  81783. * @param otherVector defines the other vector
  81784. * @param result defines the target vector
  81785. * @returns the unmodified current Vector2
  81786. */
  81787. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81788. /**
  81789. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  81790. * @param otherVector defines the other vector
  81791. * @returns the current updated Vector2
  81792. */
  81793. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81794. /**
  81795. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  81796. * @param otherVector defines the other vector
  81797. * @returns a new Vector2
  81798. */
  81799. addVector3(otherVector: Vector3): Vector2;
  81800. /**
  81801. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  81802. * @param otherVector defines the other vector
  81803. * @returns a new Vector2
  81804. */
  81805. subtract(otherVector: Vector2): Vector2;
  81806. /**
  81807. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  81808. * @param otherVector defines the other vector
  81809. * @param result defines the target vector
  81810. * @returns the unmodified current Vector2
  81811. */
  81812. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81813. /**
  81814. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  81815. * @param otherVector defines the other vector
  81816. * @returns the current updated Vector2
  81817. */
  81818. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81819. /**
  81820. * Multiplies in place the current Vector2 coordinates by the given ones
  81821. * @param otherVector defines the other vector
  81822. * @returns the current updated Vector2
  81823. */
  81824. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81825. /**
  81826. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  81827. * @param otherVector defines the other vector
  81828. * @returns a new Vector2
  81829. */
  81830. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  81831. /**
  81832. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  81833. * @param otherVector defines the other vector
  81834. * @param result defines the target vector
  81835. * @returns the unmodified current Vector2
  81836. */
  81837. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81838. /**
  81839. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  81840. * @param x defines the first coordinate
  81841. * @param y defines the second coordinate
  81842. * @returns a new Vector2
  81843. */
  81844. multiplyByFloats(x: number, y: number): Vector2;
  81845. /**
  81846. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  81847. * @param otherVector defines the other vector
  81848. * @returns a new Vector2
  81849. */
  81850. divide(otherVector: Vector2): Vector2;
  81851. /**
  81852. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  81853. * @param otherVector defines the other vector
  81854. * @param result defines the target vector
  81855. * @returns the unmodified current Vector2
  81856. */
  81857. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81858. /**
  81859. * Divides the current Vector2 coordinates by the given ones
  81860. * @param otherVector defines the other vector
  81861. * @returns the current updated Vector2
  81862. */
  81863. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81864. /**
  81865. * Gets a new Vector2 with current Vector2 negated coordinates
  81866. * @returns a new Vector2
  81867. */
  81868. negate(): Vector2;
  81869. /**
  81870. * Negate this vector in place
  81871. * @returns this
  81872. */
  81873. negateInPlace(): Vector2;
  81874. /**
  81875. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  81876. * @param result defines the Vector3 object where to store the result
  81877. * @returns the current Vector2
  81878. */
  81879. negateToRef(result: Vector2): Vector2;
  81880. /**
  81881. * Multiply the Vector2 coordinates by scale
  81882. * @param scale defines the scaling factor
  81883. * @returns the current updated Vector2
  81884. */
  81885. scaleInPlace(scale: number): Vector2;
  81886. /**
  81887. * Returns a new Vector2 scaled by "scale" from the current Vector2
  81888. * @param scale defines the scaling factor
  81889. * @returns a new Vector2
  81890. */
  81891. scale(scale: number): Vector2;
  81892. /**
  81893. * Scale the current Vector2 values by a factor to a given Vector2
  81894. * @param scale defines the scale factor
  81895. * @param result defines the Vector2 object where to store the result
  81896. * @returns the unmodified current Vector2
  81897. */
  81898. scaleToRef(scale: number, result: Vector2): Vector2;
  81899. /**
  81900. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  81901. * @param scale defines the scale factor
  81902. * @param result defines the Vector2 object where to store the result
  81903. * @returns the unmodified current Vector2
  81904. */
  81905. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  81906. /**
  81907. * Gets a boolean if two vectors are equals
  81908. * @param otherVector defines the other vector
  81909. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  81910. */
  81911. equals(otherVector: DeepImmutable<Vector2>): boolean;
  81912. /**
  81913. * Gets a boolean if two vectors are equals (using an epsilon value)
  81914. * @param otherVector defines the other vector
  81915. * @param epsilon defines the minimal distance to consider equality
  81916. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  81917. */
  81918. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  81919. /**
  81920. * Gets a new Vector2 from current Vector2 floored values
  81921. * @returns a new Vector2
  81922. */
  81923. floor(): Vector2;
  81924. /**
  81925. * Gets a new Vector2 from current Vector2 floored values
  81926. * @returns a new Vector2
  81927. */
  81928. fract(): Vector2;
  81929. /**
  81930. * Gets the length of the vector
  81931. * @returns the vector length (float)
  81932. */
  81933. length(): number;
  81934. /**
  81935. * Gets the vector squared length
  81936. * @returns the vector squared length (float)
  81937. */
  81938. lengthSquared(): number;
  81939. /**
  81940. * Normalize the vector
  81941. * @returns the current updated Vector2
  81942. */
  81943. normalize(): Vector2;
  81944. /**
  81945. * Gets a new Vector2 copied from the Vector2
  81946. * @returns a new Vector2
  81947. */
  81948. clone(): Vector2;
  81949. /**
  81950. * Gets a new Vector2(0, 0)
  81951. * @returns a new Vector2
  81952. */
  81953. static Zero(): Vector2;
  81954. /**
  81955. * Gets a new Vector2(1, 1)
  81956. * @returns a new Vector2
  81957. */
  81958. static One(): Vector2;
  81959. /**
  81960. * Gets a new Vector2 set from the given index element of the given array
  81961. * @param array defines the data source
  81962. * @param offset defines the offset in the data source
  81963. * @returns a new Vector2
  81964. */
  81965. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  81966. /**
  81967. * Sets "result" from the given index element of the given array
  81968. * @param array defines the data source
  81969. * @param offset defines the offset in the data source
  81970. * @param result defines the target vector
  81971. */
  81972. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  81973. /**
  81974. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  81975. * @param value1 defines 1st point of control
  81976. * @param value2 defines 2nd point of control
  81977. * @param value3 defines 3rd point of control
  81978. * @param value4 defines 4th point of control
  81979. * @param amount defines the interpolation factor
  81980. * @returns a new Vector2
  81981. */
  81982. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  81983. /**
  81984. * 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".
  81985. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  81986. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  81987. * @param value defines the value to clamp
  81988. * @param min defines the lower limit
  81989. * @param max defines the upper limit
  81990. * @returns a new Vector2
  81991. */
  81992. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  81993. /**
  81994. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  81995. * @param value1 defines the 1st control point
  81996. * @param tangent1 defines the outgoing tangent
  81997. * @param value2 defines the 2nd control point
  81998. * @param tangent2 defines the incoming tangent
  81999. * @param amount defines the interpolation factor
  82000. * @returns a new Vector2
  82001. */
  82002. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  82003. /**
  82004. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  82005. * @param start defines the start vector
  82006. * @param end defines the end vector
  82007. * @param amount defines the interpolation factor
  82008. * @returns a new Vector2
  82009. */
  82010. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  82011. /**
  82012. * Gets the dot product of the vector "left" and the vector "right"
  82013. * @param left defines first vector
  82014. * @param right defines second vector
  82015. * @returns the dot product (float)
  82016. */
  82017. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  82018. /**
  82019. * Returns a new Vector2 equal to the normalized given vector
  82020. * @param vector defines the vector to normalize
  82021. * @returns a new Vector2
  82022. */
  82023. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  82024. /**
  82025. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  82026. * @param left defines 1st vector
  82027. * @param right defines 2nd vector
  82028. * @returns a new Vector2
  82029. */
  82030. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82031. /**
  82032. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  82033. * @param left defines 1st vector
  82034. * @param right defines 2nd vector
  82035. * @returns a new Vector2
  82036. */
  82037. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82038. /**
  82039. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  82040. * @param vector defines the vector to transform
  82041. * @param transformation defines the matrix to apply
  82042. * @returns a new Vector2
  82043. */
  82044. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  82045. /**
  82046. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  82047. * @param vector defines the vector to transform
  82048. * @param transformation defines the matrix to apply
  82049. * @param result defines the target vector
  82050. */
  82051. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  82052. /**
  82053. * Determines if a given vector is included in a triangle
  82054. * @param p defines the vector to test
  82055. * @param p0 defines 1st triangle point
  82056. * @param p1 defines 2nd triangle point
  82057. * @param p2 defines 3rd triangle point
  82058. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  82059. */
  82060. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  82061. /**
  82062. * Gets the distance between the vectors "value1" and "value2"
  82063. * @param value1 defines first vector
  82064. * @param value2 defines second vector
  82065. * @returns the distance between vectors
  82066. */
  82067. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82068. /**
  82069. * Returns the squared distance between the vectors "value1" and "value2"
  82070. * @param value1 defines first vector
  82071. * @param value2 defines second vector
  82072. * @returns the squared distance between vectors
  82073. */
  82074. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82075. /**
  82076. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  82077. * @param value1 defines first vector
  82078. * @param value2 defines second vector
  82079. * @returns a new Vector2
  82080. */
  82081. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  82082. /**
  82083. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  82084. * @param p defines the middle point
  82085. * @param segA defines one point of the segment
  82086. * @param segB defines the other point of the segment
  82087. * @returns the shortest distance
  82088. */
  82089. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  82090. }
  82091. /**
  82092. * Class used to store (x,y,z) vector representation
  82093. * A Vector3 is the main object used in 3D geometry
  82094. * It can represent etiher the coordinates of a point the space, either a direction
  82095. * Reminder: js uses a left handed forward facing system
  82096. */
  82097. export class Vector3 {
  82098. private static _UpReadOnly;
  82099. private static _ZeroReadOnly;
  82100. /** @hidden */
  82101. _x: number;
  82102. /** @hidden */
  82103. _y: number;
  82104. /** @hidden */
  82105. _z: number;
  82106. /** @hidden */
  82107. _isDirty: boolean;
  82108. /** Gets or sets the x coordinate */
  82109. get x(): number;
  82110. set x(value: number);
  82111. /** Gets or sets the y coordinate */
  82112. get y(): number;
  82113. set y(value: number);
  82114. /** Gets or sets the z coordinate */
  82115. get z(): number;
  82116. set z(value: number);
  82117. /**
  82118. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  82119. * @param x defines the first coordinates (on X axis)
  82120. * @param y defines the second coordinates (on Y axis)
  82121. * @param z defines the third coordinates (on Z axis)
  82122. */
  82123. constructor(x?: number, y?: number, z?: number);
  82124. /**
  82125. * Creates a string representation of the Vector3
  82126. * @returns a string with the Vector3 coordinates.
  82127. */
  82128. toString(): string;
  82129. /**
  82130. * Gets the class name
  82131. * @returns the string "Vector3"
  82132. */
  82133. getClassName(): string;
  82134. /**
  82135. * Creates the Vector3 hash code
  82136. * @returns a number which tends to be unique between Vector3 instances
  82137. */
  82138. getHashCode(): number;
  82139. /**
  82140. * Creates an array containing three elements : the coordinates of the Vector3
  82141. * @returns a new array of numbers
  82142. */
  82143. asArray(): number[];
  82144. /**
  82145. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  82146. * @param array defines the destination array
  82147. * @param index defines the offset in the destination array
  82148. * @returns the current Vector3
  82149. */
  82150. toArray(array: FloatArray, index?: number): Vector3;
  82151. /**
  82152. * Update the current vector from an array
  82153. * @param array defines the destination array
  82154. * @param index defines the offset in the destination array
  82155. * @returns the current Vector3
  82156. */
  82157. fromArray(array: FloatArray, index?: number): Vector3;
  82158. /**
  82159. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  82160. * @returns a new Quaternion object, computed from the Vector3 coordinates
  82161. */
  82162. toQuaternion(): Quaternion;
  82163. /**
  82164. * Adds the given vector to the current Vector3
  82165. * @param otherVector defines the second operand
  82166. * @returns the current updated Vector3
  82167. */
  82168. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82169. /**
  82170. * Adds the given coordinates to the current Vector3
  82171. * @param x defines the x coordinate of the operand
  82172. * @param y defines the y coordinate of the operand
  82173. * @param z defines the z coordinate of the operand
  82174. * @returns the current updated Vector3
  82175. */
  82176. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82177. /**
  82178. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  82179. * @param otherVector defines the second operand
  82180. * @returns the resulting Vector3
  82181. */
  82182. add(otherVector: DeepImmutable<Vector3>): Vector3;
  82183. /**
  82184. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  82185. * @param otherVector defines the second operand
  82186. * @param result defines the Vector3 object where to store the result
  82187. * @returns the current Vector3
  82188. */
  82189. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82190. /**
  82191. * Subtract the given vector from the current Vector3
  82192. * @param otherVector defines the second operand
  82193. * @returns the current updated Vector3
  82194. */
  82195. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82196. /**
  82197. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  82198. * @param otherVector defines the second operand
  82199. * @returns the resulting Vector3
  82200. */
  82201. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  82202. /**
  82203. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  82204. * @param otherVector defines the second operand
  82205. * @param result defines the Vector3 object where to store the result
  82206. * @returns the current Vector3
  82207. */
  82208. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82209. /**
  82210. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  82211. * @param x defines the x coordinate of the operand
  82212. * @param y defines the y coordinate of the operand
  82213. * @param z defines the z coordinate of the operand
  82214. * @returns the resulting Vector3
  82215. */
  82216. subtractFromFloats(x: number, y: number, z: number): Vector3;
  82217. /**
  82218. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  82219. * @param x defines the x coordinate of the operand
  82220. * @param y defines the y coordinate of the operand
  82221. * @param z defines the z coordinate of the operand
  82222. * @param result defines the Vector3 object where to store the result
  82223. * @returns the current Vector3
  82224. */
  82225. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  82226. /**
  82227. * Gets a new Vector3 set with the current Vector3 negated coordinates
  82228. * @returns a new Vector3
  82229. */
  82230. negate(): Vector3;
  82231. /**
  82232. * Negate this vector in place
  82233. * @returns this
  82234. */
  82235. negateInPlace(): Vector3;
  82236. /**
  82237. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  82238. * @param result defines the Vector3 object where to store the result
  82239. * @returns the current Vector3
  82240. */
  82241. negateToRef(result: Vector3): Vector3;
  82242. /**
  82243. * Multiplies the Vector3 coordinates by the float "scale"
  82244. * @param scale defines the multiplier factor
  82245. * @returns the current updated Vector3
  82246. */
  82247. scaleInPlace(scale: number): Vector3;
  82248. /**
  82249. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  82250. * @param scale defines the multiplier factor
  82251. * @returns a new Vector3
  82252. */
  82253. scale(scale: number): Vector3;
  82254. /**
  82255. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  82256. * @param scale defines the multiplier factor
  82257. * @param result defines the Vector3 object where to store the result
  82258. * @returns the current Vector3
  82259. */
  82260. scaleToRef(scale: number, result: Vector3): Vector3;
  82261. /**
  82262. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  82263. * @param scale defines the scale factor
  82264. * @param result defines the Vector3 object where to store the result
  82265. * @returns the unmodified current Vector3
  82266. */
  82267. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  82268. /**
  82269. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82270. * @param origin defines the origin of the projection ray
  82271. * @param plane defines the plane to project to
  82272. * @returns the projected vector3
  82273. */
  82274. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  82275. /**
  82276. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82277. * @param origin defines the origin of the projection ray
  82278. * @param plane defines the plane to project to
  82279. * @param result defines the Vector3 where to store the result
  82280. */
  82281. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  82282. /**
  82283. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  82284. * @param otherVector defines the second operand
  82285. * @returns true if both vectors are equals
  82286. */
  82287. equals(otherVector: DeepImmutable<Vector3>): boolean;
  82288. /**
  82289. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  82290. * @param otherVector defines the second operand
  82291. * @param epsilon defines the minimal distance to define values as equals
  82292. * @returns true if both vectors are distant less than epsilon
  82293. */
  82294. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  82295. /**
  82296. * Returns true if the current Vector3 coordinates equals the given floats
  82297. * @param x defines the x coordinate of the operand
  82298. * @param y defines the y coordinate of the operand
  82299. * @param z defines the z coordinate of the operand
  82300. * @returns true if both vectors are equals
  82301. */
  82302. equalsToFloats(x: number, y: number, z: number): boolean;
  82303. /**
  82304. * Multiplies the current Vector3 coordinates by the given ones
  82305. * @param otherVector defines the second operand
  82306. * @returns the current updated Vector3
  82307. */
  82308. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82309. /**
  82310. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  82311. * @param otherVector defines the second operand
  82312. * @returns the new Vector3
  82313. */
  82314. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  82315. /**
  82316. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  82317. * @param otherVector defines the second operand
  82318. * @param result defines the Vector3 object where to store the result
  82319. * @returns the current Vector3
  82320. */
  82321. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82322. /**
  82323. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  82324. * @param x defines the x coordinate of the operand
  82325. * @param y defines the y coordinate of the operand
  82326. * @param z defines the z coordinate of the operand
  82327. * @returns the new Vector3
  82328. */
  82329. multiplyByFloats(x: number, y: number, z: number): Vector3;
  82330. /**
  82331. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  82332. * @param otherVector defines the second operand
  82333. * @returns the new Vector3
  82334. */
  82335. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  82336. /**
  82337. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  82338. * @param otherVector defines the second operand
  82339. * @param result defines the Vector3 object where to store the result
  82340. * @returns the current Vector3
  82341. */
  82342. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82343. /**
  82344. * Divides the current Vector3 coordinates by the given ones.
  82345. * @param otherVector defines the second operand
  82346. * @returns the current updated Vector3
  82347. */
  82348. divideInPlace(otherVector: Vector3): Vector3;
  82349. /**
  82350. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  82351. * @param other defines the second operand
  82352. * @returns the current updated Vector3
  82353. */
  82354. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82355. /**
  82356. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  82357. * @param other defines the second operand
  82358. * @returns the current updated Vector3
  82359. */
  82360. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82361. /**
  82362. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  82363. * @param x defines the x coordinate of the operand
  82364. * @param y defines the y coordinate of the operand
  82365. * @param z defines the z coordinate of the operand
  82366. * @returns the current updated Vector3
  82367. */
  82368. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82369. /**
  82370. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  82371. * @param x defines the x coordinate of the operand
  82372. * @param y defines the y coordinate of the operand
  82373. * @param z defines the z coordinate of the operand
  82374. * @returns the current updated Vector3
  82375. */
  82376. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82377. /**
  82378. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  82379. * Check if is non uniform within a certain amount of decimal places to account for this
  82380. * @param epsilon the amount the values can differ
  82381. * @returns if the the vector is non uniform to a certain number of decimal places
  82382. */
  82383. isNonUniformWithinEpsilon(epsilon: number): boolean;
  82384. /**
  82385. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  82386. */
  82387. get isNonUniform(): boolean;
  82388. /**
  82389. * Gets a new Vector3 from current Vector3 floored values
  82390. * @returns a new Vector3
  82391. */
  82392. floor(): Vector3;
  82393. /**
  82394. * Gets a new Vector3 from current Vector3 floored values
  82395. * @returns a new Vector3
  82396. */
  82397. fract(): Vector3;
  82398. /**
  82399. * Gets the length of the Vector3
  82400. * @returns the length of the Vector3
  82401. */
  82402. length(): number;
  82403. /**
  82404. * Gets the squared length of the Vector3
  82405. * @returns squared length of the Vector3
  82406. */
  82407. lengthSquared(): number;
  82408. /**
  82409. * Normalize the current Vector3.
  82410. * Please note that this is an in place operation.
  82411. * @returns the current updated Vector3
  82412. */
  82413. normalize(): Vector3;
  82414. /**
  82415. * Reorders the x y z properties of the vector in place
  82416. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  82417. * @returns the current updated vector
  82418. */
  82419. reorderInPlace(order: string): this;
  82420. /**
  82421. * Rotates the vector around 0,0,0 by a quaternion
  82422. * @param quaternion the rotation quaternion
  82423. * @param result vector to store the result
  82424. * @returns the resulting vector
  82425. */
  82426. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  82427. /**
  82428. * Rotates a vector around a given point
  82429. * @param quaternion the rotation quaternion
  82430. * @param point the point to rotate around
  82431. * @param result vector to store the result
  82432. * @returns the resulting vector
  82433. */
  82434. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  82435. /**
  82436. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  82437. * The cross product is then orthogonal to both current and "other"
  82438. * @param other defines the right operand
  82439. * @returns the cross product
  82440. */
  82441. cross(other: Vector3): Vector3;
  82442. /**
  82443. * Normalize the current Vector3 with the given input length.
  82444. * Please note that this is an in place operation.
  82445. * @param len the length of the vector
  82446. * @returns the current updated Vector3
  82447. */
  82448. normalizeFromLength(len: number): Vector3;
  82449. /**
  82450. * Normalize the current Vector3 to a new vector
  82451. * @returns the new Vector3
  82452. */
  82453. normalizeToNew(): Vector3;
  82454. /**
  82455. * Normalize the current Vector3 to the reference
  82456. * @param reference define the Vector3 to update
  82457. * @returns the updated Vector3
  82458. */
  82459. normalizeToRef(reference: Vector3): Vector3;
  82460. /**
  82461. * Creates a new Vector3 copied from the current Vector3
  82462. * @returns the new Vector3
  82463. */
  82464. clone(): Vector3;
  82465. /**
  82466. * Copies the given vector coordinates to the current Vector3 ones
  82467. * @param source defines the source Vector3
  82468. * @returns the current updated Vector3
  82469. */
  82470. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  82471. /**
  82472. * Copies the given floats to the current Vector3 coordinates
  82473. * @param x defines the x coordinate of the operand
  82474. * @param y defines the y coordinate of the operand
  82475. * @param z defines the z coordinate of the operand
  82476. * @returns the current updated Vector3
  82477. */
  82478. copyFromFloats(x: number, y: number, z: number): Vector3;
  82479. /**
  82480. * Copies the given floats to the current Vector3 coordinates
  82481. * @param x defines the x coordinate of the operand
  82482. * @param y defines the y coordinate of the operand
  82483. * @param z defines the z coordinate of the operand
  82484. * @returns the current updated Vector3
  82485. */
  82486. set(x: number, y: number, z: number): Vector3;
  82487. /**
  82488. * Copies the given float to the current Vector3 coordinates
  82489. * @param v defines the x, y and z coordinates of the operand
  82490. * @returns the current updated Vector3
  82491. */
  82492. setAll(v: number): Vector3;
  82493. /**
  82494. * Get the clip factor between two vectors
  82495. * @param vector0 defines the first operand
  82496. * @param vector1 defines the second operand
  82497. * @param axis defines the axis to use
  82498. * @param size defines the size along the axis
  82499. * @returns the clip factor
  82500. */
  82501. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  82502. /**
  82503. * Get angle between two vectors
  82504. * @param vector0 angle between vector0 and vector1
  82505. * @param vector1 angle between vector0 and vector1
  82506. * @param normal direction of the normal
  82507. * @return the angle between vector0 and vector1
  82508. */
  82509. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  82510. /**
  82511. * Returns a new Vector3 set from the index "offset" of the given array
  82512. * @param array defines the source array
  82513. * @param offset defines the offset in the source array
  82514. * @returns the new Vector3
  82515. */
  82516. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  82517. /**
  82518. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  82519. * @param array defines the source array
  82520. * @param offset defines the offset in the source array
  82521. * @returns the new Vector3
  82522. * @deprecated Please use FromArray instead.
  82523. */
  82524. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  82525. /**
  82526. * Sets the given vector "result" with the element values from the index "offset" of the given array
  82527. * @param array defines the source array
  82528. * @param offset defines the offset in the source array
  82529. * @param result defines the Vector3 where to store the result
  82530. */
  82531. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  82532. /**
  82533. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  82534. * @param array defines the source array
  82535. * @param offset defines the offset in the source array
  82536. * @param result defines the Vector3 where to store the result
  82537. * @deprecated Please use FromArrayToRef instead.
  82538. */
  82539. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  82540. /**
  82541. * Sets the given vector "result" with the given floats.
  82542. * @param x defines the x coordinate of the source
  82543. * @param y defines the y coordinate of the source
  82544. * @param z defines the z coordinate of the source
  82545. * @param result defines the Vector3 where to store the result
  82546. */
  82547. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  82548. /**
  82549. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  82550. * @returns a new empty Vector3
  82551. */
  82552. static Zero(): Vector3;
  82553. /**
  82554. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  82555. * @returns a new unit Vector3
  82556. */
  82557. static One(): Vector3;
  82558. /**
  82559. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  82560. * @returns a new up Vector3
  82561. */
  82562. static Up(): Vector3;
  82563. /**
  82564. * Gets a up Vector3 that must not be updated
  82565. */
  82566. static get UpReadOnly(): DeepImmutable<Vector3>;
  82567. /**
  82568. * Gets a zero Vector3 that must not be updated
  82569. */
  82570. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  82571. /**
  82572. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  82573. * @returns a new down Vector3
  82574. */
  82575. static Down(): Vector3;
  82576. /**
  82577. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  82578. * @param rightHandedSystem is the scene right-handed (negative z)
  82579. * @returns a new forward Vector3
  82580. */
  82581. static Forward(rightHandedSystem?: boolean): Vector3;
  82582. /**
  82583. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  82584. * @param rightHandedSystem is the scene right-handed (negative-z)
  82585. * @returns a new forward Vector3
  82586. */
  82587. static Backward(rightHandedSystem?: boolean): Vector3;
  82588. /**
  82589. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  82590. * @returns a new right Vector3
  82591. */
  82592. static Right(): Vector3;
  82593. /**
  82594. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  82595. * @returns a new left Vector3
  82596. */
  82597. static Left(): Vector3;
  82598. /**
  82599. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  82600. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82601. * @param vector defines the Vector3 to transform
  82602. * @param transformation defines the transformation matrix
  82603. * @returns the transformed Vector3
  82604. */
  82605. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82606. /**
  82607. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  82608. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82609. * @param vector defines the Vector3 to transform
  82610. * @param transformation defines the transformation matrix
  82611. * @param result defines the Vector3 where to store the result
  82612. */
  82613. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82614. /**
  82615. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  82616. * This method computes tranformed coordinates only, not transformed direction vectors
  82617. * @param x define the x coordinate of the source vector
  82618. * @param y define the y coordinate of the source vector
  82619. * @param z define the z coordinate of the source vector
  82620. * @param transformation defines the transformation matrix
  82621. * @param result defines the Vector3 where to store the result
  82622. */
  82623. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82624. /**
  82625. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  82626. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82627. * @param vector defines the Vector3 to transform
  82628. * @param transformation defines the transformation matrix
  82629. * @returns the new Vector3
  82630. */
  82631. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82632. /**
  82633. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  82634. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82635. * @param vector defines the Vector3 to transform
  82636. * @param transformation defines the transformation matrix
  82637. * @param result defines the Vector3 where to store the result
  82638. */
  82639. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82640. /**
  82641. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  82642. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82643. * @param x define the x coordinate of the source vector
  82644. * @param y define the y coordinate of the source vector
  82645. * @param z define the z coordinate of the source vector
  82646. * @param transformation defines the transformation matrix
  82647. * @param result defines the Vector3 where to store the result
  82648. */
  82649. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82650. /**
  82651. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  82652. * @param value1 defines the first control point
  82653. * @param value2 defines the second control point
  82654. * @param value3 defines the third control point
  82655. * @param value4 defines the fourth control point
  82656. * @param amount defines the amount on the spline to use
  82657. * @returns the new Vector3
  82658. */
  82659. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  82660. /**
  82661. * 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"
  82662. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82663. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82664. * @param value defines the current value
  82665. * @param min defines the lower range value
  82666. * @param max defines the upper range value
  82667. * @returns the new Vector3
  82668. */
  82669. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  82670. /**
  82671. * 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"
  82672. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82673. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82674. * @param value defines the current value
  82675. * @param min defines the lower range value
  82676. * @param max defines the upper range value
  82677. * @param result defines the Vector3 where to store the result
  82678. */
  82679. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  82680. /**
  82681. * Checks if a given vector is inside a specific range
  82682. * @param v defines the vector to test
  82683. * @param min defines the minimum range
  82684. * @param max defines the maximum range
  82685. */
  82686. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  82687. /**
  82688. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  82689. * @param value1 defines the first control point
  82690. * @param tangent1 defines the first tangent vector
  82691. * @param value2 defines the second control point
  82692. * @param tangent2 defines the second tangent vector
  82693. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  82694. * @returns the new Vector3
  82695. */
  82696. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  82697. /**
  82698. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  82699. * @param start defines the start value
  82700. * @param end defines the end value
  82701. * @param amount max defines amount between both (between 0 and 1)
  82702. * @returns the new Vector3
  82703. */
  82704. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  82705. /**
  82706. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  82707. * @param start defines the start value
  82708. * @param end defines the end value
  82709. * @param amount max defines amount between both (between 0 and 1)
  82710. * @param result defines the Vector3 where to store the result
  82711. */
  82712. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  82713. /**
  82714. * Returns the dot product (float) between the vectors "left" and "right"
  82715. * @param left defines the left operand
  82716. * @param right defines the right operand
  82717. * @returns the dot product
  82718. */
  82719. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  82720. /**
  82721. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  82722. * The cross product is then orthogonal to both "left" and "right"
  82723. * @param left defines the left operand
  82724. * @param right defines the right operand
  82725. * @returns the cross product
  82726. */
  82727. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82728. /**
  82729. * Sets the given vector "result" with the cross product of "left" and "right"
  82730. * The cross product is then orthogonal to both "left" and "right"
  82731. * @param left defines the left operand
  82732. * @param right defines the right operand
  82733. * @param result defines the Vector3 where to store the result
  82734. */
  82735. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  82736. /**
  82737. * Returns a new Vector3 as the normalization of the given vector
  82738. * @param vector defines the Vector3 to normalize
  82739. * @returns the new Vector3
  82740. */
  82741. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  82742. /**
  82743. * Sets the given vector "result" with the normalization of the given first vector
  82744. * @param vector defines the Vector3 to normalize
  82745. * @param result defines the Vector3 where to store the result
  82746. */
  82747. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  82748. /**
  82749. * Project a Vector3 onto screen space
  82750. * @param vector defines the Vector3 to project
  82751. * @param world defines the world matrix to use
  82752. * @param transform defines the transform (view x projection) matrix to use
  82753. * @param viewport defines the screen viewport to use
  82754. * @returns the new Vector3
  82755. */
  82756. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  82757. /** @hidden */
  82758. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  82759. /**
  82760. * Unproject from screen space to object space
  82761. * @param source defines the screen space Vector3 to use
  82762. * @param viewportWidth defines the current width of the viewport
  82763. * @param viewportHeight defines the current height of the viewport
  82764. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82765. * @param transform defines the transform (view x projection) matrix to use
  82766. * @returns the new Vector3
  82767. */
  82768. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  82769. /**
  82770. * Unproject from screen space to object space
  82771. * @param source defines the screen space Vector3 to use
  82772. * @param viewportWidth defines the current width of the viewport
  82773. * @param viewportHeight defines the current height of the viewport
  82774. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82775. * @param view defines the view matrix to use
  82776. * @param projection defines the projection matrix to use
  82777. * @returns the new Vector3
  82778. */
  82779. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  82780. /**
  82781. * Unproject from screen space to object space
  82782. * @param source defines the screen space Vector3 to use
  82783. * @param viewportWidth defines the current width of the viewport
  82784. * @param viewportHeight defines the current height of the viewport
  82785. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82786. * @param view defines the view matrix to use
  82787. * @param projection defines the projection matrix to use
  82788. * @param result defines the Vector3 where to store the result
  82789. */
  82790. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82791. /**
  82792. * Unproject from screen space to object space
  82793. * @param sourceX defines the screen space x coordinate to use
  82794. * @param sourceY defines the screen space y coordinate to use
  82795. * @param sourceZ defines the screen space z coordinate to use
  82796. * @param viewportWidth defines the current width of the viewport
  82797. * @param viewportHeight defines the current height of the viewport
  82798. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82799. * @param view defines the view matrix to use
  82800. * @param projection defines the projection matrix to use
  82801. * @param result defines the Vector3 where to store the result
  82802. */
  82803. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82804. /**
  82805. * Gets the minimal coordinate values between two Vector3
  82806. * @param left defines the first operand
  82807. * @param right defines the second operand
  82808. * @returns the new Vector3
  82809. */
  82810. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82811. /**
  82812. * Gets the maximal coordinate values between two Vector3
  82813. * @param left defines the first operand
  82814. * @param right defines the second operand
  82815. * @returns the new Vector3
  82816. */
  82817. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82818. /**
  82819. * Returns the distance between the vectors "value1" and "value2"
  82820. * @param value1 defines the first operand
  82821. * @param value2 defines the second operand
  82822. * @returns the distance
  82823. */
  82824. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82825. /**
  82826. * Returns the squared distance between the vectors "value1" and "value2"
  82827. * @param value1 defines the first operand
  82828. * @param value2 defines the second operand
  82829. * @returns the squared distance
  82830. */
  82831. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82832. /**
  82833. * Returns a new Vector3 located at the center between "value1" and "value2"
  82834. * @param value1 defines the first operand
  82835. * @param value2 defines the second operand
  82836. * @returns the new Vector3
  82837. */
  82838. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  82839. /**
  82840. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  82841. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  82842. * to something in order to rotate it from its local system to the given target system
  82843. * Note: axis1, axis2 and axis3 are normalized during this operation
  82844. * @param axis1 defines the first axis
  82845. * @param axis2 defines the second axis
  82846. * @param axis3 defines the third axis
  82847. * @returns a new Vector3
  82848. */
  82849. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  82850. /**
  82851. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  82852. * @param axis1 defines the first axis
  82853. * @param axis2 defines the second axis
  82854. * @param axis3 defines the third axis
  82855. * @param ref defines the Vector3 where to store the result
  82856. */
  82857. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  82858. }
  82859. /**
  82860. * Vector4 class created for EulerAngle class conversion to Quaternion
  82861. */
  82862. export class Vector4 {
  82863. /** x value of the vector */
  82864. x: number;
  82865. /** y value of the vector */
  82866. y: number;
  82867. /** z value of the vector */
  82868. z: number;
  82869. /** w value of the vector */
  82870. w: number;
  82871. /**
  82872. * Creates a Vector4 object from the given floats.
  82873. * @param x x value of the vector
  82874. * @param y y value of the vector
  82875. * @param z z value of the vector
  82876. * @param w w value of the vector
  82877. */
  82878. constructor(
  82879. /** x value of the vector */
  82880. x: number,
  82881. /** y value of the vector */
  82882. y: number,
  82883. /** z value of the vector */
  82884. z: number,
  82885. /** w value of the vector */
  82886. w: number);
  82887. /**
  82888. * Returns the string with the Vector4 coordinates.
  82889. * @returns a string containing all the vector values
  82890. */
  82891. toString(): string;
  82892. /**
  82893. * Returns the string "Vector4".
  82894. * @returns "Vector4"
  82895. */
  82896. getClassName(): string;
  82897. /**
  82898. * Returns the Vector4 hash code.
  82899. * @returns a unique hash code
  82900. */
  82901. getHashCode(): number;
  82902. /**
  82903. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  82904. * @returns the resulting array
  82905. */
  82906. asArray(): number[];
  82907. /**
  82908. * Populates the given array from the given index with the Vector4 coordinates.
  82909. * @param array array to populate
  82910. * @param index index of the array to start at (default: 0)
  82911. * @returns the Vector4.
  82912. */
  82913. toArray(array: FloatArray, index?: number): Vector4;
  82914. /**
  82915. * Update the current vector from an array
  82916. * @param array defines the destination array
  82917. * @param index defines the offset in the destination array
  82918. * @returns the current Vector3
  82919. */
  82920. fromArray(array: FloatArray, index?: number): Vector4;
  82921. /**
  82922. * Adds the given vector to the current Vector4.
  82923. * @param otherVector the vector to add
  82924. * @returns the updated Vector4.
  82925. */
  82926. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82927. /**
  82928. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  82929. * @param otherVector the vector to add
  82930. * @returns the resulting vector
  82931. */
  82932. add(otherVector: DeepImmutable<Vector4>): Vector4;
  82933. /**
  82934. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  82935. * @param otherVector the vector to add
  82936. * @param result the vector to store the result
  82937. * @returns the current Vector4.
  82938. */
  82939. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82940. /**
  82941. * Subtract in place the given vector from the current Vector4.
  82942. * @param otherVector the vector to subtract
  82943. * @returns the updated Vector4.
  82944. */
  82945. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82946. /**
  82947. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  82948. * @param otherVector the vector to add
  82949. * @returns the new vector with the result
  82950. */
  82951. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  82952. /**
  82953. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  82954. * @param otherVector the vector to subtract
  82955. * @param result the vector to store the result
  82956. * @returns the current Vector4.
  82957. */
  82958. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82959. /**
  82960. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82961. */
  82962. /**
  82963. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82964. * @param x value to subtract
  82965. * @param y value to subtract
  82966. * @param z value to subtract
  82967. * @param w value to subtract
  82968. * @returns new vector containing the result
  82969. */
  82970. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  82971. /**
  82972. * Sets the given vector "result" 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. * @param result the vector to store the result in
  82978. * @returns the current Vector4.
  82979. */
  82980. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  82981. /**
  82982. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  82983. * @returns a new vector with the negated values
  82984. */
  82985. negate(): Vector4;
  82986. /**
  82987. * Negate this vector in place
  82988. * @returns this
  82989. */
  82990. negateInPlace(): Vector4;
  82991. /**
  82992. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  82993. * @param result defines the Vector3 object where to store the result
  82994. * @returns the current Vector4
  82995. */
  82996. negateToRef(result: Vector4): Vector4;
  82997. /**
  82998. * Multiplies the current Vector4 coordinates by scale (float).
  82999. * @param scale the number to scale with
  83000. * @returns the updated Vector4.
  83001. */
  83002. scaleInPlace(scale: number): Vector4;
  83003. /**
  83004. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  83005. * @param scale the number to scale with
  83006. * @returns a new vector with the result
  83007. */
  83008. scale(scale: number): Vector4;
  83009. /**
  83010. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  83011. * @param scale the number to scale with
  83012. * @param result a vector to store the result in
  83013. * @returns the current Vector4.
  83014. */
  83015. scaleToRef(scale: number, result: Vector4): Vector4;
  83016. /**
  83017. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  83018. * @param scale defines the scale factor
  83019. * @param result defines the Vector4 object where to store the result
  83020. * @returns the unmodified current Vector4
  83021. */
  83022. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  83023. /**
  83024. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  83025. * @param otherVector the vector to compare against
  83026. * @returns true if they are equal
  83027. */
  83028. equals(otherVector: DeepImmutable<Vector4>): boolean;
  83029. /**
  83030. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  83031. * @param otherVector vector to compare against
  83032. * @param epsilon (Default: very small number)
  83033. * @returns true if they are equal
  83034. */
  83035. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  83036. /**
  83037. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  83038. * @param x x value to compare against
  83039. * @param y y value to compare against
  83040. * @param z z value to compare against
  83041. * @param w w value to compare against
  83042. * @returns true if equal
  83043. */
  83044. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  83045. /**
  83046. * Multiplies in place the current Vector4 by the given one.
  83047. * @param otherVector vector to multiple with
  83048. * @returns the updated Vector4.
  83049. */
  83050. multiplyInPlace(otherVector: Vector4): Vector4;
  83051. /**
  83052. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  83053. * @param otherVector vector to multiple with
  83054. * @returns resulting new vector
  83055. */
  83056. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  83057. /**
  83058. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  83059. * @param otherVector vector to multiple with
  83060. * @param result vector to store the result
  83061. * @returns the current Vector4.
  83062. */
  83063. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83064. /**
  83065. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  83066. * @param x x value multiply with
  83067. * @param y y value multiply with
  83068. * @param z z value multiply with
  83069. * @param w w value multiply with
  83070. * @returns resulting new vector
  83071. */
  83072. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  83073. /**
  83074. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  83075. * @param otherVector vector to devide with
  83076. * @returns resulting new vector
  83077. */
  83078. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  83079. /**
  83080. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  83081. * @param otherVector vector to devide with
  83082. * @param result vector to store the result
  83083. * @returns the current Vector4.
  83084. */
  83085. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83086. /**
  83087. * Divides the current Vector3 coordinates by the given ones.
  83088. * @param otherVector vector to devide with
  83089. * @returns the updated Vector3.
  83090. */
  83091. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83092. /**
  83093. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  83094. * @param other defines the second operand
  83095. * @returns the current updated Vector4
  83096. */
  83097. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83098. /**
  83099. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  83100. * @param other defines the second operand
  83101. * @returns the current updated Vector4
  83102. */
  83103. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83104. /**
  83105. * Gets a new Vector4 from current Vector4 floored values
  83106. * @returns a new Vector4
  83107. */
  83108. floor(): Vector4;
  83109. /**
  83110. * Gets a new Vector4 from current Vector3 floored values
  83111. * @returns a new Vector4
  83112. */
  83113. fract(): Vector4;
  83114. /**
  83115. * Returns the Vector4 length (float).
  83116. * @returns the length
  83117. */
  83118. length(): number;
  83119. /**
  83120. * Returns the Vector4 squared length (float).
  83121. * @returns the length squared
  83122. */
  83123. lengthSquared(): number;
  83124. /**
  83125. * Normalizes in place the Vector4.
  83126. * @returns the updated Vector4.
  83127. */
  83128. normalize(): Vector4;
  83129. /**
  83130. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  83131. * @returns this converted to a new vector3
  83132. */
  83133. toVector3(): Vector3;
  83134. /**
  83135. * Returns a new Vector4 copied from the current one.
  83136. * @returns the new cloned vector
  83137. */
  83138. clone(): Vector4;
  83139. /**
  83140. * Updates the current Vector4 with the given one coordinates.
  83141. * @param source the source vector to copy from
  83142. * @returns the updated Vector4.
  83143. */
  83144. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  83145. /**
  83146. * Updates the current Vector4 coordinates with the given floats.
  83147. * @param x float to copy from
  83148. * @param y float to copy from
  83149. * @param z float to copy from
  83150. * @param w float to copy from
  83151. * @returns the updated Vector4.
  83152. */
  83153. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  83154. /**
  83155. * Updates the current Vector4 coordinates with the given floats.
  83156. * @param x float to set from
  83157. * @param y float to set from
  83158. * @param z float to set from
  83159. * @param w float to set from
  83160. * @returns the updated Vector4.
  83161. */
  83162. set(x: number, y: number, z: number, w: number): Vector4;
  83163. /**
  83164. * Copies the given float to the current Vector3 coordinates
  83165. * @param v defines the x, y, z and w coordinates of the operand
  83166. * @returns the current updated Vector3
  83167. */
  83168. setAll(v: number): Vector4;
  83169. /**
  83170. * Returns a new Vector4 set from the starting index of the given array.
  83171. * @param array the array to pull values from
  83172. * @param offset the offset into the array to start at
  83173. * @returns the new vector
  83174. */
  83175. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  83176. /**
  83177. * Updates the given vector "result" from the starting index of the given array.
  83178. * @param array the array to pull values from
  83179. * @param offset the offset into the array to start at
  83180. * @param result the vector to store the result in
  83181. */
  83182. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  83183. /**
  83184. * Updates the given vector "result" from the starting index of the given Float32Array.
  83185. * @param array the array to pull values from
  83186. * @param offset the offset into the array to start at
  83187. * @param result the vector to store the result in
  83188. */
  83189. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  83190. /**
  83191. * Updates the given vector "result" coordinates from the given floats.
  83192. * @param x float to set from
  83193. * @param y float to set from
  83194. * @param z float to set from
  83195. * @param w float to set from
  83196. * @param result the vector to the floats in
  83197. */
  83198. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  83199. /**
  83200. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  83201. * @returns the new vector
  83202. */
  83203. static Zero(): Vector4;
  83204. /**
  83205. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  83206. * @returns the new vector
  83207. */
  83208. static One(): Vector4;
  83209. /**
  83210. * Returns a new normalized Vector4 from the given one.
  83211. * @param vector the vector to normalize
  83212. * @returns the vector
  83213. */
  83214. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  83215. /**
  83216. * Updates the given vector "result" from the normalization of the given one.
  83217. * @param vector the vector to normalize
  83218. * @param result the vector to store the result in
  83219. */
  83220. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  83221. /**
  83222. * Returns a vector with the minimum values from the left and right vectors
  83223. * @param left left vector to minimize
  83224. * @param right right vector to minimize
  83225. * @returns a new vector with the minimum of the left and right vector values
  83226. */
  83227. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83228. /**
  83229. * Returns a vector with the maximum values from the left and right vectors
  83230. * @param left left vector to maximize
  83231. * @param right right vector to maximize
  83232. * @returns a new vector with the maximum of the left and right vector values
  83233. */
  83234. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83235. /**
  83236. * Returns the distance (float) between the vectors "value1" and "value2".
  83237. * @param value1 value to calulate the distance between
  83238. * @param value2 value to calulate the distance between
  83239. * @return the distance between the two vectors
  83240. */
  83241. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83242. /**
  83243. * Returns the squared distance (float) between the vectors "value1" and "value2".
  83244. * @param value1 value to calulate the distance between
  83245. * @param value2 value to calulate the distance between
  83246. * @return the distance between the two vectors squared
  83247. */
  83248. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83249. /**
  83250. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  83251. * @param value1 value to calulate the center between
  83252. * @param value2 value to calulate the center between
  83253. * @return the center between the two vectors
  83254. */
  83255. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  83256. /**
  83257. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  83258. * This methods computes transformed normalized direction vectors only.
  83259. * @param vector the vector to transform
  83260. * @param transformation the transformation matrix to apply
  83261. * @returns the new vector
  83262. */
  83263. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  83264. /**
  83265. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  83266. * This methods computes transformed normalized direction vectors only.
  83267. * @param vector the vector to transform
  83268. * @param transformation the transformation matrix to apply
  83269. * @param result the vector to store the result in
  83270. */
  83271. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83272. /**
  83273. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  83274. * This methods computes transformed normalized direction vectors only.
  83275. * @param x value to transform
  83276. * @param y value to transform
  83277. * @param z value to transform
  83278. * @param w value to transform
  83279. * @param transformation the transformation matrix to apply
  83280. * @param result the vector to store the results in
  83281. */
  83282. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83283. /**
  83284. * Creates a new Vector4 from a Vector3
  83285. * @param source defines the source data
  83286. * @param w defines the 4th component (default is 0)
  83287. * @returns a new Vector4
  83288. */
  83289. static FromVector3(source: Vector3, w?: number): Vector4;
  83290. }
  83291. /**
  83292. * Class used to store quaternion data
  83293. * @see https://en.wikipedia.org/wiki/Quaternion
  83294. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  83295. */
  83296. export class Quaternion {
  83297. /** @hidden */
  83298. _x: number;
  83299. /** @hidden */
  83300. _y: number;
  83301. /** @hidden */
  83302. _z: number;
  83303. /** @hidden */
  83304. _w: number;
  83305. /** @hidden */
  83306. _isDirty: boolean;
  83307. /** Gets or sets the x coordinate */
  83308. get x(): number;
  83309. set x(value: number);
  83310. /** Gets or sets the y coordinate */
  83311. get y(): number;
  83312. set y(value: number);
  83313. /** Gets or sets the z coordinate */
  83314. get z(): number;
  83315. set z(value: number);
  83316. /** Gets or sets the w coordinate */
  83317. get w(): number;
  83318. set w(value: number);
  83319. /**
  83320. * Creates a new Quaternion from the given floats
  83321. * @param x defines the first component (0 by default)
  83322. * @param y defines the second component (0 by default)
  83323. * @param z defines the third component (0 by default)
  83324. * @param w defines the fourth component (1.0 by default)
  83325. */
  83326. constructor(x?: number, y?: number, z?: number, w?: number);
  83327. /**
  83328. * Gets a string representation for the current quaternion
  83329. * @returns a string with the Quaternion coordinates
  83330. */
  83331. toString(): string;
  83332. /**
  83333. * Gets the class name of the quaternion
  83334. * @returns the string "Quaternion"
  83335. */
  83336. getClassName(): string;
  83337. /**
  83338. * Gets a hash code for this quaternion
  83339. * @returns the quaternion hash code
  83340. */
  83341. getHashCode(): number;
  83342. /**
  83343. * Copy the quaternion to an array
  83344. * @returns a new array populated with 4 elements from the quaternion coordinates
  83345. */
  83346. asArray(): number[];
  83347. /**
  83348. * Check if two quaternions are equals
  83349. * @param otherQuaternion defines the second operand
  83350. * @return true if the current quaternion and the given one coordinates are strictly equals
  83351. */
  83352. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  83353. /**
  83354. * Gets a boolean if two quaternions are equals (using an epsilon value)
  83355. * @param otherQuaternion defines the other quaternion
  83356. * @param epsilon defines the minimal distance to consider equality
  83357. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  83358. */
  83359. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  83360. /**
  83361. * Clone the current quaternion
  83362. * @returns a new quaternion copied from the current one
  83363. */
  83364. clone(): Quaternion;
  83365. /**
  83366. * Copy a quaternion to the current one
  83367. * @param other defines the other quaternion
  83368. * @returns the updated current quaternion
  83369. */
  83370. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  83371. /**
  83372. * Updates the current quaternion with the given float coordinates
  83373. * @param x defines the x coordinate
  83374. * @param y defines the y coordinate
  83375. * @param z defines the z coordinate
  83376. * @param w defines the w coordinate
  83377. * @returns the updated current quaternion
  83378. */
  83379. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  83380. /**
  83381. * Updates the current quaternion from 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. set(x: number, y: number, z: number, w: number): Quaternion;
  83389. /**
  83390. * Adds two quaternions
  83391. * @param other defines the second operand
  83392. * @returns a new quaternion as the addition result of the given one and the current quaternion
  83393. */
  83394. add(other: DeepImmutable<Quaternion>): Quaternion;
  83395. /**
  83396. * Add a quaternion to the current one
  83397. * @param other defines the quaternion to add
  83398. * @returns the current quaternion
  83399. */
  83400. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  83401. /**
  83402. * Subtract two quaternions
  83403. * @param other defines the second operand
  83404. * @returns a new quaternion as the subtraction result of the given one from the current one
  83405. */
  83406. subtract(other: Quaternion): Quaternion;
  83407. /**
  83408. * Multiplies the current quaternion by a scale factor
  83409. * @param value defines the scale factor
  83410. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  83411. */
  83412. scale(value: number): Quaternion;
  83413. /**
  83414. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  83415. * @param scale defines the scale factor
  83416. * @param result defines the Quaternion object where to store the result
  83417. * @returns the unmodified current quaternion
  83418. */
  83419. scaleToRef(scale: number, result: Quaternion): Quaternion;
  83420. /**
  83421. * Multiplies in place the current quaternion by a scale factor
  83422. * @param value defines the scale factor
  83423. * @returns the current modified quaternion
  83424. */
  83425. scaleInPlace(value: number): Quaternion;
  83426. /**
  83427. * Scale the current quaternion values by a factor and add the result to a given quaternion
  83428. * @param scale defines the scale factor
  83429. * @param result defines the Quaternion object where to store the result
  83430. * @returns the unmodified current quaternion
  83431. */
  83432. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  83433. /**
  83434. * Multiplies two quaternions
  83435. * @param q1 defines the second operand
  83436. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  83437. */
  83438. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  83439. /**
  83440. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  83441. * @param q1 defines the second operand
  83442. * @param result defines the target quaternion
  83443. * @returns the current quaternion
  83444. */
  83445. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  83446. /**
  83447. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  83448. * @param q1 defines the second operand
  83449. * @returns the currentupdated quaternion
  83450. */
  83451. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  83452. /**
  83453. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  83454. * @param ref defines the target quaternion
  83455. * @returns the current quaternion
  83456. */
  83457. conjugateToRef(ref: Quaternion): Quaternion;
  83458. /**
  83459. * Conjugates in place (1-q) the current quaternion
  83460. * @returns the current updated quaternion
  83461. */
  83462. conjugateInPlace(): Quaternion;
  83463. /**
  83464. * Conjugates in place (1-q) the current quaternion
  83465. * @returns a new quaternion
  83466. */
  83467. conjugate(): Quaternion;
  83468. /**
  83469. * Gets length of current quaternion
  83470. * @returns the quaternion length (float)
  83471. */
  83472. length(): number;
  83473. /**
  83474. * Normalize in place the current quaternion
  83475. * @returns the current updated quaternion
  83476. */
  83477. normalize(): Quaternion;
  83478. /**
  83479. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  83480. * @param order is a reserved parameter and is ignore for now
  83481. * @returns a new Vector3 containing the Euler angles
  83482. */
  83483. toEulerAngles(order?: string): Vector3;
  83484. /**
  83485. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  83486. * @param result defines the vector which will be filled with the Euler angles
  83487. * @param order is a reserved parameter and is ignore for now
  83488. * @returns the current unchanged quaternion
  83489. */
  83490. toEulerAnglesToRef(result: Vector3): Quaternion;
  83491. /**
  83492. * Updates the given rotation matrix with the current quaternion values
  83493. * @param result defines the target matrix
  83494. * @returns the current unchanged quaternion
  83495. */
  83496. toRotationMatrix(result: Matrix): Quaternion;
  83497. /**
  83498. * Updates the current quaternion from the given rotation matrix values
  83499. * @param matrix defines the source matrix
  83500. * @returns the current updated quaternion
  83501. */
  83502. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83503. /**
  83504. * Creates a new quaternion from a rotation matrix
  83505. * @param matrix defines the source matrix
  83506. * @returns a new quaternion created from the given rotation matrix values
  83507. */
  83508. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83509. /**
  83510. * Updates the given quaternion with the given rotation matrix values
  83511. * @param matrix defines the source matrix
  83512. * @param result defines the target quaternion
  83513. */
  83514. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  83515. /**
  83516. * Returns the dot product (float) between the quaternions "left" and "right"
  83517. * @param left defines the left operand
  83518. * @param right defines the right operand
  83519. * @returns the dot product
  83520. */
  83521. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  83522. /**
  83523. * Checks if the two quaternions are close to each other
  83524. * @param quat0 defines the first quaternion to check
  83525. * @param quat1 defines the second quaternion to check
  83526. * @returns true if the two quaternions are close to each other
  83527. */
  83528. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  83529. /**
  83530. * Creates an empty quaternion
  83531. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  83532. */
  83533. static Zero(): Quaternion;
  83534. /**
  83535. * Inverse a given quaternion
  83536. * @param q defines the source quaternion
  83537. * @returns a new quaternion as the inverted current quaternion
  83538. */
  83539. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  83540. /**
  83541. * Inverse a given quaternion
  83542. * @param q defines the source quaternion
  83543. * @param result the quaternion the result will be stored in
  83544. * @returns the result quaternion
  83545. */
  83546. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  83547. /**
  83548. * Creates an identity quaternion
  83549. * @returns the identity quaternion
  83550. */
  83551. static Identity(): Quaternion;
  83552. /**
  83553. * Gets a boolean indicating if the given quaternion is identity
  83554. * @param quaternion defines the quaternion to check
  83555. * @returns true if the quaternion is identity
  83556. */
  83557. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  83558. /**
  83559. * Creates a quaternion from a rotation around an axis
  83560. * @param axis defines the axis to use
  83561. * @param angle defines the angle to use
  83562. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  83563. */
  83564. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  83565. /**
  83566. * Creates a rotation around an axis and stores it into the given quaternion
  83567. * @param axis defines the axis to use
  83568. * @param angle defines the angle to use
  83569. * @param result defines the target quaternion
  83570. * @returns the target quaternion
  83571. */
  83572. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  83573. /**
  83574. * Creates a new quaternion from data stored into an array
  83575. * @param array defines the data source
  83576. * @param offset defines the offset in the source array where the data starts
  83577. * @returns a new quaternion
  83578. */
  83579. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  83580. /**
  83581. * Updates the given quaternion "result" from the starting index of the given array.
  83582. * @param array the array to pull values from
  83583. * @param offset the offset into the array to start at
  83584. * @param result the quaternion to store the result in
  83585. */
  83586. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  83587. /**
  83588. * Create a quaternion from Euler rotation angles
  83589. * @param x Pitch
  83590. * @param y Yaw
  83591. * @param z Roll
  83592. * @returns the new Quaternion
  83593. */
  83594. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  83595. /**
  83596. * Updates a quaternion from Euler rotation angles
  83597. * @param x Pitch
  83598. * @param y Yaw
  83599. * @param z Roll
  83600. * @param result the quaternion to store the result
  83601. * @returns the updated quaternion
  83602. */
  83603. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  83604. /**
  83605. * Create a quaternion from Euler rotation vector
  83606. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83607. * @returns the new Quaternion
  83608. */
  83609. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  83610. /**
  83611. * Updates a quaternion from Euler rotation vector
  83612. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83613. * @param result the quaternion to store the result
  83614. * @returns the updated quaternion
  83615. */
  83616. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  83617. /**
  83618. * Creates a new quaternion from the given Euler float angles (y, x, z)
  83619. * @param yaw defines the rotation around Y axis
  83620. * @param pitch defines the rotation around X axis
  83621. * @param roll defines the rotation around Z axis
  83622. * @returns the new quaternion
  83623. */
  83624. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  83625. /**
  83626. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  83627. * @param yaw defines the rotation around Y axis
  83628. * @param pitch defines the rotation around X axis
  83629. * @param roll defines the rotation around Z axis
  83630. * @param result defines the target quaternion
  83631. */
  83632. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  83633. /**
  83634. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  83635. * @param alpha defines the rotation around first axis
  83636. * @param beta defines the rotation around second axis
  83637. * @param gamma defines the rotation around third axis
  83638. * @returns the new quaternion
  83639. */
  83640. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  83641. /**
  83642. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  83643. * @param alpha defines the rotation around first axis
  83644. * @param beta defines the rotation around second axis
  83645. * @param gamma defines the rotation around third axis
  83646. * @param result defines the target quaternion
  83647. */
  83648. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  83649. /**
  83650. * 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)
  83651. * @param axis1 defines the first axis
  83652. * @param axis2 defines the second axis
  83653. * @param axis3 defines the third axis
  83654. * @returns the new quaternion
  83655. */
  83656. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  83657. /**
  83658. * 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
  83659. * @param axis1 defines the first axis
  83660. * @param axis2 defines the second axis
  83661. * @param axis3 defines the third axis
  83662. * @param ref defines the target quaternion
  83663. */
  83664. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  83665. /**
  83666. * Interpolates between two quaternions
  83667. * @param left defines first quaternion
  83668. * @param right defines second quaternion
  83669. * @param amount defines the gradient to use
  83670. * @returns the new interpolated quaternion
  83671. */
  83672. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83673. /**
  83674. * Interpolates between two quaternions and stores it into a target quaternion
  83675. * @param left defines first quaternion
  83676. * @param right defines second quaternion
  83677. * @param amount defines the gradient to use
  83678. * @param result defines the target quaternion
  83679. */
  83680. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  83681. /**
  83682. * Interpolate between two quaternions using Hermite interpolation
  83683. * @param value1 defines first quaternion
  83684. * @param tangent1 defines the incoming tangent
  83685. * @param value2 defines second quaternion
  83686. * @param tangent2 defines the outgoing tangent
  83687. * @param amount defines the target quaternion
  83688. * @returns the new interpolated quaternion
  83689. */
  83690. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83691. }
  83692. /**
  83693. * Class used to store matrix data (4x4)
  83694. */
  83695. export class Matrix {
  83696. /**
  83697. * Gets the precision of matrix computations
  83698. */
  83699. static get Use64Bits(): boolean;
  83700. private static _updateFlagSeed;
  83701. private static _identityReadOnly;
  83702. private _isIdentity;
  83703. private _isIdentityDirty;
  83704. private _isIdentity3x2;
  83705. private _isIdentity3x2Dirty;
  83706. /**
  83707. * Gets the update flag of the matrix which is an unique number for the matrix.
  83708. * It will be incremented every time the matrix data change.
  83709. * You can use it to speed the comparison between two versions of the same matrix.
  83710. */
  83711. updateFlag: number;
  83712. private readonly _m;
  83713. /**
  83714. * Gets the internal data of the matrix
  83715. */
  83716. get m(): DeepImmutable<Float32Array | Array<number>>;
  83717. /** @hidden */
  83718. _markAsUpdated(): void;
  83719. /** @hidden */
  83720. private _updateIdentityStatus;
  83721. /**
  83722. * Creates an empty matrix (filled with zeros)
  83723. */
  83724. constructor();
  83725. /**
  83726. * Check if the current matrix is identity
  83727. * @returns true is the matrix is the identity matrix
  83728. */
  83729. isIdentity(): boolean;
  83730. /**
  83731. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  83732. * @returns true is the matrix is the identity matrix
  83733. */
  83734. isIdentityAs3x2(): boolean;
  83735. /**
  83736. * Gets the determinant of the matrix
  83737. * @returns the matrix determinant
  83738. */
  83739. determinant(): number;
  83740. /**
  83741. * Returns the matrix as a Float32Array or Array<number>
  83742. * @returns the matrix underlying array
  83743. */
  83744. toArray(): DeepImmutable<Float32Array | Array<number>>;
  83745. /**
  83746. * Returns the matrix as a Float32Array or Array<number>
  83747. * @returns the matrix underlying array.
  83748. */
  83749. asArray(): DeepImmutable<Float32Array | Array<number>>;
  83750. /**
  83751. * Inverts the current matrix in place
  83752. * @returns the current inverted matrix
  83753. */
  83754. invert(): Matrix;
  83755. /**
  83756. * Sets all the matrix elements to zero
  83757. * @returns the current matrix
  83758. */
  83759. reset(): Matrix;
  83760. /**
  83761. * Adds the current matrix with a second one
  83762. * @param other defines the matrix to add
  83763. * @returns a new matrix as the addition of the current matrix and the given one
  83764. */
  83765. add(other: DeepImmutable<Matrix>): Matrix;
  83766. /**
  83767. * Sets the given matrix "result" to the addition of the current matrix and the given one
  83768. * @param other defines the matrix to add
  83769. * @param result defines the target matrix
  83770. * @returns the current matrix
  83771. */
  83772. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83773. /**
  83774. * Adds in place the given matrix to the current matrix
  83775. * @param other defines the second operand
  83776. * @returns the current updated matrix
  83777. */
  83778. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  83779. /**
  83780. * Sets the given matrix to the current inverted Matrix
  83781. * @param other defines the target matrix
  83782. * @returns the unmodified current matrix
  83783. */
  83784. invertToRef(other: Matrix): Matrix;
  83785. /**
  83786. * add a value at the specified position in the current Matrix
  83787. * @param index the index of the value within the matrix. between 0 and 15.
  83788. * @param value the value to be added
  83789. * @returns the current updated matrix
  83790. */
  83791. addAtIndex(index: number, value: number): Matrix;
  83792. /**
  83793. * mutiply the specified position in the current Matrix by a value
  83794. * @param index the index of the value within the matrix. between 0 and 15.
  83795. * @param value the value to be added
  83796. * @returns the current updated matrix
  83797. */
  83798. multiplyAtIndex(index: number, value: number): Matrix;
  83799. /**
  83800. * Inserts the translation vector (using 3 floats) in the current matrix
  83801. * @param x defines the 1st component of the translation
  83802. * @param y defines the 2nd component of the translation
  83803. * @param z defines the 3rd component of the translation
  83804. * @returns the current updated matrix
  83805. */
  83806. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83807. /**
  83808. * Adds the translation vector (using 3 floats) in the current matrix
  83809. * @param x defines the 1st component of the translation
  83810. * @param y defines the 2nd component of the translation
  83811. * @param z defines the 3rd component of the translation
  83812. * @returns the current updated matrix
  83813. */
  83814. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83815. /**
  83816. * Inserts the translation vector in the current matrix
  83817. * @param vector3 defines the translation to insert
  83818. * @returns the current updated matrix
  83819. */
  83820. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  83821. /**
  83822. * Gets the translation value of the current matrix
  83823. * @returns a new Vector3 as the extracted translation from the matrix
  83824. */
  83825. getTranslation(): Vector3;
  83826. /**
  83827. * Fill a Vector3 with the extracted translation from the matrix
  83828. * @param result defines the Vector3 where to store the translation
  83829. * @returns the current matrix
  83830. */
  83831. getTranslationToRef(result: Vector3): Matrix;
  83832. /**
  83833. * Remove rotation and scaling part from the matrix
  83834. * @returns the updated matrix
  83835. */
  83836. removeRotationAndScaling(): Matrix;
  83837. /**
  83838. * Multiply two matrices
  83839. * @param other defines the second operand
  83840. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  83841. */
  83842. multiply(other: DeepImmutable<Matrix>): Matrix;
  83843. /**
  83844. * Copy the current matrix from the given one
  83845. * @param other defines the source matrix
  83846. * @returns the current updated matrix
  83847. */
  83848. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  83849. /**
  83850. * Populates the given array from the starting index with the current matrix values
  83851. * @param array defines the target array
  83852. * @param offset defines the offset in the target array where to start storing values
  83853. * @returns the current matrix
  83854. */
  83855. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  83856. /**
  83857. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  83858. * @param other defines the second operand
  83859. * @param result defines the matrix where to store the multiplication
  83860. * @returns the current matrix
  83861. */
  83862. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83863. /**
  83864. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  83865. * @param other defines the second operand
  83866. * @param result defines the array where to store the multiplication
  83867. * @param offset defines the offset in the target array where to start storing values
  83868. * @returns the current matrix
  83869. */
  83870. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  83871. /**
  83872. * Check equality between this matrix and a second one
  83873. * @param value defines the second matrix to compare
  83874. * @returns true is the current matrix and the given one values are strictly equal
  83875. */
  83876. equals(value: DeepImmutable<Matrix>): boolean;
  83877. /**
  83878. * Clone the current matrix
  83879. * @returns a new matrix from the current matrix
  83880. */
  83881. clone(): Matrix;
  83882. /**
  83883. * Returns the name of the current matrix class
  83884. * @returns the string "Matrix"
  83885. */
  83886. getClassName(): string;
  83887. /**
  83888. * Gets the hash code of the current matrix
  83889. * @returns the hash code
  83890. */
  83891. getHashCode(): number;
  83892. /**
  83893. * Decomposes the current Matrix into a translation, rotation and scaling components
  83894. * @param scale defines the scale vector3 given as a reference to update
  83895. * @param rotation defines the rotation quaternion given as a reference to update
  83896. * @param translation defines the translation vector3 given as a reference to update
  83897. * @returns true if operation was successful
  83898. */
  83899. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  83900. /**
  83901. * Gets specific row of the matrix
  83902. * @param index defines the number of the row to get
  83903. * @returns the index-th row of the current matrix as a new Vector4
  83904. */
  83905. getRow(index: number): Nullable<Vector4>;
  83906. /**
  83907. * Sets the index-th row of the current matrix to the vector4 values
  83908. * @param index defines the number of the row to set
  83909. * @param row defines the target vector4
  83910. * @returns the updated current matrix
  83911. */
  83912. setRow(index: number, row: Vector4): Matrix;
  83913. /**
  83914. * Compute the transpose of the matrix
  83915. * @returns the new transposed matrix
  83916. */
  83917. transpose(): Matrix;
  83918. /**
  83919. * Compute the transpose of the matrix and store it in a given matrix
  83920. * @param result defines the target matrix
  83921. * @returns the current matrix
  83922. */
  83923. transposeToRef(result: Matrix): Matrix;
  83924. /**
  83925. * Sets the index-th row of the current matrix with the given 4 x float values
  83926. * @param index defines the row index
  83927. * @param x defines the x component to set
  83928. * @param y defines the y component to set
  83929. * @param z defines the z component to set
  83930. * @param w defines the w component to set
  83931. * @returns the updated current matrix
  83932. */
  83933. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  83934. /**
  83935. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  83936. * @param scale defines the scale factor
  83937. * @returns a new matrix
  83938. */
  83939. scale(scale: number): Matrix;
  83940. /**
  83941. * Scale the current matrix values by a factor to a given result matrix
  83942. * @param scale defines the scale factor
  83943. * @param result defines the matrix to store the result
  83944. * @returns the current matrix
  83945. */
  83946. scaleToRef(scale: number, result: Matrix): Matrix;
  83947. /**
  83948. * Scale the current matrix values by a factor and add the result to a given matrix
  83949. * @param scale defines the scale factor
  83950. * @param result defines the Matrix to store the result
  83951. * @returns the current matrix
  83952. */
  83953. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  83954. /**
  83955. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  83956. * @param ref matrix to store the result
  83957. */
  83958. toNormalMatrix(ref: Matrix): void;
  83959. /**
  83960. * Gets only rotation part of the current matrix
  83961. * @returns a new matrix sets to the extracted rotation matrix from the current one
  83962. */
  83963. getRotationMatrix(): Matrix;
  83964. /**
  83965. * Extracts the rotation matrix from the current one and sets it as the given "result"
  83966. * @param result defines the target matrix to store data to
  83967. * @returns the current matrix
  83968. */
  83969. getRotationMatrixToRef(result: Matrix): Matrix;
  83970. /**
  83971. * Toggles model matrix from being right handed to left handed in place and vice versa
  83972. */
  83973. toggleModelMatrixHandInPlace(): void;
  83974. /**
  83975. * Toggles projection matrix from being right handed to left handed in place and vice versa
  83976. */
  83977. toggleProjectionMatrixHandInPlace(): void;
  83978. /**
  83979. * Creates a matrix from an array
  83980. * @param array defines the source array
  83981. * @param offset defines an offset in the source array
  83982. * @returns a new Matrix set from the starting index of the given array
  83983. */
  83984. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  83985. /**
  83986. * Copy the content of an array into a given matrix
  83987. * @param array defines the source array
  83988. * @param offset defines an offset in the source array
  83989. * @param result defines the target matrix
  83990. */
  83991. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  83992. /**
  83993. * Stores an array into a matrix after having multiplied each component by a given factor
  83994. * @param array defines the source array
  83995. * @param offset defines the offset in the source array
  83996. * @param scale defines the scaling factor
  83997. * @param result defines the target matrix
  83998. */
  83999. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  84000. /**
  84001. * Gets an identity matrix that must not be updated
  84002. */
  84003. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  84004. /**
  84005. * Stores a list of values (16) inside a given matrix
  84006. * @param initialM11 defines 1st value of 1st row
  84007. * @param initialM12 defines 2nd value of 1st row
  84008. * @param initialM13 defines 3rd value of 1st row
  84009. * @param initialM14 defines 4th value of 1st row
  84010. * @param initialM21 defines 1st value of 2nd row
  84011. * @param initialM22 defines 2nd value of 2nd row
  84012. * @param initialM23 defines 3rd value of 2nd row
  84013. * @param initialM24 defines 4th value of 2nd row
  84014. * @param initialM31 defines 1st value of 3rd row
  84015. * @param initialM32 defines 2nd value of 3rd row
  84016. * @param initialM33 defines 3rd value of 3rd row
  84017. * @param initialM34 defines 4th value of 3rd row
  84018. * @param initialM41 defines 1st value of 4th row
  84019. * @param initialM42 defines 2nd value of 4th row
  84020. * @param initialM43 defines 3rd value of 4th row
  84021. * @param initialM44 defines 4th value of 4th row
  84022. * @param result defines the target matrix
  84023. */
  84024. 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;
  84025. /**
  84026. * Creates new matrix from a list of values (16)
  84027. * @param initialM11 defines 1st value of 1st row
  84028. * @param initialM12 defines 2nd value of 1st row
  84029. * @param initialM13 defines 3rd value of 1st row
  84030. * @param initialM14 defines 4th value of 1st row
  84031. * @param initialM21 defines 1st value of 2nd row
  84032. * @param initialM22 defines 2nd value of 2nd row
  84033. * @param initialM23 defines 3rd value of 2nd row
  84034. * @param initialM24 defines 4th value of 2nd row
  84035. * @param initialM31 defines 1st value of 3rd row
  84036. * @param initialM32 defines 2nd value of 3rd row
  84037. * @param initialM33 defines 3rd value of 3rd row
  84038. * @param initialM34 defines 4th value of 3rd row
  84039. * @param initialM41 defines 1st value of 4th row
  84040. * @param initialM42 defines 2nd value of 4th row
  84041. * @param initialM43 defines 3rd value of 4th row
  84042. * @param initialM44 defines 4th value of 4th row
  84043. * @returns the new matrix
  84044. */
  84045. 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;
  84046. /**
  84047. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84048. * @param scale defines the scale vector3
  84049. * @param rotation defines the rotation quaternion
  84050. * @param translation defines the translation vector3
  84051. * @returns a new matrix
  84052. */
  84053. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  84054. /**
  84055. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84056. * @param scale defines the scale vector3
  84057. * @param rotation defines the rotation quaternion
  84058. * @param translation defines the translation vector3
  84059. * @param result defines the target matrix
  84060. */
  84061. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  84062. /**
  84063. * Creates a new identity matrix
  84064. * @returns a new identity matrix
  84065. */
  84066. static Identity(): Matrix;
  84067. /**
  84068. * Creates a new identity matrix and stores the result in a given matrix
  84069. * @param result defines the target matrix
  84070. */
  84071. static IdentityToRef(result: Matrix): void;
  84072. /**
  84073. * Creates a new zero matrix
  84074. * @returns a new zero matrix
  84075. */
  84076. static Zero(): Matrix;
  84077. /**
  84078. * Creates a new rotation matrix for "angle" radians around the X axis
  84079. * @param angle defines the angle (in radians) to use
  84080. * @return the new matrix
  84081. */
  84082. static RotationX(angle: number): Matrix;
  84083. /**
  84084. * Creates a new matrix as the invert of a given matrix
  84085. * @param source defines the source matrix
  84086. * @returns the new matrix
  84087. */
  84088. static Invert(source: DeepImmutable<Matrix>): Matrix;
  84089. /**
  84090. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  84091. * @param angle defines the angle (in radians) to use
  84092. * @param result defines the target matrix
  84093. */
  84094. static RotationXToRef(angle: number, result: Matrix): void;
  84095. /**
  84096. * Creates a new rotation matrix for "angle" radians around the Y axis
  84097. * @param angle defines the angle (in radians) to use
  84098. * @return the new matrix
  84099. */
  84100. static RotationY(angle: number): Matrix;
  84101. /**
  84102. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  84103. * @param angle defines the angle (in radians) to use
  84104. * @param result defines the target matrix
  84105. */
  84106. static RotationYToRef(angle: number, result: Matrix): void;
  84107. /**
  84108. * Creates a new rotation matrix for "angle" radians around the Z axis
  84109. * @param angle defines the angle (in radians) to use
  84110. * @return the new matrix
  84111. */
  84112. static RotationZ(angle: number): Matrix;
  84113. /**
  84114. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  84115. * @param angle defines the angle (in radians) to use
  84116. * @param result defines the target matrix
  84117. */
  84118. static RotationZToRef(angle: number, result: Matrix): void;
  84119. /**
  84120. * Creates a new rotation matrix for "angle" radians around the given axis
  84121. * @param axis defines the axis to use
  84122. * @param angle defines the angle (in radians) to use
  84123. * @return the new matrix
  84124. */
  84125. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  84126. /**
  84127. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  84128. * @param axis defines the axis to use
  84129. * @param angle defines the angle (in radians) to use
  84130. * @param result defines the target matrix
  84131. */
  84132. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  84133. /**
  84134. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  84135. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  84136. * @param from defines the vector to align
  84137. * @param to defines the vector to align to
  84138. * @param result defines the target matrix
  84139. */
  84140. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  84141. /**
  84142. * Creates a rotation matrix
  84143. * @param yaw defines the yaw angle in radians (Y axis)
  84144. * @param pitch defines the pitch angle in radians (X axis)
  84145. * @param roll defines the roll angle in radians (Z axis)
  84146. * @returns the new rotation matrix
  84147. */
  84148. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  84149. /**
  84150. * Creates a rotation matrix and stores it in a given matrix
  84151. * @param yaw defines the yaw angle in radians (Y axis)
  84152. * @param pitch defines the pitch angle in radians (X axis)
  84153. * @param roll defines the roll angle in radians (Z axis)
  84154. * @param result defines the target matrix
  84155. */
  84156. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  84157. /**
  84158. * Creates a scaling matrix
  84159. * @param x defines the scale factor on X axis
  84160. * @param y defines the scale factor on Y axis
  84161. * @param z defines the scale factor on Z axis
  84162. * @returns the new matrix
  84163. */
  84164. static Scaling(x: number, y: number, z: number): Matrix;
  84165. /**
  84166. * Creates a scaling matrix and stores it in a given matrix
  84167. * @param x defines the scale factor on X axis
  84168. * @param y defines the scale factor on Y axis
  84169. * @param z defines the scale factor on Z axis
  84170. * @param result defines the target matrix
  84171. */
  84172. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  84173. /**
  84174. * Creates a translation matrix
  84175. * @param x defines the translation on X axis
  84176. * @param y defines the translation on Y axis
  84177. * @param z defines the translationon Z axis
  84178. * @returns the new matrix
  84179. */
  84180. static Translation(x: number, y: number, z: number): Matrix;
  84181. /**
  84182. * Creates a translation matrix and stores it in a given matrix
  84183. * @param x defines the translation on X axis
  84184. * @param y defines the translation on Y axis
  84185. * @param z defines the translationon Z axis
  84186. * @param result defines the target matrix
  84187. */
  84188. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  84189. /**
  84190. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84191. * @param startValue defines the start value
  84192. * @param endValue defines the end value
  84193. * @param gradient defines the gradient factor
  84194. * @returns the new matrix
  84195. */
  84196. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84197. /**
  84198. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84199. * @param startValue defines the start value
  84200. * @param endValue defines the end value
  84201. * @param gradient defines the gradient factor
  84202. * @param result defines the Matrix object where to store data
  84203. */
  84204. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84205. /**
  84206. * Builds a new matrix whose values are computed by:
  84207. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84208. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84209. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84210. * @param startValue defines the first matrix
  84211. * @param endValue defines the second matrix
  84212. * @param gradient defines the gradient between the two matrices
  84213. * @returns the new matrix
  84214. */
  84215. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84216. /**
  84217. * Update a matrix to values which are computed by:
  84218. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84219. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84220. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84221. * @param startValue defines the first matrix
  84222. * @param endValue defines the second matrix
  84223. * @param gradient defines the gradient between the two matrices
  84224. * @param result defines the target matrix
  84225. */
  84226. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84227. /**
  84228. * 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"
  84229. * This function works in left handed mode
  84230. * @param eye defines the final position of the entity
  84231. * @param target defines where the entity should look at
  84232. * @param up defines the up vector for the entity
  84233. * @returns the new matrix
  84234. */
  84235. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84236. /**
  84237. * 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".
  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. * @param result defines the target matrix
  84243. */
  84244. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84245. /**
  84246. * 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"
  84247. * This function works in right 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. * @returns the new matrix
  84252. */
  84253. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84254. /**
  84255. * 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".
  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. * @param result defines the target matrix
  84261. */
  84262. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84263. /**
  84264. * Create a left-handed orthographic projection matrix
  84265. * @param width defines the viewport width
  84266. * @param height defines the viewport height
  84267. * @param znear defines the near clip plane
  84268. * @param zfar defines the far clip plane
  84269. * @returns a new matrix as a left-handed orthographic projection matrix
  84270. */
  84271. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84272. /**
  84273. * Store a left-handed orthographic projection to a given 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. * @param result defines the target matrix
  84279. */
  84280. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  84281. /**
  84282. * Create a left-handed orthographic projection matrix
  84283. * @param left defines the viewport left coordinate
  84284. * @param right defines the viewport right coordinate
  84285. * @param bottom defines the viewport bottom coordinate
  84286. * @param top defines the viewport top coordinate
  84287. * @param znear defines the near clip plane
  84288. * @param zfar defines the far clip plane
  84289. * @returns a new matrix as a left-handed orthographic projection matrix
  84290. */
  84291. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84292. /**
  84293. * Stores a left-handed orthographic projection into a given matrix
  84294. * @param left defines the viewport left coordinate
  84295. * @param right defines the viewport right coordinate
  84296. * @param bottom defines the viewport bottom coordinate
  84297. * @param top defines the viewport top coordinate
  84298. * @param znear defines the near clip plane
  84299. * @param zfar defines the far clip plane
  84300. * @param result defines the target matrix
  84301. */
  84302. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84303. /**
  84304. * Creates a right-handed orthographic projection matrix
  84305. * @param left defines the viewport left coordinate
  84306. * @param right defines the viewport right coordinate
  84307. * @param bottom defines the viewport bottom coordinate
  84308. * @param top defines the viewport top coordinate
  84309. * @param znear defines the near clip plane
  84310. * @param zfar defines the far clip plane
  84311. * @returns a new matrix as a right-handed orthographic projection matrix
  84312. */
  84313. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84314. /**
  84315. * Stores a right-handed orthographic projection into a given matrix
  84316. * @param left defines the viewport left coordinate
  84317. * @param right defines the viewport right coordinate
  84318. * @param bottom defines the viewport bottom coordinate
  84319. * @param top defines the viewport top coordinate
  84320. * @param znear defines the near clip plane
  84321. * @param zfar defines the far clip plane
  84322. * @param result defines the target matrix
  84323. */
  84324. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84325. /**
  84326. * Creates a left-handed perspective projection matrix
  84327. * @param width defines the viewport width
  84328. * @param height defines the viewport height
  84329. * @param znear defines the near clip plane
  84330. * @param zfar defines the far clip plane
  84331. * @returns a new matrix as a left-handed perspective projection matrix
  84332. */
  84333. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84334. /**
  84335. * Creates a left-handed perspective projection matrix
  84336. * @param fov defines the horizontal field of view
  84337. * @param aspect defines the aspect ratio
  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 PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84343. /**
  84344. * Stores a left-handed perspective projection into a given 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. * @param result defines the target matrix
  84350. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84351. */
  84352. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84353. /**
  84354. * Stores a left-handed perspective projection into a given matrix with depth reversed
  84355. * @param fov defines the horizontal field of view
  84356. * @param aspect defines the aspect ratio
  84357. * @param znear defines the near clip plane
  84358. * @param zfar not used as infinity is used as far clip
  84359. * @param result defines the target matrix
  84360. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84361. */
  84362. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84363. /**
  84364. * Creates a right-handed perspective projection matrix
  84365. * @param fov defines the horizontal field of view
  84366. * @param aspect defines the aspect ratio
  84367. * @param znear defines the near clip plane
  84368. * @param zfar defines the far clip plane
  84369. * @returns a new matrix as a right-handed perspective projection matrix
  84370. */
  84371. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84372. /**
  84373. * Stores a right-handed perspective projection into a given 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. * @param result defines the target matrix
  84379. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84380. */
  84381. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84382. /**
  84383. * Stores a right-handed perspective projection into a given matrix
  84384. * @param fov defines the horizontal field of view
  84385. * @param aspect defines the aspect ratio
  84386. * @param znear defines the near clip plane
  84387. * @param zfar not used as infinity is used as far clip
  84388. * @param result defines the target matrix
  84389. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84390. */
  84391. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84392. /**
  84393. * Stores a perspective projection for WebVR info a given matrix
  84394. * @param fov defines the field of view
  84395. * @param znear defines the near clip plane
  84396. * @param zfar defines the far clip plane
  84397. * @param result defines the target matrix
  84398. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  84399. */
  84400. static PerspectiveFovWebVRToRef(fov: {
  84401. upDegrees: number;
  84402. downDegrees: number;
  84403. leftDegrees: number;
  84404. rightDegrees: number;
  84405. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  84406. /**
  84407. * Computes a complete transformation matrix
  84408. * @param viewport defines the viewport to use
  84409. * @param world defines the world matrix
  84410. * @param view defines the view matrix
  84411. * @param projection defines the projection matrix
  84412. * @param zmin defines the near clip plane
  84413. * @param zmax defines the far clip plane
  84414. * @returns the transformation matrix
  84415. */
  84416. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  84417. /**
  84418. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  84419. * @param matrix defines the matrix to use
  84420. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  84421. */
  84422. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84423. /**
  84424. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  84425. * @param matrix defines the matrix to use
  84426. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  84427. */
  84428. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84429. /**
  84430. * Compute the transpose of a given matrix
  84431. * @param matrix defines the matrix to transpose
  84432. * @returns the new matrix
  84433. */
  84434. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  84435. /**
  84436. * Compute the transpose of a matrix and store it in a target matrix
  84437. * @param matrix defines the matrix to transpose
  84438. * @param result defines the target matrix
  84439. */
  84440. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  84441. /**
  84442. * Computes a reflection matrix from a plane
  84443. * @param plane defines the reflection plane
  84444. * @returns a new matrix
  84445. */
  84446. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  84447. /**
  84448. * Computes a reflection matrix from a plane
  84449. * @param plane defines the reflection plane
  84450. * @param result defines the target matrix
  84451. */
  84452. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  84453. /**
  84454. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  84455. * @param xaxis defines the value of the 1st axis
  84456. * @param yaxis defines the value of the 2nd axis
  84457. * @param zaxis defines the value of the 3rd axis
  84458. * @param result defines the target matrix
  84459. */
  84460. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  84461. /**
  84462. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  84463. * @param quat defines the quaternion to use
  84464. * @param result defines the target matrix
  84465. */
  84466. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  84467. }
  84468. /**
  84469. * @hidden
  84470. */
  84471. export class TmpVectors {
  84472. static Vector2: Vector2[];
  84473. static Vector3: Vector3[];
  84474. static Vector4: Vector4[];
  84475. static Quaternion: Quaternion[];
  84476. static Matrix: Matrix[];
  84477. }
  84478. }
  84479. declare module BABYLON {
  84480. /**
  84481. * Defines potential orientation for back face culling
  84482. */
  84483. export enum Orientation {
  84484. /**
  84485. * Clockwise
  84486. */
  84487. CW = 0,
  84488. /** Counter clockwise */
  84489. CCW = 1
  84490. }
  84491. /** Class used to represent a Bezier curve */
  84492. export class BezierCurve {
  84493. /**
  84494. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  84495. * @param t defines the time
  84496. * @param x1 defines the left coordinate on X axis
  84497. * @param y1 defines the left coordinate on Y axis
  84498. * @param x2 defines the right coordinate on X axis
  84499. * @param y2 defines the right coordinate on Y axis
  84500. * @returns the interpolated value
  84501. */
  84502. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  84503. }
  84504. /**
  84505. * Defines angle representation
  84506. */
  84507. export class Angle {
  84508. private _radians;
  84509. /**
  84510. * Creates an Angle object of "radians" radians (float).
  84511. * @param radians the angle in radians
  84512. */
  84513. constructor(radians: number);
  84514. /**
  84515. * Get value in degrees
  84516. * @returns the Angle value in degrees (float)
  84517. */
  84518. degrees(): number;
  84519. /**
  84520. * Get value in radians
  84521. * @returns the Angle value in radians (float)
  84522. */
  84523. radians(): number;
  84524. /**
  84525. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  84526. * @param a defines first point as the origin
  84527. * @param b defines point
  84528. * @returns a new Angle
  84529. */
  84530. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  84531. /**
  84532. * Gets a new Angle object from the given float in radians
  84533. * @param radians defines the angle value in radians
  84534. * @returns a new Angle
  84535. */
  84536. static FromRadians(radians: number): Angle;
  84537. /**
  84538. * Gets a new Angle object from the given float in degrees
  84539. * @param degrees defines the angle value in degrees
  84540. * @returns a new Angle
  84541. */
  84542. static FromDegrees(degrees: number): Angle;
  84543. }
  84544. /**
  84545. * This represents an arc in a 2d space.
  84546. */
  84547. export class Arc2 {
  84548. /** Defines the start point of the arc */
  84549. startPoint: Vector2;
  84550. /** Defines the mid point of the arc */
  84551. midPoint: Vector2;
  84552. /** Defines the end point of the arc */
  84553. endPoint: Vector2;
  84554. /**
  84555. * Defines the center point of the arc.
  84556. */
  84557. centerPoint: Vector2;
  84558. /**
  84559. * Defines the radius of the arc.
  84560. */
  84561. radius: number;
  84562. /**
  84563. * Defines the angle of the arc (from mid point to end point).
  84564. */
  84565. angle: Angle;
  84566. /**
  84567. * Defines the start angle of the arc (from start point to middle point).
  84568. */
  84569. startAngle: Angle;
  84570. /**
  84571. * Defines the orientation of the arc (clock wise/counter clock wise).
  84572. */
  84573. orientation: Orientation;
  84574. /**
  84575. * Creates an Arc object from the three given points : start, middle and end.
  84576. * @param startPoint Defines the start point of the arc
  84577. * @param midPoint Defines the midlle point of the arc
  84578. * @param endPoint Defines the end point of the arc
  84579. */
  84580. constructor(
  84581. /** Defines the start point of the arc */
  84582. startPoint: Vector2,
  84583. /** Defines the mid point of the arc */
  84584. midPoint: Vector2,
  84585. /** Defines the end point of the arc */
  84586. endPoint: Vector2);
  84587. }
  84588. /**
  84589. * Represents a 2D path made up of multiple 2D points
  84590. */
  84591. export class Path2 {
  84592. private _points;
  84593. private _length;
  84594. /**
  84595. * If the path start and end point are the same
  84596. */
  84597. closed: boolean;
  84598. /**
  84599. * Creates a Path2 object from the starting 2D coordinates x and y.
  84600. * @param x the starting points x value
  84601. * @param y the starting points y value
  84602. */
  84603. constructor(x: number, y: number);
  84604. /**
  84605. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  84606. * @param x the added points x value
  84607. * @param y the added points y value
  84608. * @returns the updated Path2.
  84609. */
  84610. addLineTo(x: number, y: number): Path2;
  84611. /**
  84612. * 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.
  84613. * @param midX middle point x value
  84614. * @param midY middle point y value
  84615. * @param endX end point x value
  84616. * @param endY end point y value
  84617. * @param numberOfSegments (default: 36)
  84618. * @returns the updated Path2.
  84619. */
  84620. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  84621. /**
  84622. * Closes the Path2.
  84623. * @returns the Path2.
  84624. */
  84625. close(): Path2;
  84626. /**
  84627. * Gets the sum of the distance between each sequential point in the path
  84628. * @returns the Path2 total length (float).
  84629. */
  84630. length(): number;
  84631. /**
  84632. * Gets the points which construct the path
  84633. * @returns the Path2 internal array of points.
  84634. */
  84635. getPoints(): Vector2[];
  84636. /**
  84637. * Retreives the point at the distance aways from the starting point
  84638. * @param normalizedLengthPosition the length along the path to retreive the point from
  84639. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  84640. */
  84641. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  84642. /**
  84643. * Creates a new path starting from an x and y position
  84644. * @param x starting x value
  84645. * @param y starting y value
  84646. * @returns a new Path2 starting at the coordinates (x, y).
  84647. */
  84648. static StartingAt(x: number, y: number): Path2;
  84649. }
  84650. /**
  84651. * Represents a 3D path made up of multiple 3D points
  84652. */
  84653. export class Path3D {
  84654. /**
  84655. * an array of Vector3, the curve axis of the Path3D
  84656. */
  84657. path: Vector3[];
  84658. private _curve;
  84659. private _distances;
  84660. private _tangents;
  84661. private _normals;
  84662. private _binormals;
  84663. private _raw;
  84664. private _alignTangentsWithPath;
  84665. private readonly _pointAtData;
  84666. /**
  84667. * new Path3D(path, normal, raw)
  84668. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  84669. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  84670. * @param path an array of Vector3, the curve axis of the Path3D
  84671. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  84672. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  84673. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  84674. */
  84675. constructor(
  84676. /**
  84677. * an array of Vector3, the curve axis of the Path3D
  84678. */
  84679. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  84680. /**
  84681. * Returns the Path3D array of successive Vector3 designing its curve.
  84682. * @returns the Path3D array of successive Vector3 designing its curve.
  84683. */
  84684. getCurve(): Vector3[];
  84685. /**
  84686. * Returns the Path3D array of successive Vector3 designing its curve.
  84687. * @returns the Path3D array of successive Vector3 designing its curve.
  84688. */
  84689. getPoints(): Vector3[];
  84690. /**
  84691. * @returns the computed length (float) of the path.
  84692. */
  84693. length(): number;
  84694. /**
  84695. * Returns an array populated with tangent vectors on each Path3D curve point.
  84696. * @returns an array populated with tangent vectors on each Path3D curve point.
  84697. */
  84698. getTangents(): Vector3[];
  84699. /**
  84700. * Returns an array populated with normal vectors on each Path3D curve point.
  84701. * @returns an array populated with normal vectors on each Path3D curve point.
  84702. */
  84703. getNormals(): Vector3[];
  84704. /**
  84705. * Returns an array populated with binormal vectors on each Path3D curve point.
  84706. * @returns an array populated with binormal vectors on each Path3D curve point.
  84707. */
  84708. getBinormals(): Vector3[];
  84709. /**
  84710. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  84711. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  84712. */
  84713. getDistances(): number[];
  84714. /**
  84715. * Returns an interpolated point along this path
  84716. * @param position the position of the point along this path, from 0.0 to 1.0
  84717. * @returns a new Vector3 as the point
  84718. */
  84719. getPointAt(position: number): Vector3;
  84720. /**
  84721. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84722. * @param position the position of the point along this path, from 0.0 to 1.0
  84723. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  84724. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  84725. */
  84726. getTangentAt(position: number, interpolated?: boolean): Vector3;
  84727. /**
  84728. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84729. * @param position the position of the point along this path, from 0.0 to 1.0
  84730. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  84731. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  84732. */
  84733. getNormalAt(position: number, interpolated?: boolean): Vector3;
  84734. /**
  84735. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  84736. * @param position the position of the point along this path, from 0.0 to 1.0
  84737. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  84738. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  84739. */
  84740. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  84741. /**
  84742. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  84743. * @param position the position of the point along this path, from 0.0 to 1.0
  84744. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  84745. */
  84746. getDistanceAt(position: number): number;
  84747. /**
  84748. * Returns the array index of the previous point of an interpolated point along this path
  84749. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84750. * @returns the array index
  84751. */
  84752. getPreviousPointIndexAt(position: number): number;
  84753. /**
  84754. * 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)
  84755. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84756. * @returns the sub position
  84757. */
  84758. getSubPositionAt(position: number): number;
  84759. /**
  84760. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  84761. * @param target the vector of which to get the closest position to
  84762. * @returns the position of the closest virtual point on this path to the target vector
  84763. */
  84764. getClosestPositionTo(target: Vector3): number;
  84765. /**
  84766. * Returns a sub path (slice) of this path
  84767. * @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
  84768. * @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
  84769. * @returns a sub path (slice) of this path
  84770. */
  84771. slice(start?: number, end?: number): Path3D;
  84772. /**
  84773. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  84774. * @param path path which all values are copied into the curves points
  84775. * @param firstNormal which should be projected onto the curve
  84776. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  84777. * @returns the same object updated.
  84778. */
  84779. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  84780. private _compute;
  84781. private _getFirstNonNullVector;
  84782. private _getLastNonNullVector;
  84783. private _normalVector;
  84784. /**
  84785. * Updates the point at data for an interpolated point along this curve
  84786. * @param position the position of the point along this curve, from 0.0 to 1.0
  84787. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  84788. * @returns the (updated) point at data
  84789. */
  84790. private _updatePointAtData;
  84791. /**
  84792. * Updates the point at data from the specified parameters
  84793. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  84794. * @param point the interpolated point
  84795. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  84796. */
  84797. private _setPointAtData;
  84798. /**
  84799. * Updates the point at interpolation matrix for the tangents, normals and binormals
  84800. */
  84801. private _updateInterpolationMatrix;
  84802. }
  84803. /**
  84804. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84805. * A Curve3 is designed from a series of successive Vector3.
  84806. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  84807. */
  84808. export class Curve3 {
  84809. private _points;
  84810. private _length;
  84811. /**
  84812. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  84813. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  84814. * @param v1 (Vector3) the control point
  84815. * @param v2 (Vector3) the end point of the Quadratic Bezier
  84816. * @param nbPoints (integer) the wanted number of points in the curve
  84817. * @returns the created Curve3
  84818. */
  84819. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84820. /**
  84821. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  84822. * @param v0 (Vector3) the origin point of the Cubic Bezier
  84823. * @param v1 (Vector3) the first control point
  84824. * @param v2 (Vector3) the second control point
  84825. * @param v3 (Vector3) the end point of the Cubic Bezier
  84826. * @param nbPoints (integer) the wanted number of points in the curve
  84827. * @returns the created Curve3
  84828. */
  84829. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84830. /**
  84831. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  84832. * @param p1 (Vector3) the origin point of the Hermite Spline
  84833. * @param t1 (Vector3) the tangent vector at the origin point
  84834. * @param p2 (Vector3) the end point of the Hermite Spline
  84835. * @param t2 (Vector3) the tangent vector at the end point
  84836. * @param nbPoints (integer) the wanted number of points in the curve
  84837. * @returns the created Curve3
  84838. */
  84839. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84840. /**
  84841. * Returns a Curve3 object along a CatmullRom Spline curve :
  84842. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  84843. * @param nbPoints (integer) the wanted number of points between each curve control points
  84844. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  84845. * @returns the created Curve3
  84846. */
  84847. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  84848. /**
  84849. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84850. * A Curve3 is designed from a series of successive Vector3.
  84851. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  84852. * @param points points which make up the curve
  84853. */
  84854. constructor(points: Vector3[]);
  84855. /**
  84856. * @returns the Curve3 stored array of successive Vector3
  84857. */
  84858. getPoints(): Vector3[];
  84859. /**
  84860. * @returns the computed length (float) of the curve.
  84861. */
  84862. length(): number;
  84863. /**
  84864. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  84865. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  84866. * curveA and curveB keep unchanged.
  84867. * @param curve the curve to continue from this curve
  84868. * @returns the newly constructed curve
  84869. */
  84870. continue(curve: DeepImmutable<Curve3>): Curve3;
  84871. private _computeLength;
  84872. }
  84873. }
  84874. declare module BABYLON {
  84875. /**
  84876. * This represents the main contract an easing function should follow.
  84877. * Easing functions are used throughout the animation system.
  84878. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84879. */
  84880. export interface IEasingFunction {
  84881. /**
  84882. * Given an input gradient between 0 and 1, this returns the corrseponding value
  84883. * of the easing function.
  84884. * The link below provides some of the most common examples of easing functions.
  84885. * @see https://easings.net/
  84886. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84887. * @returns the corresponding value on the curve defined by the easing function
  84888. */
  84889. ease(gradient: number): number;
  84890. }
  84891. /**
  84892. * Base class used for every default easing function.
  84893. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84894. */
  84895. export class EasingFunction implements IEasingFunction {
  84896. /**
  84897. * Interpolation follows the mathematical formula associated with the easing function.
  84898. */
  84899. static readonly EASINGMODE_EASEIN: number;
  84900. /**
  84901. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  84902. */
  84903. static readonly EASINGMODE_EASEOUT: number;
  84904. /**
  84905. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  84906. */
  84907. static readonly EASINGMODE_EASEINOUT: number;
  84908. private _easingMode;
  84909. /**
  84910. * Sets the easing mode of the current function.
  84911. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  84912. */
  84913. setEasingMode(easingMode: number): void;
  84914. /**
  84915. * Gets the current easing mode.
  84916. * @returns the easing mode
  84917. */
  84918. getEasingMode(): number;
  84919. /**
  84920. * @hidden
  84921. */
  84922. easeInCore(gradient: number): number;
  84923. /**
  84924. * Given an input gradient between 0 and 1, this returns the corresponding value
  84925. * of the easing function.
  84926. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84927. * @returns the corresponding value on the curve defined by the easing function
  84928. */
  84929. ease(gradient: number): number;
  84930. }
  84931. /**
  84932. * Easing function with a circle shape (see link below).
  84933. * @see https://easings.net/#easeInCirc
  84934. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84935. */
  84936. export class CircleEase extends EasingFunction implements IEasingFunction {
  84937. /** @hidden */
  84938. easeInCore(gradient: number): number;
  84939. }
  84940. /**
  84941. * Easing function with a ease back shape (see link below).
  84942. * @see https://easings.net/#easeInBack
  84943. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84944. */
  84945. export class BackEase extends EasingFunction implements IEasingFunction {
  84946. /** Defines the amplitude of the function */
  84947. amplitude: number;
  84948. /**
  84949. * Instantiates a back ease easing
  84950. * @see https://easings.net/#easeInBack
  84951. * @param amplitude Defines the amplitude of the function
  84952. */
  84953. constructor(
  84954. /** Defines the amplitude of the function */
  84955. amplitude?: number);
  84956. /** @hidden */
  84957. easeInCore(gradient: number): number;
  84958. }
  84959. /**
  84960. * Easing function with a bouncing shape (see link below).
  84961. * @see https://easings.net/#easeInBounce
  84962. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84963. */
  84964. export class BounceEase extends EasingFunction implements IEasingFunction {
  84965. /** Defines the number of bounces */
  84966. bounces: number;
  84967. /** Defines the amplitude of the bounce */
  84968. bounciness: number;
  84969. /**
  84970. * Instantiates a bounce easing
  84971. * @see https://easings.net/#easeInBounce
  84972. * @param bounces Defines the number of bounces
  84973. * @param bounciness Defines the amplitude of the bounce
  84974. */
  84975. constructor(
  84976. /** Defines the number of bounces */
  84977. bounces?: number,
  84978. /** Defines the amplitude of the bounce */
  84979. bounciness?: number);
  84980. /** @hidden */
  84981. easeInCore(gradient: number): number;
  84982. }
  84983. /**
  84984. * Easing function with a power of 3 shape (see link below).
  84985. * @see https://easings.net/#easeInCubic
  84986. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84987. */
  84988. export class CubicEase extends EasingFunction implements IEasingFunction {
  84989. /** @hidden */
  84990. easeInCore(gradient: number): number;
  84991. }
  84992. /**
  84993. * Easing function with an elastic shape (see link below).
  84994. * @see https://easings.net/#easeInElastic
  84995. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84996. */
  84997. export class ElasticEase extends EasingFunction implements IEasingFunction {
  84998. /** Defines the number of oscillations*/
  84999. oscillations: number;
  85000. /** Defines the amplitude of the oscillations*/
  85001. springiness: number;
  85002. /**
  85003. * Instantiates an elastic easing function
  85004. * @see https://easings.net/#easeInElastic
  85005. * @param oscillations Defines the number of oscillations
  85006. * @param springiness Defines the amplitude of the oscillations
  85007. */
  85008. constructor(
  85009. /** Defines the number of oscillations*/
  85010. oscillations?: number,
  85011. /** Defines the amplitude of the oscillations*/
  85012. springiness?: number);
  85013. /** @hidden */
  85014. easeInCore(gradient: number): number;
  85015. }
  85016. /**
  85017. * Easing function with an exponential shape (see link below).
  85018. * @see https://easings.net/#easeInExpo
  85019. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85020. */
  85021. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  85022. /** Defines the exponent of the function */
  85023. exponent: number;
  85024. /**
  85025. * Instantiates an exponential easing function
  85026. * @see https://easings.net/#easeInExpo
  85027. * @param exponent Defines the exponent of the function
  85028. */
  85029. constructor(
  85030. /** Defines the exponent of the function */
  85031. exponent?: number);
  85032. /** @hidden */
  85033. easeInCore(gradient: number): number;
  85034. }
  85035. /**
  85036. * Easing function with a power shape (see link below).
  85037. * @see https://easings.net/#easeInQuad
  85038. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85039. */
  85040. export class PowerEase extends EasingFunction implements IEasingFunction {
  85041. /** Defines the power of the function */
  85042. power: number;
  85043. /**
  85044. * Instantiates an power base easing function
  85045. * @see https://easings.net/#easeInQuad
  85046. * @param power Defines the power of the function
  85047. */
  85048. constructor(
  85049. /** Defines the power of the function */
  85050. power?: number);
  85051. /** @hidden */
  85052. easeInCore(gradient: number): number;
  85053. }
  85054. /**
  85055. * Easing function with a power of 2 shape (see link below).
  85056. * @see https://easings.net/#easeInQuad
  85057. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85058. */
  85059. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  85060. /** @hidden */
  85061. easeInCore(gradient: number): number;
  85062. }
  85063. /**
  85064. * Easing function with a power of 4 shape (see link below).
  85065. * @see https://easings.net/#easeInQuart
  85066. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85067. */
  85068. export class QuarticEase extends EasingFunction implements IEasingFunction {
  85069. /** @hidden */
  85070. easeInCore(gradient: number): number;
  85071. }
  85072. /**
  85073. * Easing function with a power of 5 shape (see link below).
  85074. * @see https://easings.net/#easeInQuint
  85075. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85076. */
  85077. export class QuinticEase extends EasingFunction implements IEasingFunction {
  85078. /** @hidden */
  85079. easeInCore(gradient: number): number;
  85080. }
  85081. /**
  85082. * Easing function with a sin shape (see link below).
  85083. * @see https://easings.net/#easeInSine
  85084. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85085. */
  85086. export class SineEase extends EasingFunction implements IEasingFunction {
  85087. /** @hidden */
  85088. easeInCore(gradient: number): number;
  85089. }
  85090. /**
  85091. * Easing function with a bezier shape (see link below).
  85092. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85093. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85094. */
  85095. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  85096. /** Defines the x component of the start tangent in the bezier curve */
  85097. x1: number;
  85098. /** Defines the y component of the start tangent in the bezier curve */
  85099. y1: number;
  85100. /** Defines the x component of the end tangent in the bezier curve */
  85101. x2: number;
  85102. /** Defines the y component of the end tangent in the bezier curve */
  85103. y2: number;
  85104. /**
  85105. * Instantiates a bezier function
  85106. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85107. * @param x1 Defines the x component of the start tangent in the bezier curve
  85108. * @param y1 Defines the y component of the start tangent in the bezier curve
  85109. * @param x2 Defines the x component of the end tangent in the bezier curve
  85110. * @param y2 Defines the y component of the end tangent in the bezier curve
  85111. */
  85112. constructor(
  85113. /** Defines the x component of the start tangent in the bezier curve */
  85114. x1?: number,
  85115. /** Defines the y component of the start tangent in the bezier curve */
  85116. y1?: number,
  85117. /** Defines the x component of the end tangent in the bezier curve */
  85118. x2?: number,
  85119. /** Defines the y component of the end tangent in the bezier curve */
  85120. y2?: number);
  85121. /** @hidden */
  85122. easeInCore(gradient: number): number;
  85123. }
  85124. }
  85125. declare module BABYLON {
  85126. /**
  85127. * Class used to hold a RBG color
  85128. */
  85129. export class Color3 {
  85130. /**
  85131. * Defines the red component (between 0 and 1, default is 0)
  85132. */
  85133. r: number;
  85134. /**
  85135. * Defines the green component (between 0 and 1, default is 0)
  85136. */
  85137. g: number;
  85138. /**
  85139. * Defines the blue component (between 0 and 1, default is 0)
  85140. */
  85141. b: number;
  85142. /**
  85143. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  85144. * @param r defines the red component (between 0 and 1, default is 0)
  85145. * @param g defines the green component (between 0 and 1, default is 0)
  85146. * @param b defines the blue component (between 0 and 1, default is 0)
  85147. */
  85148. constructor(
  85149. /**
  85150. * Defines the red component (between 0 and 1, default is 0)
  85151. */
  85152. r?: number,
  85153. /**
  85154. * Defines the green component (between 0 and 1, default is 0)
  85155. */
  85156. g?: number,
  85157. /**
  85158. * Defines the blue component (between 0 and 1, default is 0)
  85159. */
  85160. b?: number);
  85161. /**
  85162. * Creates a string with the Color3 current values
  85163. * @returns the string representation of the Color3 object
  85164. */
  85165. toString(): string;
  85166. /**
  85167. * Returns the string "Color3"
  85168. * @returns "Color3"
  85169. */
  85170. getClassName(): string;
  85171. /**
  85172. * Compute the Color3 hash code
  85173. * @returns an unique number that can be used to hash Color3 objects
  85174. */
  85175. getHashCode(): number;
  85176. /**
  85177. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  85178. * @param array defines the array where to store the r,g,b components
  85179. * @param index defines an optional index in the target array to define where to start storing values
  85180. * @returns the current Color3 object
  85181. */
  85182. toArray(array: FloatArray, index?: number): Color3;
  85183. /**
  85184. * Update the current color with values stored in an array from the starting index of the given array
  85185. * @param array defines the source array
  85186. * @param offset defines an offset in the source array
  85187. * @returns the current Color3 object
  85188. */
  85189. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85190. /**
  85191. * Returns a new Color4 object from the current Color3 and the given alpha
  85192. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  85193. * @returns a new Color4 object
  85194. */
  85195. toColor4(alpha?: number): Color4;
  85196. /**
  85197. * Returns a new array populated with 3 numeric elements : red, green and blue values
  85198. * @returns the new array
  85199. */
  85200. asArray(): number[];
  85201. /**
  85202. * Returns the luminance value
  85203. * @returns a float value
  85204. */
  85205. toLuminance(): number;
  85206. /**
  85207. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  85208. * @param otherColor defines the second operand
  85209. * @returns the new Color3 object
  85210. */
  85211. multiply(otherColor: DeepImmutable<Color3>): Color3;
  85212. /**
  85213. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  85214. * @param otherColor defines the second operand
  85215. * @param result defines the Color3 object where to store the result
  85216. * @returns the current Color3
  85217. */
  85218. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85219. /**
  85220. * Determines equality between Color3 objects
  85221. * @param otherColor defines the second operand
  85222. * @returns true if the rgb values are equal to the given ones
  85223. */
  85224. equals(otherColor: DeepImmutable<Color3>): boolean;
  85225. /**
  85226. * Determines equality between the current Color3 object and a set of r,b,g values
  85227. * @param r defines the red component to check
  85228. * @param g defines the green component to check
  85229. * @param b defines the blue component to check
  85230. * @returns true if the rgb values are equal to the given ones
  85231. */
  85232. equalsFloats(r: number, g: number, b: number): boolean;
  85233. /**
  85234. * Multiplies in place each rgb value by scale
  85235. * @param scale defines the scaling factor
  85236. * @returns the updated Color3
  85237. */
  85238. scale(scale: number): Color3;
  85239. /**
  85240. * Multiplies the rgb values by scale and stores the result into "result"
  85241. * @param scale defines the scaling factor
  85242. * @param result defines the Color3 object where to store the result
  85243. * @returns the unmodified current Color3
  85244. */
  85245. scaleToRef(scale: number, result: Color3): Color3;
  85246. /**
  85247. * Scale the current Color3 values by a factor and add the result to a given Color3
  85248. * @param scale defines the scale factor
  85249. * @param result defines color to store the result into
  85250. * @returns the unmodified current Color3
  85251. */
  85252. scaleAndAddToRef(scale: number, result: Color3): Color3;
  85253. /**
  85254. * Clamps the rgb values by the min and max values and stores the result into "result"
  85255. * @param min defines minimum clamping value (default is 0)
  85256. * @param max defines maximum clamping value (default is 1)
  85257. * @param result defines color to store the result into
  85258. * @returns the original Color3
  85259. */
  85260. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  85261. /**
  85262. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  85263. * @param otherColor defines the second operand
  85264. * @returns the new Color3
  85265. */
  85266. add(otherColor: DeepImmutable<Color3>): Color3;
  85267. /**
  85268. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  85269. * @param otherColor defines the second operand
  85270. * @param result defines Color3 object to store the result into
  85271. * @returns the unmodified current Color3
  85272. */
  85273. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85274. /**
  85275. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  85276. * @param otherColor defines the second operand
  85277. * @returns the new Color3
  85278. */
  85279. subtract(otherColor: DeepImmutable<Color3>): Color3;
  85280. /**
  85281. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  85282. * @param otherColor defines the second operand
  85283. * @param result defines Color3 object to store the result into
  85284. * @returns the unmodified current Color3
  85285. */
  85286. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85287. /**
  85288. * Copy the current object
  85289. * @returns a new Color3 copied the current one
  85290. */
  85291. clone(): Color3;
  85292. /**
  85293. * Copies the rgb values from the source in the current Color3
  85294. * @param source defines the source Color3 object
  85295. * @returns the updated Color3 object
  85296. */
  85297. copyFrom(source: DeepImmutable<Color3>): Color3;
  85298. /**
  85299. * Updates the Color3 rgb values from the given floats
  85300. * @param r defines the red component to read from
  85301. * @param g defines the green component to read from
  85302. * @param b defines the blue component to read from
  85303. * @returns the current Color3 object
  85304. */
  85305. copyFromFloats(r: number, g: number, b: number): Color3;
  85306. /**
  85307. * Updates the Color3 rgb values from the given floats
  85308. * @param r defines the red component to read from
  85309. * @param g defines the green component to read from
  85310. * @param b defines the blue component to read from
  85311. * @returns the current Color3 object
  85312. */
  85313. set(r: number, g: number, b: number): Color3;
  85314. /**
  85315. * Compute the Color3 hexadecimal code as a string
  85316. * @returns a string containing the hexadecimal representation of the Color3 object
  85317. */
  85318. toHexString(): string;
  85319. /**
  85320. * Computes a new Color3 converted from the current one to linear space
  85321. * @returns a new Color3 object
  85322. */
  85323. toLinearSpace(): Color3;
  85324. /**
  85325. * Converts current color in rgb space to HSV values
  85326. * @returns a new color3 representing the HSV values
  85327. */
  85328. toHSV(): Color3;
  85329. /**
  85330. * Converts current color in rgb space to HSV values
  85331. * @param result defines the Color3 where to store the HSV values
  85332. */
  85333. toHSVToRef(result: Color3): void;
  85334. /**
  85335. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  85336. * @param convertedColor defines the Color3 object where to store the linear space version
  85337. * @returns the unmodified Color3
  85338. */
  85339. toLinearSpaceToRef(convertedColor: Color3): Color3;
  85340. /**
  85341. * Computes a new Color3 converted from the current one to gamma space
  85342. * @returns a new Color3 object
  85343. */
  85344. toGammaSpace(): Color3;
  85345. /**
  85346. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  85347. * @param convertedColor defines the Color3 object where to store the gamma space version
  85348. * @returns the unmodified Color3
  85349. */
  85350. toGammaSpaceToRef(convertedColor: Color3): Color3;
  85351. private static _BlackReadOnly;
  85352. /**
  85353. * Convert Hue, saturation and value to a Color3 (RGB)
  85354. * @param hue defines the hue
  85355. * @param saturation defines the saturation
  85356. * @param value defines the value
  85357. * @param result defines the Color3 where to store the RGB values
  85358. */
  85359. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  85360. /**
  85361. * Creates a new Color3 from the string containing valid hexadecimal values
  85362. * @param hex defines a string containing valid hexadecimal values
  85363. * @returns a new Color3 object
  85364. */
  85365. static FromHexString(hex: string): Color3;
  85366. /**
  85367. * Creates a new Color3 from the starting index of the given array
  85368. * @param array defines the source array
  85369. * @param offset defines an offset in the source array
  85370. * @returns a new Color3 object
  85371. */
  85372. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85373. /**
  85374. * Creates a new Color3 from the starting index element of the given array
  85375. * @param array defines the source array to read from
  85376. * @param offset defines the offset in the source array
  85377. * @param result defines the target Color3 object
  85378. */
  85379. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  85380. /**
  85381. * Creates a new Color3 from integer values (< 256)
  85382. * @param r defines the red component to read from (value between 0 and 255)
  85383. * @param g defines the green component to read from (value between 0 and 255)
  85384. * @param b defines the blue component to read from (value between 0 and 255)
  85385. * @returns a new Color3 object
  85386. */
  85387. static FromInts(r: number, g: number, b: number): Color3;
  85388. /**
  85389. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85390. * @param start defines the start Color3 value
  85391. * @param end defines the end Color3 value
  85392. * @param amount defines the gradient value between start and end
  85393. * @returns a new Color3 object
  85394. */
  85395. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  85396. /**
  85397. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85398. * @param left defines the start value
  85399. * @param right defines the end value
  85400. * @param amount defines the gradient factor
  85401. * @param result defines the Color3 object where to store the result
  85402. */
  85403. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  85404. /**
  85405. * Returns a Color3 value containing a red color
  85406. * @returns a new Color3 object
  85407. */
  85408. static Red(): Color3;
  85409. /**
  85410. * Returns a Color3 value containing a green color
  85411. * @returns a new Color3 object
  85412. */
  85413. static Green(): Color3;
  85414. /**
  85415. * Returns a Color3 value containing a blue color
  85416. * @returns a new Color3 object
  85417. */
  85418. static Blue(): Color3;
  85419. /**
  85420. * Returns a Color3 value containing a black color
  85421. * @returns a new Color3 object
  85422. */
  85423. static Black(): Color3;
  85424. /**
  85425. * Gets a Color3 value containing a black color that must not be updated
  85426. */
  85427. static get BlackReadOnly(): DeepImmutable<Color3>;
  85428. /**
  85429. * Returns a Color3 value containing a white color
  85430. * @returns a new Color3 object
  85431. */
  85432. static White(): Color3;
  85433. /**
  85434. * Returns a Color3 value containing a purple color
  85435. * @returns a new Color3 object
  85436. */
  85437. static Purple(): Color3;
  85438. /**
  85439. * Returns a Color3 value containing a magenta color
  85440. * @returns a new Color3 object
  85441. */
  85442. static Magenta(): Color3;
  85443. /**
  85444. * Returns a Color3 value containing a yellow color
  85445. * @returns a new Color3 object
  85446. */
  85447. static Yellow(): Color3;
  85448. /**
  85449. * Returns a Color3 value containing a gray color
  85450. * @returns a new Color3 object
  85451. */
  85452. static Gray(): Color3;
  85453. /**
  85454. * Returns a Color3 value containing a teal color
  85455. * @returns a new Color3 object
  85456. */
  85457. static Teal(): Color3;
  85458. /**
  85459. * Returns a Color3 value containing a random color
  85460. * @returns a new Color3 object
  85461. */
  85462. static Random(): Color3;
  85463. }
  85464. /**
  85465. * Class used to hold a RBGA color
  85466. */
  85467. export class Color4 {
  85468. /**
  85469. * Defines the red component (between 0 and 1, default is 0)
  85470. */
  85471. r: number;
  85472. /**
  85473. * Defines the green component (between 0 and 1, default is 0)
  85474. */
  85475. g: number;
  85476. /**
  85477. * Defines the blue component (between 0 and 1, default is 0)
  85478. */
  85479. b: number;
  85480. /**
  85481. * Defines the alpha component (between 0 and 1, default is 1)
  85482. */
  85483. a: number;
  85484. /**
  85485. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  85486. * @param r defines the red component (between 0 and 1, default is 0)
  85487. * @param g defines the green component (between 0 and 1, default is 0)
  85488. * @param b defines the blue component (between 0 and 1, default is 0)
  85489. * @param a defines the alpha component (between 0 and 1, default is 1)
  85490. */
  85491. constructor(
  85492. /**
  85493. * Defines the red component (between 0 and 1, default is 0)
  85494. */
  85495. r?: number,
  85496. /**
  85497. * Defines the green component (between 0 and 1, default is 0)
  85498. */
  85499. g?: number,
  85500. /**
  85501. * Defines the blue component (between 0 and 1, default is 0)
  85502. */
  85503. b?: number,
  85504. /**
  85505. * Defines the alpha component (between 0 and 1, default is 1)
  85506. */
  85507. a?: number);
  85508. /**
  85509. * Adds in place the given Color4 values to the current Color4 object
  85510. * @param right defines the second operand
  85511. * @returns the current updated Color4 object
  85512. */
  85513. addInPlace(right: DeepImmutable<Color4>): Color4;
  85514. /**
  85515. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  85516. * @returns the new array
  85517. */
  85518. asArray(): number[];
  85519. /**
  85520. * Stores from the starting index in the given array the Color4 successive values
  85521. * @param array defines the array where to store the r,g,b components
  85522. * @param index defines an optional index in the target array to define where to start storing values
  85523. * @returns the current Color4 object
  85524. */
  85525. toArray(array: number[], index?: number): Color4;
  85526. /**
  85527. * Update the current color with values stored in an array from the starting index of the given array
  85528. * @param array defines the source array
  85529. * @param offset defines an offset in the source array
  85530. * @returns the current Color4 object
  85531. */
  85532. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85533. /**
  85534. * Determines equality between Color4 objects
  85535. * @param otherColor defines the second operand
  85536. * @returns true if the rgba values are equal to the given ones
  85537. */
  85538. equals(otherColor: DeepImmutable<Color4>): boolean;
  85539. /**
  85540. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  85541. * @param right defines the second operand
  85542. * @returns a new Color4 object
  85543. */
  85544. add(right: DeepImmutable<Color4>): Color4;
  85545. /**
  85546. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  85547. * @param right defines the second operand
  85548. * @returns a new Color4 object
  85549. */
  85550. subtract(right: DeepImmutable<Color4>): Color4;
  85551. /**
  85552. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  85553. * @param right defines the second operand
  85554. * @param result defines the Color4 object where to store the result
  85555. * @returns the current Color4 object
  85556. */
  85557. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  85558. /**
  85559. * Creates a new Color4 with the current Color4 values multiplied by scale
  85560. * @param scale defines the scaling factor to apply
  85561. * @returns a new Color4 object
  85562. */
  85563. scale(scale: number): Color4;
  85564. /**
  85565. * Multiplies the current Color4 values by scale and stores the result in "result"
  85566. * @param scale defines the scaling factor to apply
  85567. * @param result defines the Color4 object where to store the result
  85568. * @returns the current unmodified Color4
  85569. */
  85570. scaleToRef(scale: number, result: Color4): Color4;
  85571. /**
  85572. * Scale the current Color4 values by a factor and add the result to a given Color4
  85573. * @param scale defines the scale factor
  85574. * @param result defines the Color4 object where to store the result
  85575. * @returns the unmodified current Color4
  85576. */
  85577. scaleAndAddToRef(scale: number, result: Color4): Color4;
  85578. /**
  85579. * Clamps the rgb values by the min and max values and stores the result into "result"
  85580. * @param min defines minimum clamping value (default is 0)
  85581. * @param max defines maximum clamping value (default is 1)
  85582. * @param result defines color to store the result into.
  85583. * @returns the cuurent Color4
  85584. */
  85585. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  85586. /**
  85587. * Multipy an Color4 value by another and return a new Color4 object
  85588. * @param color defines the Color4 value to multiply by
  85589. * @returns a new Color4 object
  85590. */
  85591. multiply(color: Color4): Color4;
  85592. /**
  85593. * Multipy a Color4 value by another and push the result in a reference value
  85594. * @param color defines the Color4 value to multiply by
  85595. * @param result defines the Color4 to fill the result in
  85596. * @returns the result Color4
  85597. */
  85598. multiplyToRef(color: Color4, result: Color4): Color4;
  85599. /**
  85600. * Creates a string with the Color4 current values
  85601. * @returns the string representation of the Color4 object
  85602. */
  85603. toString(): string;
  85604. /**
  85605. * Returns the string "Color4"
  85606. * @returns "Color4"
  85607. */
  85608. getClassName(): string;
  85609. /**
  85610. * Compute the Color4 hash code
  85611. * @returns an unique number that can be used to hash Color4 objects
  85612. */
  85613. getHashCode(): number;
  85614. /**
  85615. * Creates a new Color4 copied from the current one
  85616. * @returns a new Color4 object
  85617. */
  85618. clone(): Color4;
  85619. /**
  85620. * Copies the given Color4 values into the current one
  85621. * @param source defines the source Color4 object
  85622. * @returns the current updated Color4 object
  85623. */
  85624. copyFrom(source: Color4): Color4;
  85625. /**
  85626. * Copies the given float values into the current one
  85627. * @param r defines the red component to read from
  85628. * @param g defines the green component to read from
  85629. * @param b defines the blue component to read from
  85630. * @param a defines the alpha component to read from
  85631. * @returns the current updated Color4 object
  85632. */
  85633. copyFromFloats(r: number, g: number, b: number, a: number): 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. set(r: number, g: number, b: number, a: number): Color4;
  85643. /**
  85644. * Compute the Color4 hexadecimal code as a string
  85645. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  85646. * @returns a string containing the hexadecimal representation of the Color4 object
  85647. */
  85648. toHexString(returnAsColor3?: boolean): string;
  85649. /**
  85650. * Computes a new Color4 converted from the current one to linear space
  85651. * @returns a new Color4 object
  85652. */
  85653. toLinearSpace(): Color4;
  85654. /**
  85655. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  85656. * @param convertedColor defines the Color4 object where to store the linear space version
  85657. * @returns the unmodified Color4
  85658. */
  85659. toLinearSpaceToRef(convertedColor: Color4): Color4;
  85660. /**
  85661. * Computes a new Color4 converted from the current one to gamma space
  85662. * @returns a new Color4 object
  85663. */
  85664. toGammaSpace(): Color4;
  85665. /**
  85666. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  85667. * @param convertedColor defines the Color4 object where to store the gamma space version
  85668. * @returns the unmodified Color4
  85669. */
  85670. toGammaSpaceToRef(convertedColor: Color4): Color4;
  85671. /**
  85672. * Creates a new Color4 from the string containing valid hexadecimal values
  85673. * @param hex defines a string containing valid hexadecimal values
  85674. * @returns a new Color4 object
  85675. */
  85676. static FromHexString(hex: string): Color4;
  85677. /**
  85678. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85679. * @param left defines the start value
  85680. * @param right defines the end value
  85681. * @param amount defines the gradient factor
  85682. * @returns a new Color4 object
  85683. */
  85684. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  85685. /**
  85686. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85687. * @param left defines the start value
  85688. * @param right defines the end value
  85689. * @param amount defines the gradient factor
  85690. * @param result defines the Color4 object where to store data
  85691. */
  85692. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  85693. /**
  85694. * Creates a new Color4 from a Color3 and an alpha value
  85695. * @param color3 defines the source Color3 to read from
  85696. * @param alpha defines the alpha component (1.0 by default)
  85697. * @returns a new Color4 object
  85698. */
  85699. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  85700. /**
  85701. * Creates a new Color4 from the starting index element of the given array
  85702. * @param array defines the source array to read from
  85703. * @param offset defines the offset in the source array
  85704. * @returns a new Color4 object
  85705. */
  85706. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85707. /**
  85708. * Creates a new Color4 from the starting index element of the given array
  85709. * @param array defines the source array to read from
  85710. * @param offset defines the offset in the source array
  85711. * @param result defines the target Color4 object
  85712. */
  85713. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  85714. /**
  85715. * Creates a new Color3 from integer values (< 256)
  85716. * @param r defines the red component to read from (value between 0 and 255)
  85717. * @param g defines the green component to read from (value between 0 and 255)
  85718. * @param b defines the blue component to read from (value between 0 and 255)
  85719. * @param a defines the alpha component to read from (value between 0 and 255)
  85720. * @returns a new Color3 object
  85721. */
  85722. static FromInts(r: number, g: number, b: number, a: number): Color4;
  85723. /**
  85724. * Check the content of a given array and convert it to an array containing RGBA data
  85725. * If the original array was already containing count * 4 values then it is returned directly
  85726. * @param colors defines the array to check
  85727. * @param count defines the number of RGBA data to expect
  85728. * @returns an array containing count * 4 values (RGBA)
  85729. */
  85730. static CheckColors4(colors: number[], count: number): number[];
  85731. }
  85732. /**
  85733. * @hidden
  85734. */
  85735. export class TmpColors {
  85736. static Color3: Color3[];
  85737. static Color4: Color4[];
  85738. }
  85739. }
  85740. declare module BABYLON {
  85741. /**
  85742. * Defines an interface which represents an animation key frame
  85743. */
  85744. export interface IAnimationKey {
  85745. /**
  85746. * Frame of the key frame
  85747. */
  85748. frame: number;
  85749. /**
  85750. * Value at the specifies key frame
  85751. */
  85752. value: any;
  85753. /**
  85754. * The input tangent for the cubic hermite spline
  85755. */
  85756. inTangent?: any;
  85757. /**
  85758. * The output tangent for the cubic hermite spline
  85759. */
  85760. outTangent?: any;
  85761. /**
  85762. * The animation interpolation type
  85763. */
  85764. interpolation?: AnimationKeyInterpolation;
  85765. }
  85766. /**
  85767. * Enum for the animation key frame interpolation type
  85768. */
  85769. export enum AnimationKeyInterpolation {
  85770. /**
  85771. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  85772. */
  85773. STEP = 1
  85774. }
  85775. }
  85776. declare module BABYLON {
  85777. /**
  85778. * Represents the range of an animation
  85779. */
  85780. export class AnimationRange {
  85781. /**The name of the animation range**/
  85782. name: string;
  85783. /**The starting frame of the animation */
  85784. from: number;
  85785. /**The ending frame of the animation*/
  85786. to: number;
  85787. /**
  85788. * Initializes the range of an animation
  85789. * @param name The name of the animation range
  85790. * @param from The starting frame of the animation
  85791. * @param to The ending frame of the animation
  85792. */
  85793. constructor(
  85794. /**The name of the animation range**/
  85795. name: string,
  85796. /**The starting frame of the animation */
  85797. from: number,
  85798. /**The ending frame of the animation*/
  85799. to: number);
  85800. /**
  85801. * Makes a copy of the animation range
  85802. * @returns A copy of the animation range
  85803. */
  85804. clone(): AnimationRange;
  85805. }
  85806. }
  85807. declare module BABYLON {
  85808. /**
  85809. * Composed of a frame, and an action function
  85810. */
  85811. export class AnimationEvent {
  85812. /** The frame for which the event is triggered **/
  85813. frame: number;
  85814. /** The event to perform when triggered **/
  85815. action: (currentFrame: number) => void;
  85816. /** Specifies if the event should be triggered only once**/
  85817. onlyOnce?: boolean | undefined;
  85818. /**
  85819. * Specifies if the animation event is done
  85820. */
  85821. isDone: boolean;
  85822. /**
  85823. * Initializes the animation event
  85824. * @param frame The frame for which the event is triggered
  85825. * @param action The event to perform when triggered
  85826. * @param onlyOnce Specifies if the event should be triggered only once
  85827. */
  85828. constructor(
  85829. /** The frame for which the event is triggered **/
  85830. frame: number,
  85831. /** The event to perform when triggered **/
  85832. action: (currentFrame: number) => void,
  85833. /** Specifies if the event should be triggered only once**/
  85834. onlyOnce?: boolean | undefined);
  85835. /** @hidden */
  85836. _clone(): AnimationEvent;
  85837. }
  85838. }
  85839. declare module BABYLON {
  85840. /**
  85841. * Interface used to define a behavior
  85842. */
  85843. export interface Behavior<T> {
  85844. /** gets or sets behavior's name */
  85845. name: string;
  85846. /**
  85847. * Function called when the behavior needs to be initialized (after attaching it to a target)
  85848. */
  85849. init(): void;
  85850. /**
  85851. * Called when the behavior is attached to a target
  85852. * @param target defines the target where the behavior is attached to
  85853. */
  85854. attach(target: T): void;
  85855. /**
  85856. * Called when the behavior is detached from its target
  85857. */
  85858. detach(): void;
  85859. }
  85860. /**
  85861. * Interface implemented by classes supporting behaviors
  85862. */
  85863. export interface IBehaviorAware<T> {
  85864. /**
  85865. * Attach a behavior
  85866. * @param behavior defines the behavior to attach
  85867. * @returns the current host
  85868. */
  85869. addBehavior(behavior: Behavior<T>): T;
  85870. /**
  85871. * Remove a behavior from the current object
  85872. * @param behavior defines the behavior to detach
  85873. * @returns the current host
  85874. */
  85875. removeBehavior(behavior: Behavior<T>): T;
  85876. /**
  85877. * Gets a behavior using its name to search
  85878. * @param name defines the name to search
  85879. * @returns the behavior or null if not found
  85880. */
  85881. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  85882. }
  85883. }
  85884. declare module BABYLON {
  85885. /**
  85886. * Defines an array and its length.
  85887. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  85888. */
  85889. export interface ISmartArrayLike<T> {
  85890. /**
  85891. * The data of the array.
  85892. */
  85893. data: Array<T>;
  85894. /**
  85895. * The active length of the array.
  85896. */
  85897. length: number;
  85898. }
  85899. /**
  85900. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85901. */
  85902. export class SmartArray<T> implements ISmartArrayLike<T> {
  85903. /**
  85904. * The full set of data from the array.
  85905. */
  85906. data: Array<T>;
  85907. /**
  85908. * The active length of the array.
  85909. */
  85910. length: number;
  85911. protected _id: number;
  85912. /**
  85913. * Instantiates a Smart Array.
  85914. * @param capacity defines the default capacity of the array.
  85915. */
  85916. constructor(capacity: number);
  85917. /**
  85918. * Pushes a value at the end of the active data.
  85919. * @param value defines the object to push in the array.
  85920. */
  85921. push(value: T): void;
  85922. /**
  85923. * Iterates over the active data and apply the lambda to them.
  85924. * @param func defines the action to apply on each value.
  85925. */
  85926. forEach(func: (content: T) => void): void;
  85927. /**
  85928. * Sorts the full sets of data.
  85929. * @param compareFn defines the comparison function to apply.
  85930. */
  85931. sort(compareFn: (a: T, b: T) => number): void;
  85932. /**
  85933. * Resets the active data to an empty array.
  85934. */
  85935. reset(): void;
  85936. /**
  85937. * Releases all the data from the array as well as the array.
  85938. */
  85939. dispose(): void;
  85940. /**
  85941. * Concats the active data with a given array.
  85942. * @param array defines the data to concatenate with.
  85943. */
  85944. concat(array: any): void;
  85945. /**
  85946. * Returns the position of a value in the active data.
  85947. * @param value defines the value to find the index for
  85948. * @returns the index if found in the active data otherwise -1
  85949. */
  85950. indexOf(value: T): number;
  85951. /**
  85952. * Returns whether an element is part of the active data.
  85953. * @param value defines the value to look for
  85954. * @returns true if found in the active data otherwise false
  85955. */
  85956. contains(value: T): boolean;
  85957. private static _GlobalId;
  85958. }
  85959. /**
  85960. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85961. * The data in this array can only be present once
  85962. */
  85963. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  85964. private _duplicateId;
  85965. /**
  85966. * Pushes a value at the end of the active data.
  85967. * THIS DOES NOT PREVENT DUPPLICATE DATA
  85968. * @param value defines the object to push in the array.
  85969. */
  85970. push(value: T): void;
  85971. /**
  85972. * Pushes a value at the end of the active data.
  85973. * If the data is already present, it won t be added again
  85974. * @param value defines the object to push in the array.
  85975. * @returns true if added false if it was already present
  85976. */
  85977. pushNoDuplicate(value: T): boolean;
  85978. /**
  85979. * Resets the active data to an empty array.
  85980. */
  85981. reset(): void;
  85982. /**
  85983. * Concats the active data with a given array.
  85984. * This ensures no dupplicate will be present in the result.
  85985. * @param array defines the data to concatenate with.
  85986. */
  85987. concatWithNoDuplicate(array: any): void;
  85988. }
  85989. }
  85990. declare module BABYLON {
  85991. /**
  85992. * @ignore
  85993. * This is a list of all the different input types that are available in the application.
  85994. * Fo instance: ArcRotateCameraGamepadInput...
  85995. */
  85996. export var CameraInputTypes: {};
  85997. /**
  85998. * This is the contract to implement in order to create a new input class.
  85999. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  86000. */
  86001. export interface ICameraInput<TCamera extends Camera> {
  86002. /**
  86003. * Defines the camera the input is attached to.
  86004. */
  86005. camera: Nullable<TCamera>;
  86006. /**
  86007. * Gets the class name of the current intput.
  86008. * @returns the class name
  86009. */
  86010. getClassName(): string;
  86011. /**
  86012. * Get the friendly name associated with the input class.
  86013. * @returns the input friendly name
  86014. */
  86015. getSimpleName(): string;
  86016. /**
  86017. * Attach the input controls to a specific dom element to get the input from.
  86018. * @param element Defines the element the controls should be listened from
  86019. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86020. */
  86021. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  86022. /**
  86023. * Detach the current controls from the specified dom element.
  86024. * @param element Defines the element to stop listening the inputs from
  86025. */
  86026. detachControl(element: Nullable<HTMLElement>): void;
  86027. /**
  86028. * Update the current camera state depending on the inputs that have been used this frame.
  86029. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86030. */
  86031. checkInputs?: () => void;
  86032. }
  86033. /**
  86034. * Represents a map of input types to input instance or input index to input instance.
  86035. */
  86036. export interface CameraInputsMap<TCamera extends Camera> {
  86037. /**
  86038. * Accessor to the input by input type.
  86039. */
  86040. [name: string]: ICameraInput<TCamera>;
  86041. /**
  86042. * Accessor to the input by input index.
  86043. */
  86044. [idx: number]: ICameraInput<TCamera>;
  86045. }
  86046. /**
  86047. * This represents the input manager used within a camera.
  86048. * It helps dealing with all the different kind of input attached to a camera.
  86049. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86050. */
  86051. export class CameraInputsManager<TCamera extends Camera> {
  86052. /**
  86053. * Defines the list of inputs attahed to the camera.
  86054. */
  86055. attached: CameraInputsMap<TCamera>;
  86056. /**
  86057. * Defines the dom element the camera is collecting inputs from.
  86058. * This is null if the controls have not been attached.
  86059. */
  86060. attachedElement: Nullable<HTMLElement>;
  86061. /**
  86062. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86063. */
  86064. noPreventDefault: boolean;
  86065. /**
  86066. * Defined the camera the input manager belongs to.
  86067. */
  86068. camera: TCamera;
  86069. /**
  86070. * Update the current camera state depending on the inputs that have been used this frame.
  86071. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86072. */
  86073. checkInputs: () => void;
  86074. /**
  86075. * Instantiate a new Camera Input Manager.
  86076. * @param camera Defines the camera the input manager blongs to
  86077. */
  86078. constructor(camera: TCamera);
  86079. /**
  86080. * Add an input method to a camera
  86081. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86082. * @param input camera input method
  86083. */
  86084. add(input: ICameraInput<TCamera>): void;
  86085. /**
  86086. * Remove a specific input method from a camera
  86087. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  86088. * @param inputToRemove camera input method
  86089. */
  86090. remove(inputToRemove: ICameraInput<TCamera>): void;
  86091. /**
  86092. * Remove a specific input type from a camera
  86093. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  86094. * @param inputType the type of the input to remove
  86095. */
  86096. removeByType(inputType: string): void;
  86097. private _addCheckInputs;
  86098. /**
  86099. * Attach the input controls to the currently attached dom element to listen the events from.
  86100. * @param input Defines the input to attach
  86101. */
  86102. attachInput(input: ICameraInput<TCamera>): void;
  86103. /**
  86104. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  86105. * @param element Defines the dom element to collect the events from
  86106. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86107. */
  86108. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  86109. /**
  86110. * Detach the current manager inputs controls from a specific dom element.
  86111. * @param element Defines the dom element to collect the events from
  86112. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  86113. */
  86114. detachElement(element: HTMLElement, disconnect?: boolean): void;
  86115. /**
  86116. * Rebuild the dynamic inputCheck function from the current list of
  86117. * defined inputs in the manager.
  86118. */
  86119. rebuildInputCheck(): void;
  86120. /**
  86121. * Remove all attached input methods from a camera
  86122. */
  86123. clear(): void;
  86124. /**
  86125. * Serialize the current input manager attached to a camera.
  86126. * This ensures than once parsed,
  86127. * the input associated to the camera will be identical to the current ones
  86128. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  86129. */
  86130. serialize(serializedCamera: any): void;
  86131. /**
  86132. * Parses an input manager serialized JSON to restore the previous list of inputs
  86133. * and states associated to a camera.
  86134. * @param parsedCamera Defines the JSON to parse
  86135. */
  86136. parse(parsedCamera: any): void;
  86137. }
  86138. }
  86139. declare module BABYLON {
  86140. /**
  86141. * Class used to store data that will be store in GPU memory
  86142. */
  86143. export class Buffer {
  86144. private _engine;
  86145. private _buffer;
  86146. /** @hidden */
  86147. _data: Nullable<DataArray>;
  86148. private _updatable;
  86149. private _instanced;
  86150. private _divisor;
  86151. /**
  86152. * Gets the byte stride.
  86153. */
  86154. readonly byteStride: number;
  86155. /**
  86156. * Constructor
  86157. * @param engine the engine
  86158. * @param data the data to use for this buffer
  86159. * @param updatable whether the data is updatable
  86160. * @param stride the stride (optional)
  86161. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86162. * @param instanced whether the buffer is instanced (optional)
  86163. * @param useBytes set to true if the stride in in bytes (optional)
  86164. * @param divisor sets an optional divisor for instances (1 by default)
  86165. */
  86166. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  86167. /**
  86168. * Create a new VertexBuffer based on the current buffer
  86169. * @param kind defines the vertex buffer kind (position, normal, etc.)
  86170. * @param offset defines offset in the buffer (0 by default)
  86171. * @param size defines the size in floats of attributes (position is 3 for instance)
  86172. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  86173. * @param instanced defines if the vertex buffer contains indexed data
  86174. * @param useBytes defines if the offset and stride are in bytes *
  86175. * @param divisor sets an optional divisor for instances (1 by default)
  86176. * @returns the new vertex buffer
  86177. */
  86178. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  86179. /**
  86180. * Gets a boolean indicating if the Buffer is updatable?
  86181. * @returns true if the buffer is updatable
  86182. */
  86183. isUpdatable(): boolean;
  86184. /**
  86185. * Gets current buffer's data
  86186. * @returns a DataArray or null
  86187. */
  86188. getData(): Nullable<DataArray>;
  86189. /**
  86190. * Gets underlying native buffer
  86191. * @returns underlying native buffer
  86192. */
  86193. getBuffer(): Nullable<DataBuffer>;
  86194. /**
  86195. * Gets the stride in float32 units (i.e. byte stride / 4).
  86196. * May not be an integer if the byte stride is not divisible by 4.
  86197. * @returns the stride in float32 units
  86198. * @deprecated Please use byteStride instead.
  86199. */
  86200. getStrideSize(): number;
  86201. /**
  86202. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86203. * @param data defines the data to store
  86204. */
  86205. create(data?: Nullable<DataArray>): void;
  86206. /** @hidden */
  86207. _rebuild(): void;
  86208. /**
  86209. * Update current buffer data
  86210. * @param data defines the data to store
  86211. */
  86212. update(data: DataArray): void;
  86213. /**
  86214. * Updates the data directly.
  86215. * @param data the new data
  86216. * @param offset the new offset
  86217. * @param vertexCount the vertex count (optional)
  86218. * @param useBytes set to true if the offset is in bytes
  86219. */
  86220. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  86221. /**
  86222. * Release all resources
  86223. */
  86224. dispose(): void;
  86225. }
  86226. /**
  86227. * Specialized buffer used to store vertex data
  86228. */
  86229. export class VertexBuffer {
  86230. /** @hidden */
  86231. _buffer: Buffer;
  86232. private _kind;
  86233. private _size;
  86234. private _ownsBuffer;
  86235. private _instanced;
  86236. private _instanceDivisor;
  86237. /**
  86238. * The byte type.
  86239. */
  86240. static readonly BYTE: number;
  86241. /**
  86242. * The unsigned byte type.
  86243. */
  86244. static readonly UNSIGNED_BYTE: number;
  86245. /**
  86246. * The short type.
  86247. */
  86248. static readonly SHORT: number;
  86249. /**
  86250. * The unsigned short type.
  86251. */
  86252. static readonly UNSIGNED_SHORT: number;
  86253. /**
  86254. * The integer type.
  86255. */
  86256. static readonly INT: number;
  86257. /**
  86258. * The unsigned integer type.
  86259. */
  86260. static readonly UNSIGNED_INT: number;
  86261. /**
  86262. * The float type.
  86263. */
  86264. static readonly FLOAT: number;
  86265. /**
  86266. * Gets or sets the instance divisor when in instanced mode
  86267. */
  86268. get instanceDivisor(): number;
  86269. set instanceDivisor(value: number);
  86270. /**
  86271. * Gets the byte stride.
  86272. */
  86273. readonly byteStride: number;
  86274. /**
  86275. * Gets the byte offset.
  86276. */
  86277. readonly byteOffset: number;
  86278. /**
  86279. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  86280. */
  86281. readonly normalized: boolean;
  86282. /**
  86283. * Gets the data type of each component in the array.
  86284. */
  86285. readonly type: number;
  86286. /**
  86287. * Constructor
  86288. * @param engine the engine
  86289. * @param data the data to use for this vertex buffer
  86290. * @param kind the vertex buffer kind
  86291. * @param updatable whether the data is updatable
  86292. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86293. * @param stride the stride (optional)
  86294. * @param instanced whether the buffer is instanced (optional)
  86295. * @param offset the offset of the data (optional)
  86296. * @param size the number of components (optional)
  86297. * @param type the type of the component (optional)
  86298. * @param normalized whether the data contains normalized data (optional)
  86299. * @param useBytes set to true if stride and offset are in bytes (optional)
  86300. * @param divisor defines the instance divisor to use (1 by default)
  86301. */
  86302. 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);
  86303. /** @hidden */
  86304. _rebuild(): void;
  86305. /**
  86306. * Returns the kind of the VertexBuffer (string)
  86307. * @returns a string
  86308. */
  86309. getKind(): string;
  86310. /**
  86311. * Gets a boolean indicating if the VertexBuffer is updatable?
  86312. * @returns true if the buffer is updatable
  86313. */
  86314. isUpdatable(): boolean;
  86315. /**
  86316. * Gets current buffer's data
  86317. * @returns a DataArray or null
  86318. */
  86319. getData(): Nullable<DataArray>;
  86320. /**
  86321. * Gets underlying native buffer
  86322. * @returns underlying native buffer
  86323. */
  86324. getBuffer(): Nullable<DataBuffer>;
  86325. /**
  86326. * Gets the stride in float32 units (i.e. byte stride / 4).
  86327. * May not be an integer if the byte stride is not divisible by 4.
  86328. * @returns the stride in float32 units
  86329. * @deprecated Please use byteStride instead.
  86330. */
  86331. getStrideSize(): number;
  86332. /**
  86333. * Returns the offset as a multiple of the type byte length.
  86334. * @returns the offset in bytes
  86335. * @deprecated Please use byteOffset instead.
  86336. */
  86337. getOffset(): number;
  86338. /**
  86339. * Returns the number of components per vertex attribute (integer)
  86340. * @returns the size in float
  86341. */
  86342. getSize(): number;
  86343. /**
  86344. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  86345. * @returns true if this buffer is instanced
  86346. */
  86347. getIsInstanced(): boolean;
  86348. /**
  86349. * Returns the instancing divisor, zero for non-instanced (integer).
  86350. * @returns a number
  86351. */
  86352. getInstanceDivisor(): number;
  86353. /**
  86354. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86355. * @param data defines the data to store
  86356. */
  86357. create(data?: DataArray): void;
  86358. /**
  86359. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  86360. * This function will create a new buffer if the current one is not updatable
  86361. * @param data defines the data to store
  86362. */
  86363. update(data: DataArray): void;
  86364. /**
  86365. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  86366. * Returns the directly updated WebGLBuffer.
  86367. * @param data the new data
  86368. * @param offset the new offset
  86369. * @param useBytes set to true if the offset is in bytes
  86370. */
  86371. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  86372. /**
  86373. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  86374. */
  86375. dispose(): void;
  86376. /**
  86377. * Enumerates each value of this vertex buffer as numbers.
  86378. * @param count the number of values to enumerate
  86379. * @param callback the callback function called for each value
  86380. */
  86381. forEach(count: number, callback: (value: number, index: number) => void): void;
  86382. /**
  86383. * Positions
  86384. */
  86385. static readonly PositionKind: string;
  86386. /**
  86387. * Normals
  86388. */
  86389. static readonly NormalKind: string;
  86390. /**
  86391. * Tangents
  86392. */
  86393. static readonly TangentKind: string;
  86394. /**
  86395. * Texture coordinates
  86396. */
  86397. static readonly UVKind: string;
  86398. /**
  86399. * Texture coordinates 2
  86400. */
  86401. static readonly UV2Kind: string;
  86402. /**
  86403. * Texture coordinates 3
  86404. */
  86405. static readonly UV3Kind: string;
  86406. /**
  86407. * Texture coordinates 4
  86408. */
  86409. static readonly UV4Kind: string;
  86410. /**
  86411. * Texture coordinates 5
  86412. */
  86413. static readonly UV5Kind: string;
  86414. /**
  86415. * Texture coordinates 6
  86416. */
  86417. static readonly UV6Kind: string;
  86418. /**
  86419. * Colors
  86420. */
  86421. static readonly ColorKind: string;
  86422. /**
  86423. * Matrix indices (for bones)
  86424. */
  86425. static readonly MatricesIndicesKind: string;
  86426. /**
  86427. * Matrix weights (for bones)
  86428. */
  86429. static readonly MatricesWeightsKind: string;
  86430. /**
  86431. * Additional matrix indices (for bones)
  86432. */
  86433. static readonly MatricesIndicesExtraKind: string;
  86434. /**
  86435. * Additional matrix weights (for bones)
  86436. */
  86437. static readonly MatricesWeightsExtraKind: string;
  86438. /**
  86439. * Deduces the stride given a kind.
  86440. * @param kind The kind string to deduce
  86441. * @returns The deduced stride
  86442. */
  86443. static DeduceStride(kind: string): number;
  86444. /**
  86445. * Gets the byte length of the given type.
  86446. * @param type the type
  86447. * @returns the number of bytes
  86448. */
  86449. static GetTypeByteLength(type: number): number;
  86450. /**
  86451. * Enumerates each value of the given parameters as numbers.
  86452. * @param data the data to enumerate
  86453. * @param byteOffset the byte offset of the data
  86454. * @param byteStride the byte stride of the data
  86455. * @param componentCount the number of components per element
  86456. * @param componentType the type of the component
  86457. * @param count the number of values to enumerate
  86458. * @param normalized whether the data is normalized
  86459. * @param callback the callback function called for each value
  86460. */
  86461. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  86462. private static _GetFloatValue;
  86463. }
  86464. }
  86465. declare module BABYLON {
  86466. /**
  86467. * @hidden
  86468. */
  86469. export class IntersectionInfo {
  86470. bu: Nullable<number>;
  86471. bv: Nullable<number>;
  86472. distance: number;
  86473. faceId: number;
  86474. subMeshId: number;
  86475. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  86476. }
  86477. }
  86478. declare module BABYLON {
  86479. /**
  86480. * Class used to store bounding sphere information
  86481. */
  86482. export class BoundingSphere {
  86483. /**
  86484. * Gets the center of the bounding sphere in local space
  86485. */
  86486. readonly center: Vector3;
  86487. /**
  86488. * Radius of the bounding sphere in local space
  86489. */
  86490. radius: number;
  86491. /**
  86492. * Gets the center of the bounding sphere in world space
  86493. */
  86494. readonly centerWorld: Vector3;
  86495. /**
  86496. * Radius of the bounding sphere in world space
  86497. */
  86498. radiusWorld: number;
  86499. /**
  86500. * Gets the minimum vector in local space
  86501. */
  86502. readonly minimum: Vector3;
  86503. /**
  86504. * Gets the maximum vector in local space
  86505. */
  86506. readonly maximum: Vector3;
  86507. private _worldMatrix;
  86508. private static readonly TmpVector3;
  86509. /**
  86510. * Creates a new bounding sphere
  86511. * @param min defines the minimum vector (in local space)
  86512. * @param max defines the maximum vector (in local space)
  86513. * @param worldMatrix defines the new world matrix
  86514. */
  86515. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86516. /**
  86517. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  86518. * @param min defines the new minimum vector (in local space)
  86519. * @param max defines the new maximum vector (in local space)
  86520. * @param worldMatrix defines the new world matrix
  86521. */
  86522. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86523. /**
  86524. * Scale the current bounding sphere by applying a scale factor
  86525. * @param factor defines the scale factor to apply
  86526. * @returns the current bounding box
  86527. */
  86528. scale(factor: number): BoundingSphere;
  86529. /**
  86530. * Gets the world matrix of the bounding box
  86531. * @returns a matrix
  86532. */
  86533. getWorldMatrix(): DeepImmutable<Matrix>;
  86534. /** @hidden */
  86535. _update(worldMatrix: DeepImmutable<Matrix>): void;
  86536. /**
  86537. * Tests if the bounding sphere is intersecting the frustum planes
  86538. * @param frustumPlanes defines the frustum planes to test
  86539. * @returns true if there is an intersection
  86540. */
  86541. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86542. /**
  86543. * Tests if the bounding sphere center is in between the frustum planes.
  86544. * Used for optimistic fast inclusion.
  86545. * @param frustumPlanes defines the frustum planes to test
  86546. * @returns true if the sphere center is in between the frustum planes
  86547. */
  86548. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86549. /**
  86550. * Tests if a point is inside the bounding sphere
  86551. * @param point defines the point to test
  86552. * @returns true if the point is inside the bounding sphere
  86553. */
  86554. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86555. /**
  86556. * Checks if two sphere intersct
  86557. * @param sphere0 sphere 0
  86558. * @param sphere1 sphere 1
  86559. * @returns true if the speres intersect
  86560. */
  86561. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  86562. }
  86563. }
  86564. declare module BABYLON {
  86565. /**
  86566. * Class used to store bounding box information
  86567. */
  86568. export class BoundingBox implements ICullable {
  86569. /**
  86570. * Gets the 8 vectors representing the bounding box in local space
  86571. */
  86572. readonly vectors: Vector3[];
  86573. /**
  86574. * Gets the center of the bounding box in local space
  86575. */
  86576. readonly center: Vector3;
  86577. /**
  86578. * Gets the center of the bounding box in world space
  86579. */
  86580. readonly centerWorld: Vector3;
  86581. /**
  86582. * Gets the extend size in local space
  86583. */
  86584. readonly extendSize: Vector3;
  86585. /**
  86586. * Gets the extend size in world space
  86587. */
  86588. readonly extendSizeWorld: Vector3;
  86589. /**
  86590. * Gets the OBB (object bounding box) directions
  86591. */
  86592. readonly directions: Vector3[];
  86593. /**
  86594. * Gets the 8 vectors representing the bounding box in world space
  86595. */
  86596. readonly vectorsWorld: Vector3[];
  86597. /**
  86598. * Gets the minimum vector in world space
  86599. */
  86600. readonly minimumWorld: Vector3;
  86601. /**
  86602. * Gets the maximum vector in world space
  86603. */
  86604. readonly maximumWorld: Vector3;
  86605. /**
  86606. * Gets the minimum vector in local space
  86607. */
  86608. readonly minimum: Vector3;
  86609. /**
  86610. * Gets the maximum vector in local space
  86611. */
  86612. readonly maximum: Vector3;
  86613. private _worldMatrix;
  86614. private static readonly TmpVector3;
  86615. /**
  86616. * @hidden
  86617. */
  86618. _tag: number;
  86619. /**
  86620. * Creates a new bounding box
  86621. * @param min defines the minimum vector (in local space)
  86622. * @param max defines the maximum vector (in local space)
  86623. * @param worldMatrix defines the new world matrix
  86624. */
  86625. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86626. /**
  86627. * Recreates the entire bounding box from scratch as if we call the constructor in place
  86628. * @param min defines the new minimum vector (in local space)
  86629. * @param max defines the new maximum vector (in local space)
  86630. * @param worldMatrix defines the new world matrix
  86631. */
  86632. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86633. /**
  86634. * Scale the current bounding box by applying a scale factor
  86635. * @param factor defines the scale factor to apply
  86636. * @returns the current bounding box
  86637. */
  86638. scale(factor: number): BoundingBox;
  86639. /**
  86640. * Gets the world matrix of the bounding box
  86641. * @returns a matrix
  86642. */
  86643. getWorldMatrix(): DeepImmutable<Matrix>;
  86644. /** @hidden */
  86645. _update(world: DeepImmutable<Matrix>): void;
  86646. /**
  86647. * Tests if the bounding box is intersecting the frustum planes
  86648. * @param frustumPlanes defines the frustum planes to test
  86649. * @returns true if there is an intersection
  86650. */
  86651. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86652. /**
  86653. * Tests if the bounding box is entirely inside the frustum planes
  86654. * @param frustumPlanes defines the frustum planes to test
  86655. * @returns true if there is an inclusion
  86656. */
  86657. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86658. /**
  86659. * Tests if a point is inside the bounding box
  86660. * @param point defines the point to test
  86661. * @returns true if the point is inside the bounding box
  86662. */
  86663. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86664. /**
  86665. * Tests if the bounding box intersects with a bounding sphere
  86666. * @param sphere defines the sphere to test
  86667. * @returns true if there is an intersection
  86668. */
  86669. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  86670. /**
  86671. * Tests if the bounding box intersects with a box defined by a min and max vectors
  86672. * @param min defines the min vector to use
  86673. * @param max defines the max vector to use
  86674. * @returns true if there is an intersection
  86675. */
  86676. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  86677. /**
  86678. * Tests if two bounding boxes are intersections
  86679. * @param box0 defines the first box to test
  86680. * @param box1 defines the second box to test
  86681. * @returns true if there is an intersection
  86682. */
  86683. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  86684. /**
  86685. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  86686. * @param minPoint defines the minimum vector of the bounding box
  86687. * @param maxPoint defines the maximum vector of the bounding box
  86688. * @param sphereCenter defines the sphere center
  86689. * @param sphereRadius defines the sphere radius
  86690. * @returns true if there is an intersection
  86691. */
  86692. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  86693. /**
  86694. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  86695. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86696. * @param frustumPlanes defines the frustum planes to test
  86697. * @return true if there is an inclusion
  86698. */
  86699. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86700. /**
  86701. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  86702. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86703. * @param frustumPlanes defines the frustum planes to test
  86704. * @return true if there is an intersection
  86705. */
  86706. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86707. }
  86708. }
  86709. declare module BABYLON {
  86710. /** @hidden */
  86711. export class Collider {
  86712. /** Define if a collision was found */
  86713. collisionFound: boolean;
  86714. /**
  86715. * Define last intersection point in local space
  86716. */
  86717. intersectionPoint: Vector3;
  86718. /**
  86719. * Define last collided mesh
  86720. */
  86721. collidedMesh: Nullable<AbstractMesh>;
  86722. private _collisionPoint;
  86723. private _planeIntersectionPoint;
  86724. private _tempVector;
  86725. private _tempVector2;
  86726. private _tempVector3;
  86727. private _tempVector4;
  86728. private _edge;
  86729. private _baseToVertex;
  86730. private _destinationPoint;
  86731. private _slidePlaneNormal;
  86732. private _displacementVector;
  86733. /** @hidden */
  86734. _radius: Vector3;
  86735. /** @hidden */
  86736. _retry: number;
  86737. private _velocity;
  86738. private _basePoint;
  86739. private _epsilon;
  86740. /** @hidden */
  86741. _velocityWorldLength: number;
  86742. /** @hidden */
  86743. _basePointWorld: Vector3;
  86744. private _velocityWorld;
  86745. private _normalizedVelocity;
  86746. /** @hidden */
  86747. _initialVelocity: Vector3;
  86748. /** @hidden */
  86749. _initialPosition: Vector3;
  86750. private _nearestDistance;
  86751. private _collisionMask;
  86752. get collisionMask(): number;
  86753. set collisionMask(mask: number);
  86754. /**
  86755. * Gets the plane normal used to compute the sliding response (in local space)
  86756. */
  86757. get slidePlaneNormal(): Vector3;
  86758. /** @hidden */
  86759. _initialize(source: Vector3, dir: Vector3, e: number): void;
  86760. /** @hidden */
  86761. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  86762. /** @hidden */
  86763. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  86764. /** @hidden */
  86765. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86766. /** @hidden */
  86767. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86768. /** @hidden */
  86769. _getResponse(pos: Vector3, vel: Vector3): void;
  86770. }
  86771. }
  86772. declare module BABYLON {
  86773. /**
  86774. * Interface for cullable objects
  86775. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  86776. */
  86777. export interface ICullable {
  86778. /**
  86779. * Checks if the object or part of the object is in the frustum
  86780. * @param frustumPlanes Camera near/planes
  86781. * @returns true if the object is in frustum otherwise false
  86782. */
  86783. isInFrustum(frustumPlanes: Plane[]): boolean;
  86784. /**
  86785. * Checks if a cullable object (mesh...) is in the camera frustum
  86786. * Unlike isInFrustum this cheks the full bounding box
  86787. * @param frustumPlanes Camera near/planes
  86788. * @returns true if the object is in frustum otherwise false
  86789. */
  86790. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  86791. }
  86792. /**
  86793. * Info for a bounding data of a mesh
  86794. */
  86795. export class BoundingInfo implements ICullable {
  86796. /**
  86797. * Bounding box for the mesh
  86798. */
  86799. readonly boundingBox: BoundingBox;
  86800. /**
  86801. * Bounding sphere for the mesh
  86802. */
  86803. readonly boundingSphere: BoundingSphere;
  86804. private _isLocked;
  86805. private static readonly TmpVector3;
  86806. /**
  86807. * Constructs bounding info
  86808. * @param minimum min vector of the bounding box/sphere
  86809. * @param maximum max vector of the bounding box/sphere
  86810. * @param worldMatrix defines the new world matrix
  86811. */
  86812. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86813. /**
  86814. * Recreates the entire bounding info from scratch as if we call the constructor in place
  86815. * @param min defines the new minimum vector (in local space)
  86816. * @param max defines the new maximum vector (in local space)
  86817. * @param worldMatrix defines the new world matrix
  86818. */
  86819. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86820. /**
  86821. * min vector of the bounding box/sphere
  86822. */
  86823. get minimum(): Vector3;
  86824. /**
  86825. * max vector of the bounding box/sphere
  86826. */
  86827. get maximum(): Vector3;
  86828. /**
  86829. * If the info is locked and won't be updated to avoid perf overhead
  86830. */
  86831. get isLocked(): boolean;
  86832. set isLocked(value: boolean);
  86833. /**
  86834. * Updates the bounding sphere and box
  86835. * @param world world matrix to be used to update
  86836. */
  86837. update(world: DeepImmutable<Matrix>): void;
  86838. /**
  86839. * Recreate the bounding info to be centered around a specific point given a specific extend.
  86840. * @param center New center of the bounding info
  86841. * @param extend New extend of the bounding info
  86842. * @returns the current bounding info
  86843. */
  86844. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  86845. /**
  86846. * Scale the current bounding info by applying a scale factor
  86847. * @param factor defines the scale factor to apply
  86848. * @returns the current bounding info
  86849. */
  86850. scale(factor: number): BoundingInfo;
  86851. /**
  86852. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  86853. * @param frustumPlanes defines the frustum to test
  86854. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  86855. * @returns true if the bounding info is in the frustum planes
  86856. */
  86857. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  86858. /**
  86859. * Gets the world distance between the min and max points of the bounding box
  86860. */
  86861. get diagonalLength(): number;
  86862. /**
  86863. * Checks if a cullable object (mesh...) is in the camera frustum
  86864. * Unlike isInFrustum this cheks the full bounding box
  86865. * @param frustumPlanes Camera near/planes
  86866. * @returns true if the object is in frustum otherwise false
  86867. */
  86868. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86869. /** @hidden */
  86870. _checkCollision(collider: Collider): boolean;
  86871. /**
  86872. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  86873. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86874. * @param point the point to check intersection with
  86875. * @returns if the point intersects
  86876. */
  86877. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86878. /**
  86879. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  86880. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86881. * @param boundingInfo the bounding info to check intersection with
  86882. * @param precise if the intersection should be done using OBB
  86883. * @returns if the bounding info intersects
  86884. */
  86885. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  86886. }
  86887. }
  86888. declare module BABYLON {
  86889. /**
  86890. * Extracts minimum and maximum values from a list of indexed positions
  86891. * @param positions defines the positions to use
  86892. * @param indices defines the indices to the positions
  86893. * @param indexStart defines the start index
  86894. * @param indexCount defines the end index
  86895. * @param bias defines bias value to add to the result
  86896. * @return minimum and maximum values
  86897. */
  86898. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  86899. minimum: Vector3;
  86900. maximum: Vector3;
  86901. };
  86902. /**
  86903. * Extracts minimum and maximum values from a list of positions
  86904. * @param positions defines the positions to use
  86905. * @param start defines the start index in the positions array
  86906. * @param count defines the number of positions to handle
  86907. * @param bias defines bias value to add to the result
  86908. * @param stride defines the stride size to use (distance between two positions in the positions array)
  86909. * @return minimum and maximum values
  86910. */
  86911. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  86912. minimum: Vector3;
  86913. maximum: Vector3;
  86914. };
  86915. }
  86916. declare module BABYLON {
  86917. /** @hidden */
  86918. export class WebGLDataBuffer extends DataBuffer {
  86919. private _buffer;
  86920. constructor(resource: WebGLBuffer);
  86921. get underlyingResource(): any;
  86922. }
  86923. }
  86924. declare module BABYLON {
  86925. /** @hidden */
  86926. export class WebGLPipelineContext implements IPipelineContext {
  86927. engine: ThinEngine;
  86928. program: Nullable<WebGLProgram>;
  86929. context?: WebGLRenderingContext;
  86930. vertexShader?: WebGLShader;
  86931. fragmentShader?: WebGLShader;
  86932. isParallelCompiled: boolean;
  86933. onCompiled?: () => void;
  86934. transformFeedback?: WebGLTransformFeedback | null;
  86935. vertexCompilationError: Nullable<string>;
  86936. fragmentCompilationError: Nullable<string>;
  86937. programLinkError: Nullable<string>;
  86938. programValidationError: Nullable<string>;
  86939. get isAsync(): boolean;
  86940. get isReady(): boolean;
  86941. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  86942. _getVertexShaderCode(): string | null;
  86943. _getFragmentShaderCode(): string | null;
  86944. }
  86945. }
  86946. declare module BABYLON {
  86947. interface ThinEngine {
  86948. /**
  86949. * Create an uniform buffer
  86950. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86951. * @param elements defines the content of the uniform buffer
  86952. * @returns the webGL uniform buffer
  86953. */
  86954. createUniformBuffer(elements: FloatArray): DataBuffer;
  86955. /**
  86956. * Create a dynamic uniform buffer
  86957. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86958. * @param elements defines the content of the uniform buffer
  86959. * @returns the webGL uniform buffer
  86960. */
  86961. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  86962. /**
  86963. * Update an existing uniform buffer
  86964. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86965. * @param uniformBuffer defines the target uniform buffer
  86966. * @param elements defines the content to update
  86967. * @param offset defines the offset in the uniform buffer where update should start
  86968. * @param count defines the size of the data to update
  86969. */
  86970. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  86971. /**
  86972. * Bind an uniform buffer to the current webGL context
  86973. * @param buffer defines the buffer to bind
  86974. */
  86975. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  86976. /**
  86977. * Bind a buffer to the current webGL context at a given location
  86978. * @param buffer defines the buffer to bind
  86979. * @param location defines the index where to bind the buffer
  86980. */
  86981. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  86982. /**
  86983. * Bind a specific block at a given index in a specific shader program
  86984. * @param pipelineContext defines the pipeline context to use
  86985. * @param blockName defines the block name
  86986. * @param index defines the index where to bind the block
  86987. */
  86988. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  86989. }
  86990. }
  86991. declare module BABYLON {
  86992. /**
  86993. * Uniform buffer objects.
  86994. *
  86995. * Handles blocks of uniform on the GPU.
  86996. *
  86997. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  86998. *
  86999. * For more information, please refer to :
  87000. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87001. */
  87002. export class UniformBuffer {
  87003. private _engine;
  87004. private _buffer;
  87005. private _data;
  87006. private _bufferData;
  87007. private _dynamic?;
  87008. private _uniformLocations;
  87009. private _uniformSizes;
  87010. private _uniformLocationPointer;
  87011. private _needSync;
  87012. private _noUBO;
  87013. private _currentEffect;
  87014. /** @hidden */
  87015. _alreadyBound: boolean;
  87016. private static _MAX_UNIFORM_SIZE;
  87017. private static _tempBuffer;
  87018. /**
  87019. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  87020. * This is dynamic to allow compat with webgl 1 and 2.
  87021. * You will need to pass the name of the uniform as well as the value.
  87022. */
  87023. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  87024. /**
  87025. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  87026. * This is dynamic to allow compat with webgl 1 and 2.
  87027. * You will need to pass the name of the uniform as well as the value.
  87028. */
  87029. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  87030. /**
  87031. * Lambda to Update a single float in a uniform buffer.
  87032. * This is dynamic to allow compat with webgl 1 and 2.
  87033. * You will need to pass the name of the uniform as well as the value.
  87034. */
  87035. updateFloat: (name: string, x: number) => void;
  87036. /**
  87037. * Lambda to Update a vec2 of float in a uniform buffer.
  87038. * This is dynamic to allow compat with webgl 1 and 2.
  87039. * You will need to pass the name of the uniform as well as the value.
  87040. */
  87041. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  87042. /**
  87043. * Lambda to Update a vec3 of float in a uniform buffer.
  87044. * This is dynamic to allow compat with webgl 1 and 2.
  87045. * You will need to pass the name of the uniform as well as the value.
  87046. */
  87047. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  87048. /**
  87049. * Lambda to Update a vec4 of float in a uniform buffer.
  87050. * This is dynamic to allow compat with webgl 1 and 2.
  87051. * You will need to pass the name of the uniform as well as the value.
  87052. */
  87053. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  87054. /**
  87055. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  87056. * This is dynamic to allow compat with webgl 1 and 2.
  87057. * You will need to pass the name of the uniform as well as the value.
  87058. */
  87059. updateMatrix: (name: string, mat: Matrix) => void;
  87060. /**
  87061. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  87062. * This is dynamic to allow compat with webgl 1 and 2.
  87063. * You will need to pass the name of the uniform as well as the value.
  87064. */
  87065. updateVector3: (name: string, vector: Vector3) => void;
  87066. /**
  87067. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  87068. * This is dynamic to allow compat with webgl 1 and 2.
  87069. * You will need to pass the name of the uniform as well as the value.
  87070. */
  87071. updateVector4: (name: string, vector: Vector4) => void;
  87072. /**
  87073. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  87074. * This is dynamic to allow compat with webgl 1 and 2.
  87075. * You will need to pass the name of the uniform as well as the value.
  87076. */
  87077. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  87078. /**
  87079. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  87080. * This is dynamic to allow compat with webgl 1 and 2.
  87081. * You will need to pass the name of the uniform as well as the value.
  87082. */
  87083. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  87084. /**
  87085. * Instantiates a new Uniform buffer objects.
  87086. *
  87087. * Handles blocks of uniform on the GPU.
  87088. *
  87089. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87090. *
  87091. * For more information, please refer to :
  87092. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87093. * @param engine Define the engine the buffer is associated with
  87094. * @param data Define the data contained in the buffer
  87095. * @param dynamic Define if the buffer is updatable
  87096. */
  87097. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  87098. /**
  87099. * Indicates if the buffer is using the WebGL2 UBO implementation,
  87100. * or just falling back on setUniformXXX calls.
  87101. */
  87102. get useUbo(): boolean;
  87103. /**
  87104. * Indicates if the WebGL underlying uniform buffer is in sync
  87105. * with the javascript cache data.
  87106. */
  87107. get isSync(): boolean;
  87108. /**
  87109. * Indicates if the WebGL underlying uniform buffer is dynamic.
  87110. * Also, a dynamic UniformBuffer will disable cache verification and always
  87111. * update the underlying WebGL uniform buffer to the GPU.
  87112. * @returns if Dynamic, otherwise false
  87113. */
  87114. isDynamic(): boolean;
  87115. /**
  87116. * The data cache on JS side.
  87117. * @returns the underlying data as a float array
  87118. */
  87119. getData(): Float32Array;
  87120. /**
  87121. * The underlying WebGL Uniform buffer.
  87122. * @returns the webgl buffer
  87123. */
  87124. getBuffer(): Nullable<DataBuffer>;
  87125. /**
  87126. * std140 layout specifies how to align data within an UBO structure.
  87127. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  87128. * for specs.
  87129. */
  87130. private _fillAlignment;
  87131. /**
  87132. * Adds an uniform in the buffer.
  87133. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  87134. * for the layout to be correct !
  87135. * @param name Name of the uniform, as used in the uniform block in the shader.
  87136. * @param size Data size, or data directly.
  87137. */
  87138. addUniform(name: string, size: number | number[]): void;
  87139. /**
  87140. * Adds a Matrix 4x4 to the uniform buffer.
  87141. * @param name Name of the uniform, as used in the uniform block in the shader.
  87142. * @param mat A 4x4 matrix.
  87143. */
  87144. addMatrix(name: string, mat: Matrix): void;
  87145. /**
  87146. * Adds a vec2 to the uniform buffer.
  87147. * @param name Name of the uniform, as used in the uniform block in the shader.
  87148. * @param x Define the x component value of the vec2
  87149. * @param y Define the y component value of the vec2
  87150. */
  87151. addFloat2(name: string, x: number, y: number): void;
  87152. /**
  87153. * Adds a vec3 to the uniform buffer.
  87154. * @param name Name of the uniform, as used in the uniform block in the shader.
  87155. * @param x Define the x component value of the vec3
  87156. * @param y Define the y component value of the vec3
  87157. * @param z Define the z component value of the vec3
  87158. */
  87159. addFloat3(name: string, x: number, y: number, z: number): void;
  87160. /**
  87161. * Adds a vec3 to the uniform buffer.
  87162. * @param name Name of the uniform, as used in the uniform block in the shader.
  87163. * @param color Define the vec3 from a Color
  87164. */
  87165. addColor3(name: string, color: Color3): void;
  87166. /**
  87167. * Adds a vec4 to the uniform buffer.
  87168. * @param name Name of the uniform, as used in the uniform block in the shader.
  87169. * @param color Define the rgb components from a Color
  87170. * @param alpha Define the a component of the vec4
  87171. */
  87172. addColor4(name: string, color: Color3, alpha: number): void;
  87173. /**
  87174. * Adds a vec3 to the uniform buffer.
  87175. * @param name Name of the uniform, as used in the uniform block in the shader.
  87176. * @param vector Define the vec3 components from a Vector
  87177. */
  87178. addVector3(name: string, vector: Vector3): void;
  87179. /**
  87180. * Adds a Matrix 3x3 to the uniform buffer.
  87181. * @param name Name of the uniform, as used in the uniform block in the shader.
  87182. */
  87183. addMatrix3x3(name: string): void;
  87184. /**
  87185. * Adds a Matrix 2x2 to the uniform buffer.
  87186. * @param name Name of the uniform, as used in the uniform block in the shader.
  87187. */
  87188. addMatrix2x2(name: string): void;
  87189. /**
  87190. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  87191. */
  87192. create(): void;
  87193. /** @hidden */
  87194. _rebuild(): void;
  87195. /**
  87196. * Updates the WebGL Uniform Buffer on the GPU.
  87197. * If the `dynamic` flag is set to true, no cache comparison is done.
  87198. * Otherwise, the buffer will be updated only if the cache differs.
  87199. */
  87200. update(): void;
  87201. /**
  87202. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  87203. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87204. * @param data Define the flattened data
  87205. * @param size Define the size of the data.
  87206. */
  87207. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  87208. private _valueCache;
  87209. private _cacheMatrix;
  87210. private _updateMatrix3x3ForUniform;
  87211. private _updateMatrix3x3ForEffect;
  87212. private _updateMatrix2x2ForEffect;
  87213. private _updateMatrix2x2ForUniform;
  87214. private _updateFloatForEffect;
  87215. private _updateFloatForUniform;
  87216. private _updateFloat2ForEffect;
  87217. private _updateFloat2ForUniform;
  87218. private _updateFloat3ForEffect;
  87219. private _updateFloat3ForUniform;
  87220. private _updateFloat4ForEffect;
  87221. private _updateFloat4ForUniform;
  87222. private _updateMatrixForEffect;
  87223. private _updateMatrixForUniform;
  87224. private _updateVector3ForEffect;
  87225. private _updateVector3ForUniform;
  87226. private _updateVector4ForEffect;
  87227. private _updateVector4ForUniform;
  87228. private _updateColor3ForEffect;
  87229. private _updateColor3ForUniform;
  87230. private _updateColor4ForEffect;
  87231. private _updateColor4ForUniform;
  87232. /**
  87233. * Sets a sampler uniform on the effect.
  87234. * @param name Define the name of the sampler.
  87235. * @param texture Define the texture to set in the sampler
  87236. */
  87237. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  87238. /**
  87239. * Directly updates the value of the uniform in the cache AND on the GPU.
  87240. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87241. * @param data Define the flattened data
  87242. */
  87243. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  87244. /**
  87245. * Binds this uniform buffer to an effect.
  87246. * @param effect Define the effect to bind the buffer to
  87247. * @param name Name of the uniform block in the shader.
  87248. */
  87249. bindToEffect(effect: Effect, name: string): void;
  87250. /**
  87251. * Disposes the uniform buffer.
  87252. */
  87253. dispose(): void;
  87254. }
  87255. }
  87256. declare module BABYLON {
  87257. /**
  87258. * Enum that determines the text-wrapping mode to use.
  87259. */
  87260. export enum InspectableType {
  87261. /**
  87262. * Checkbox for booleans
  87263. */
  87264. Checkbox = 0,
  87265. /**
  87266. * Sliders for numbers
  87267. */
  87268. Slider = 1,
  87269. /**
  87270. * Vector3
  87271. */
  87272. Vector3 = 2,
  87273. /**
  87274. * Quaternions
  87275. */
  87276. Quaternion = 3,
  87277. /**
  87278. * Color3
  87279. */
  87280. Color3 = 4,
  87281. /**
  87282. * String
  87283. */
  87284. String = 5
  87285. }
  87286. /**
  87287. * Interface used to define custom inspectable properties.
  87288. * This interface is used by the inspector to display custom property grids
  87289. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  87290. */
  87291. export interface IInspectable {
  87292. /**
  87293. * Gets the label to display
  87294. */
  87295. label: string;
  87296. /**
  87297. * Gets the name of the property to edit
  87298. */
  87299. propertyName: string;
  87300. /**
  87301. * Gets the type of the editor to use
  87302. */
  87303. type: InspectableType;
  87304. /**
  87305. * Gets the minimum value of the property when using in "slider" mode
  87306. */
  87307. min?: number;
  87308. /**
  87309. * Gets the maximum value of the property when using in "slider" mode
  87310. */
  87311. max?: number;
  87312. /**
  87313. * Gets the setp to use when using in "slider" mode
  87314. */
  87315. step?: number;
  87316. }
  87317. }
  87318. declare module BABYLON {
  87319. /**
  87320. * Class used to provide helper for timing
  87321. */
  87322. export class TimingTools {
  87323. /**
  87324. * Polyfill for setImmediate
  87325. * @param action defines the action to execute after the current execution block
  87326. */
  87327. static SetImmediate(action: () => void): void;
  87328. }
  87329. }
  87330. declare module BABYLON {
  87331. /**
  87332. * Class used to enable instatition of objects by class name
  87333. */
  87334. export class InstantiationTools {
  87335. /**
  87336. * Use this object to register external classes like custom textures or material
  87337. * to allow the laoders to instantiate them
  87338. */
  87339. static RegisteredExternalClasses: {
  87340. [key: string]: Object;
  87341. };
  87342. /**
  87343. * Tries to instantiate a new object from a given class name
  87344. * @param className defines the class name to instantiate
  87345. * @returns the new object or null if the system was not able to do the instantiation
  87346. */
  87347. static Instantiate(className: string): any;
  87348. }
  87349. }
  87350. declare module BABYLON {
  87351. /**
  87352. * Define options used to create a depth texture
  87353. */
  87354. export class DepthTextureCreationOptions {
  87355. /** Specifies whether or not a stencil should be allocated in the texture */
  87356. generateStencil?: boolean;
  87357. /** Specifies whether or not bilinear filtering is enable on the texture */
  87358. bilinearFiltering?: boolean;
  87359. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  87360. comparisonFunction?: number;
  87361. /** Specifies if the created texture is a cube texture */
  87362. isCube?: boolean;
  87363. }
  87364. }
  87365. declare module BABYLON {
  87366. interface ThinEngine {
  87367. /**
  87368. * Creates a depth stencil cube texture.
  87369. * This is only available in WebGL 2.
  87370. * @param size The size of face edge in the cube texture.
  87371. * @param options The options defining the cube texture.
  87372. * @returns The cube texture
  87373. */
  87374. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  87375. /**
  87376. * Creates a cube texture
  87377. * @param rootUrl defines the url where the files to load is located
  87378. * @param scene defines the current scene
  87379. * @param files defines the list of files to load (1 per face)
  87380. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87381. * @param onLoad defines an optional callback raised when the texture is loaded
  87382. * @param onError defines an optional callback raised if there is an issue to load the texture
  87383. * @param format defines the format of the data
  87384. * @param forcedExtension defines the extension to use to pick the right loader
  87385. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87386. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87387. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87388. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  87389. * @returns the cube texture as an InternalTexture
  87390. */
  87391. 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;
  87392. /**
  87393. * Creates a cube texture
  87394. * @param rootUrl defines the url where the files to load is located
  87395. * @param scene defines the current scene
  87396. * @param files defines the list of files to load (1 per face)
  87397. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87398. * @param onLoad defines an optional callback raised when the texture is loaded
  87399. * @param onError defines an optional callback raised if there is an issue to load the texture
  87400. * @param format defines the format of the data
  87401. * @param forcedExtension defines the extension to use to pick the right loader
  87402. * @returns the cube texture as an InternalTexture
  87403. */
  87404. 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;
  87405. /**
  87406. * Creates a cube texture
  87407. * @param rootUrl defines the url where the files to load is located
  87408. * @param scene defines the current scene
  87409. * @param files defines the list of files to load (1 per face)
  87410. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87411. * @param onLoad defines an optional callback raised when the texture is loaded
  87412. * @param onError defines an optional callback raised if there is an issue to load the texture
  87413. * @param format defines the format of the data
  87414. * @param forcedExtension defines the extension to use to pick the right loader
  87415. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87416. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87417. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87418. * @returns the cube texture as an InternalTexture
  87419. */
  87420. 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;
  87421. /** @hidden */
  87422. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  87423. /** @hidden */
  87424. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  87425. /** @hidden */
  87426. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87427. /** @hidden */
  87428. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87429. /**
  87430. * @hidden
  87431. */
  87432. _setCubeMapTextureParams(loadMipmap: boolean): void;
  87433. }
  87434. }
  87435. declare module BABYLON {
  87436. /**
  87437. * Class for creating a cube texture
  87438. */
  87439. export class CubeTexture extends BaseTexture {
  87440. private _delayedOnLoad;
  87441. /**
  87442. * Observable triggered once the texture has been loaded.
  87443. */
  87444. onLoadObservable: Observable<CubeTexture>;
  87445. /**
  87446. * The url of the texture
  87447. */
  87448. url: string;
  87449. /**
  87450. * Gets or sets the center of the bounding box associated with the cube texture.
  87451. * It must define where the camera used to render the texture was set
  87452. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87453. */
  87454. boundingBoxPosition: Vector3;
  87455. private _boundingBoxSize;
  87456. /**
  87457. * Gets or sets the size of the bounding box associated with the cube texture
  87458. * When defined, the cubemap will switch to local mode
  87459. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  87460. * @example https://www.babylonjs-playground.com/#RNASML
  87461. */
  87462. set boundingBoxSize(value: Vector3);
  87463. /**
  87464. * Returns the bounding box size
  87465. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87466. */
  87467. get boundingBoxSize(): Vector3;
  87468. protected _rotationY: number;
  87469. /**
  87470. * Sets texture matrix rotation angle around Y axis in radians.
  87471. */
  87472. set rotationY(value: number);
  87473. /**
  87474. * Gets texture matrix rotation angle around Y axis radians.
  87475. */
  87476. get rotationY(): number;
  87477. /**
  87478. * Are mip maps generated for this texture or not.
  87479. */
  87480. get noMipmap(): boolean;
  87481. private _noMipmap;
  87482. private _files;
  87483. protected _forcedExtension: Nullable<string>;
  87484. private _extensions;
  87485. private _textureMatrix;
  87486. private _format;
  87487. private _createPolynomials;
  87488. /**
  87489. * Creates a cube texture from an array of image urls
  87490. * @param files defines an array of image urls
  87491. * @param scene defines the hosting scene
  87492. * @param noMipmap specifies if mip maps are not used
  87493. * @returns a cube texture
  87494. */
  87495. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  87496. /**
  87497. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  87498. * @param url defines the url of the prefiltered texture
  87499. * @param scene defines the scene the texture is attached to
  87500. * @param forcedExtension defines the extension of the file if different from the url
  87501. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87502. * @return the prefiltered texture
  87503. */
  87504. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  87505. /**
  87506. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  87507. * as prefiltered data.
  87508. * @param rootUrl defines the url of the texture or the root name of the six images
  87509. * @param null defines the scene or engine the texture is attached to
  87510. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  87511. * @param noMipmap defines if mipmaps should be created or not
  87512. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  87513. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  87514. * @param onError defines a callback triggered in case of error during load
  87515. * @param format defines the internal format to use for the texture once loaded
  87516. * @param prefiltered defines whether or not the texture is created from prefiltered data
  87517. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  87518. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87519. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87520. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87521. * @return the cube texture
  87522. */
  87523. 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);
  87524. /**
  87525. * Get the current class name of the texture useful for serialization or dynamic coding.
  87526. * @returns "CubeTexture"
  87527. */
  87528. getClassName(): string;
  87529. /**
  87530. * Update the url (and optional buffer) of this texture if url was null during construction.
  87531. * @param url the url of the texture
  87532. * @param forcedExtension defines the extension to use
  87533. * @param onLoad callback called when the texture is loaded (defaults to null)
  87534. * @param prefiltered Defines whether the updated texture is prefiltered or not
  87535. */
  87536. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  87537. /**
  87538. * Delays loading of the cube texture
  87539. * @param forcedExtension defines the extension to use
  87540. */
  87541. delayLoad(forcedExtension?: string): void;
  87542. /**
  87543. * Returns the reflection texture matrix
  87544. * @returns the reflection texture matrix
  87545. */
  87546. getReflectionTextureMatrix(): Matrix;
  87547. /**
  87548. * Sets the reflection texture matrix
  87549. * @param value Reflection texture matrix
  87550. */
  87551. setReflectionTextureMatrix(value: Matrix): void;
  87552. /**
  87553. * Parses text to create a cube texture
  87554. * @param parsedTexture define the serialized text to read from
  87555. * @param scene defines the hosting scene
  87556. * @param rootUrl defines the root url of the cube texture
  87557. * @returns a cube texture
  87558. */
  87559. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  87560. /**
  87561. * Makes a clone, or deep copy, of the cube texture
  87562. * @returns a new cube texture
  87563. */
  87564. clone(): CubeTexture;
  87565. }
  87566. }
  87567. declare module BABYLON {
  87568. /**
  87569. * Manages the defines for the Material
  87570. */
  87571. export class MaterialDefines {
  87572. /** @hidden */
  87573. protected _keys: string[];
  87574. private _isDirty;
  87575. /** @hidden */
  87576. _renderId: number;
  87577. /** @hidden */
  87578. _areLightsDirty: boolean;
  87579. /** @hidden */
  87580. _areLightsDisposed: boolean;
  87581. /** @hidden */
  87582. _areAttributesDirty: boolean;
  87583. /** @hidden */
  87584. _areTexturesDirty: boolean;
  87585. /** @hidden */
  87586. _areFresnelDirty: boolean;
  87587. /** @hidden */
  87588. _areMiscDirty: boolean;
  87589. /** @hidden */
  87590. _areImageProcessingDirty: boolean;
  87591. /** @hidden */
  87592. _normals: boolean;
  87593. /** @hidden */
  87594. _uvs: boolean;
  87595. /** @hidden */
  87596. _needNormals: boolean;
  87597. /** @hidden */
  87598. _needUVs: boolean;
  87599. [id: string]: any;
  87600. /**
  87601. * Specifies if the material needs to be re-calculated
  87602. */
  87603. get isDirty(): boolean;
  87604. /**
  87605. * Marks the material to indicate that it has been re-calculated
  87606. */
  87607. markAsProcessed(): void;
  87608. /**
  87609. * Marks the material to indicate that it needs to be re-calculated
  87610. */
  87611. markAsUnprocessed(): void;
  87612. /**
  87613. * Marks the material to indicate all of its defines need to be re-calculated
  87614. */
  87615. markAllAsDirty(): void;
  87616. /**
  87617. * Marks the material to indicate that image processing needs to be re-calculated
  87618. */
  87619. markAsImageProcessingDirty(): void;
  87620. /**
  87621. * Marks the material to indicate the lights need to be re-calculated
  87622. * @param disposed Defines whether the light is dirty due to dispose or not
  87623. */
  87624. markAsLightDirty(disposed?: boolean): void;
  87625. /**
  87626. * Marks the attribute state as changed
  87627. */
  87628. markAsAttributesDirty(): void;
  87629. /**
  87630. * Marks the texture state as changed
  87631. */
  87632. markAsTexturesDirty(): void;
  87633. /**
  87634. * Marks the fresnel state as changed
  87635. */
  87636. markAsFresnelDirty(): void;
  87637. /**
  87638. * Marks the misc state as changed
  87639. */
  87640. markAsMiscDirty(): void;
  87641. /**
  87642. * Rebuilds the material defines
  87643. */
  87644. rebuild(): void;
  87645. /**
  87646. * Specifies if two material defines are equal
  87647. * @param other - A material define instance to compare to
  87648. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  87649. */
  87650. isEqual(other: MaterialDefines): boolean;
  87651. /**
  87652. * Clones this instance's defines to another instance
  87653. * @param other - material defines to clone values to
  87654. */
  87655. cloneTo(other: MaterialDefines): void;
  87656. /**
  87657. * Resets the material define values
  87658. */
  87659. reset(): void;
  87660. /**
  87661. * Converts the material define values to a string
  87662. * @returns - String of material define information
  87663. */
  87664. toString(): string;
  87665. }
  87666. }
  87667. declare module BABYLON {
  87668. /**
  87669. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  87670. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  87671. * 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;
  87672. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  87673. */
  87674. export class ColorCurves {
  87675. private _dirty;
  87676. private _tempColor;
  87677. private _globalCurve;
  87678. private _highlightsCurve;
  87679. private _midtonesCurve;
  87680. private _shadowsCurve;
  87681. private _positiveCurve;
  87682. private _negativeCurve;
  87683. private _globalHue;
  87684. private _globalDensity;
  87685. private _globalSaturation;
  87686. private _globalExposure;
  87687. /**
  87688. * Gets the global Hue value.
  87689. * 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).
  87690. */
  87691. get globalHue(): number;
  87692. /**
  87693. * Sets the global Hue value.
  87694. * 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).
  87695. */
  87696. set globalHue(value: number);
  87697. /**
  87698. * Gets the global Density value.
  87699. * 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.
  87700. * Values less than zero provide a filter of opposite hue.
  87701. */
  87702. get globalDensity(): number;
  87703. /**
  87704. * Sets the global Density value.
  87705. * 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.
  87706. * Values less than zero provide a filter of opposite hue.
  87707. */
  87708. set globalDensity(value: number);
  87709. /**
  87710. * Gets the global Saturation value.
  87711. * 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.
  87712. */
  87713. get globalSaturation(): number;
  87714. /**
  87715. * Sets the global Saturation value.
  87716. * 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.
  87717. */
  87718. set globalSaturation(value: number);
  87719. /**
  87720. * Gets the global Exposure value.
  87721. * 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.
  87722. */
  87723. get globalExposure(): number;
  87724. /**
  87725. * Sets the global Exposure value.
  87726. * 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.
  87727. */
  87728. set globalExposure(value: number);
  87729. private _highlightsHue;
  87730. private _highlightsDensity;
  87731. private _highlightsSaturation;
  87732. private _highlightsExposure;
  87733. /**
  87734. * Gets the highlights Hue value.
  87735. * 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).
  87736. */
  87737. get highlightsHue(): number;
  87738. /**
  87739. * Sets the highlights Hue value.
  87740. * 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).
  87741. */
  87742. set highlightsHue(value: number);
  87743. /**
  87744. * Gets the highlights Density value.
  87745. * 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.
  87746. * Values less than zero provide a filter of opposite hue.
  87747. */
  87748. get highlightsDensity(): number;
  87749. /**
  87750. * Sets the highlights Density value.
  87751. * 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.
  87752. * Values less than zero provide a filter of opposite hue.
  87753. */
  87754. set highlightsDensity(value: number);
  87755. /**
  87756. * Gets the highlights Saturation value.
  87757. * 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.
  87758. */
  87759. get highlightsSaturation(): number;
  87760. /**
  87761. * Sets the highlights Saturation value.
  87762. * 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.
  87763. */
  87764. set highlightsSaturation(value: number);
  87765. /**
  87766. * Gets the highlights Exposure value.
  87767. * 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.
  87768. */
  87769. get highlightsExposure(): number;
  87770. /**
  87771. * Sets the highlights Exposure value.
  87772. * 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.
  87773. */
  87774. set highlightsExposure(value: number);
  87775. private _midtonesHue;
  87776. private _midtonesDensity;
  87777. private _midtonesSaturation;
  87778. private _midtonesExposure;
  87779. /**
  87780. * Gets the midtones Hue value.
  87781. * 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).
  87782. */
  87783. get midtonesHue(): number;
  87784. /**
  87785. * Sets the midtones Hue value.
  87786. * 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).
  87787. */
  87788. set midtonesHue(value: number);
  87789. /**
  87790. * Gets the midtones Density value.
  87791. * 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.
  87792. * Values less than zero provide a filter of opposite hue.
  87793. */
  87794. get midtonesDensity(): number;
  87795. /**
  87796. * Sets the midtones Density value.
  87797. * 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.
  87798. * Values less than zero provide a filter of opposite hue.
  87799. */
  87800. set midtonesDensity(value: number);
  87801. /**
  87802. * Gets the midtones Saturation value.
  87803. * 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.
  87804. */
  87805. get midtonesSaturation(): number;
  87806. /**
  87807. * Sets the midtones Saturation value.
  87808. * 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.
  87809. */
  87810. set midtonesSaturation(value: number);
  87811. /**
  87812. * Gets the midtones Exposure value.
  87813. * 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.
  87814. */
  87815. get midtonesExposure(): number;
  87816. /**
  87817. * Sets the midtones Exposure value.
  87818. * 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.
  87819. */
  87820. set midtonesExposure(value: number);
  87821. private _shadowsHue;
  87822. private _shadowsDensity;
  87823. private _shadowsSaturation;
  87824. private _shadowsExposure;
  87825. /**
  87826. * Gets the shadows Hue value.
  87827. * 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).
  87828. */
  87829. get shadowsHue(): number;
  87830. /**
  87831. * Sets the shadows Hue value.
  87832. * 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).
  87833. */
  87834. set shadowsHue(value: number);
  87835. /**
  87836. * Gets the shadows Density value.
  87837. * 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.
  87838. * Values less than zero provide a filter of opposite hue.
  87839. */
  87840. get shadowsDensity(): number;
  87841. /**
  87842. * Sets the shadows Density value.
  87843. * 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.
  87844. * Values less than zero provide a filter of opposite hue.
  87845. */
  87846. set shadowsDensity(value: number);
  87847. /**
  87848. * Gets the shadows Saturation value.
  87849. * 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.
  87850. */
  87851. get shadowsSaturation(): number;
  87852. /**
  87853. * Sets the shadows Saturation value.
  87854. * 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.
  87855. */
  87856. set shadowsSaturation(value: number);
  87857. /**
  87858. * Gets the shadows Exposure value.
  87859. * 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.
  87860. */
  87861. get shadowsExposure(): number;
  87862. /**
  87863. * Sets the shadows Exposure value.
  87864. * 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.
  87865. */
  87866. set shadowsExposure(value: number);
  87867. /**
  87868. * Returns the class name
  87869. * @returns The class name
  87870. */
  87871. getClassName(): string;
  87872. /**
  87873. * Binds the color curves to the shader.
  87874. * @param colorCurves The color curve to bind
  87875. * @param effect The effect to bind to
  87876. * @param positiveUniform The positive uniform shader parameter
  87877. * @param neutralUniform The neutral uniform shader parameter
  87878. * @param negativeUniform The negative uniform shader parameter
  87879. */
  87880. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  87881. /**
  87882. * Prepare the list of uniforms associated with the ColorCurves effects.
  87883. * @param uniformsList The list of uniforms used in the effect
  87884. */
  87885. static PrepareUniforms(uniformsList: string[]): void;
  87886. /**
  87887. * Returns color grading data based on a hue, density, saturation and exposure value.
  87888. * @param filterHue The hue of the color filter.
  87889. * @param filterDensity The density of the color filter.
  87890. * @param saturation The saturation.
  87891. * @param exposure The exposure.
  87892. * @param result The result data container.
  87893. */
  87894. private getColorGradingDataToRef;
  87895. /**
  87896. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  87897. * @param value The input slider value in range [-100,100].
  87898. * @returns Adjusted value.
  87899. */
  87900. private static applyColorGradingSliderNonlinear;
  87901. /**
  87902. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  87903. * @param hue The hue (H) input.
  87904. * @param saturation The saturation (S) input.
  87905. * @param brightness The brightness (B) input.
  87906. * @result An RGBA color represented as Vector4.
  87907. */
  87908. private static fromHSBToRef;
  87909. /**
  87910. * Returns a value clamped between min and max
  87911. * @param value The value to clamp
  87912. * @param min The minimum of value
  87913. * @param max The maximum of value
  87914. * @returns The clamped value.
  87915. */
  87916. private static clamp;
  87917. /**
  87918. * Clones the current color curve instance.
  87919. * @return The cloned curves
  87920. */
  87921. clone(): ColorCurves;
  87922. /**
  87923. * Serializes the current color curve instance to a json representation.
  87924. * @return a JSON representation
  87925. */
  87926. serialize(): any;
  87927. /**
  87928. * Parses the color curve from a json representation.
  87929. * @param source the JSON source to parse
  87930. * @return The parsed curves
  87931. */
  87932. static Parse(source: any): ColorCurves;
  87933. }
  87934. }
  87935. declare module BABYLON {
  87936. /**
  87937. * Interface to follow in your material defines to integrate easily the
  87938. * Image proccessing functions.
  87939. * @hidden
  87940. */
  87941. export interface IImageProcessingConfigurationDefines {
  87942. IMAGEPROCESSING: boolean;
  87943. VIGNETTE: boolean;
  87944. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87945. VIGNETTEBLENDMODEOPAQUE: boolean;
  87946. TONEMAPPING: boolean;
  87947. TONEMAPPING_ACES: boolean;
  87948. CONTRAST: boolean;
  87949. EXPOSURE: boolean;
  87950. COLORCURVES: boolean;
  87951. COLORGRADING: boolean;
  87952. COLORGRADING3D: boolean;
  87953. SAMPLER3DGREENDEPTH: boolean;
  87954. SAMPLER3DBGRMAP: boolean;
  87955. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87956. }
  87957. /**
  87958. * @hidden
  87959. */
  87960. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  87961. IMAGEPROCESSING: boolean;
  87962. VIGNETTE: boolean;
  87963. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87964. VIGNETTEBLENDMODEOPAQUE: boolean;
  87965. TONEMAPPING: boolean;
  87966. TONEMAPPING_ACES: boolean;
  87967. CONTRAST: boolean;
  87968. COLORCURVES: boolean;
  87969. COLORGRADING: boolean;
  87970. COLORGRADING3D: boolean;
  87971. SAMPLER3DGREENDEPTH: boolean;
  87972. SAMPLER3DBGRMAP: boolean;
  87973. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87974. EXPOSURE: boolean;
  87975. constructor();
  87976. }
  87977. /**
  87978. * This groups together the common properties used for image processing either in direct forward pass
  87979. * or through post processing effect depending on the use of the image processing pipeline in your scene
  87980. * or not.
  87981. */
  87982. export class ImageProcessingConfiguration {
  87983. /**
  87984. * Default tone mapping applied in BabylonJS.
  87985. */
  87986. static readonly TONEMAPPING_STANDARD: number;
  87987. /**
  87988. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  87989. * to other engines rendering to increase portability.
  87990. */
  87991. static readonly TONEMAPPING_ACES: number;
  87992. /**
  87993. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  87994. */
  87995. colorCurves: Nullable<ColorCurves>;
  87996. private _colorCurvesEnabled;
  87997. /**
  87998. * Gets wether the color curves effect is enabled.
  87999. */
  88000. get colorCurvesEnabled(): boolean;
  88001. /**
  88002. * Sets wether the color curves effect is enabled.
  88003. */
  88004. set colorCurvesEnabled(value: boolean);
  88005. private _colorGradingTexture;
  88006. /**
  88007. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88008. */
  88009. get colorGradingTexture(): Nullable<BaseTexture>;
  88010. /**
  88011. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88012. */
  88013. set colorGradingTexture(value: Nullable<BaseTexture>);
  88014. private _colorGradingEnabled;
  88015. /**
  88016. * Gets wether the color grading effect is enabled.
  88017. */
  88018. get colorGradingEnabled(): boolean;
  88019. /**
  88020. * Sets wether the color grading effect is enabled.
  88021. */
  88022. set colorGradingEnabled(value: boolean);
  88023. private _colorGradingWithGreenDepth;
  88024. /**
  88025. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  88026. */
  88027. get colorGradingWithGreenDepth(): boolean;
  88028. /**
  88029. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  88030. */
  88031. set colorGradingWithGreenDepth(value: boolean);
  88032. private _colorGradingBGR;
  88033. /**
  88034. * Gets wether the color grading texture contains BGR values.
  88035. */
  88036. get colorGradingBGR(): boolean;
  88037. /**
  88038. * Sets wether the color grading texture contains BGR values.
  88039. */
  88040. set colorGradingBGR(value: boolean);
  88041. /** @hidden */
  88042. _exposure: number;
  88043. /**
  88044. * Gets the Exposure used in the effect.
  88045. */
  88046. get exposure(): number;
  88047. /**
  88048. * Sets the Exposure used in the effect.
  88049. */
  88050. set exposure(value: number);
  88051. private _toneMappingEnabled;
  88052. /**
  88053. * Gets wether the tone mapping effect is enabled.
  88054. */
  88055. get toneMappingEnabled(): boolean;
  88056. /**
  88057. * Sets wether the tone mapping effect is enabled.
  88058. */
  88059. set toneMappingEnabled(value: boolean);
  88060. private _toneMappingType;
  88061. /**
  88062. * Gets the type of tone mapping effect.
  88063. */
  88064. get toneMappingType(): number;
  88065. /**
  88066. * Sets the type of tone mapping effect used in BabylonJS.
  88067. */
  88068. set toneMappingType(value: number);
  88069. protected _contrast: number;
  88070. /**
  88071. * Gets the contrast used in the effect.
  88072. */
  88073. get contrast(): number;
  88074. /**
  88075. * Sets the contrast used in the effect.
  88076. */
  88077. set contrast(value: number);
  88078. /**
  88079. * Vignette stretch size.
  88080. */
  88081. vignetteStretch: number;
  88082. /**
  88083. * Vignette centre X Offset.
  88084. */
  88085. vignetteCentreX: number;
  88086. /**
  88087. * Vignette centre Y Offset.
  88088. */
  88089. vignetteCentreY: number;
  88090. /**
  88091. * Vignette weight or intensity of the vignette effect.
  88092. */
  88093. vignetteWeight: number;
  88094. /**
  88095. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  88096. * if vignetteEnabled is set to true.
  88097. */
  88098. vignetteColor: Color4;
  88099. /**
  88100. * Camera field of view used by the Vignette effect.
  88101. */
  88102. vignetteCameraFov: number;
  88103. private _vignetteBlendMode;
  88104. /**
  88105. * Gets the vignette blend mode allowing different kind of effect.
  88106. */
  88107. get vignetteBlendMode(): number;
  88108. /**
  88109. * Sets the vignette blend mode allowing different kind of effect.
  88110. */
  88111. set vignetteBlendMode(value: number);
  88112. private _vignetteEnabled;
  88113. /**
  88114. * Gets wether the vignette effect is enabled.
  88115. */
  88116. get vignetteEnabled(): boolean;
  88117. /**
  88118. * Sets wether the vignette effect is enabled.
  88119. */
  88120. set vignetteEnabled(value: boolean);
  88121. private _applyByPostProcess;
  88122. /**
  88123. * Gets wether the image processing is applied through a post process or not.
  88124. */
  88125. get applyByPostProcess(): boolean;
  88126. /**
  88127. * Sets wether the image processing is applied through a post process or not.
  88128. */
  88129. set applyByPostProcess(value: boolean);
  88130. private _isEnabled;
  88131. /**
  88132. * Gets wether the image processing is enabled or not.
  88133. */
  88134. get isEnabled(): boolean;
  88135. /**
  88136. * Sets wether the image processing is enabled or not.
  88137. */
  88138. set isEnabled(value: boolean);
  88139. /**
  88140. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  88141. */
  88142. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  88143. /**
  88144. * Method called each time the image processing information changes requires to recompile the effect.
  88145. */
  88146. protected _updateParameters(): void;
  88147. /**
  88148. * Gets the current class name.
  88149. * @return "ImageProcessingConfiguration"
  88150. */
  88151. getClassName(): string;
  88152. /**
  88153. * Prepare the list of uniforms associated with the Image Processing effects.
  88154. * @param uniforms The list of uniforms used in the effect
  88155. * @param defines the list of defines currently in use
  88156. */
  88157. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  88158. /**
  88159. * Prepare the list of samplers associated with the Image Processing effects.
  88160. * @param samplersList The list of uniforms used in the effect
  88161. * @param defines the list of defines currently in use
  88162. */
  88163. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  88164. /**
  88165. * Prepare the list of defines associated to the shader.
  88166. * @param defines the list of defines to complete
  88167. * @param forPostProcess Define if we are currently in post process mode or not
  88168. */
  88169. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  88170. /**
  88171. * Returns true if all the image processing information are ready.
  88172. * @returns True if ready, otherwise, false
  88173. */
  88174. isReady(): boolean;
  88175. /**
  88176. * Binds the image processing to the shader.
  88177. * @param effect The effect to bind to
  88178. * @param overrideAspectRatio Override the aspect ratio of the effect
  88179. */
  88180. bind(effect: Effect, overrideAspectRatio?: number): void;
  88181. /**
  88182. * Clones the current image processing instance.
  88183. * @return The cloned image processing
  88184. */
  88185. clone(): ImageProcessingConfiguration;
  88186. /**
  88187. * Serializes the current image processing instance to a json representation.
  88188. * @return a JSON representation
  88189. */
  88190. serialize(): any;
  88191. /**
  88192. * Parses the image processing from a json representation.
  88193. * @param source the JSON source to parse
  88194. * @return The parsed image processing
  88195. */
  88196. static Parse(source: any): ImageProcessingConfiguration;
  88197. private static _VIGNETTEMODE_MULTIPLY;
  88198. private static _VIGNETTEMODE_OPAQUE;
  88199. /**
  88200. * Used to apply the vignette as a mix with the pixel color.
  88201. */
  88202. static get VIGNETTEMODE_MULTIPLY(): number;
  88203. /**
  88204. * Used to apply the vignette as a replacement of the pixel color.
  88205. */
  88206. static get VIGNETTEMODE_OPAQUE(): number;
  88207. }
  88208. }
  88209. declare module BABYLON {
  88210. /** @hidden */
  88211. export var postprocessVertexShader: {
  88212. name: string;
  88213. shader: string;
  88214. };
  88215. }
  88216. declare module BABYLON {
  88217. interface ThinEngine {
  88218. /**
  88219. * Creates a new render target texture
  88220. * @param size defines the size of the texture
  88221. * @param options defines the options used to create the texture
  88222. * @returns a new render target texture stored in an InternalTexture
  88223. */
  88224. createRenderTargetTexture(size: number | {
  88225. width: number;
  88226. height: number;
  88227. layers?: number;
  88228. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  88229. /**
  88230. * Creates a depth stencil texture.
  88231. * This is only available in WebGL 2 or with the depth texture extension available.
  88232. * @param size The size of face edge in the texture.
  88233. * @param options The options defining the texture.
  88234. * @returns The texture
  88235. */
  88236. createDepthStencilTexture(size: number | {
  88237. width: number;
  88238. height: number;
  88239. layers?: number;
  88240. }, options: DepthTextureCreationOptions): InternalTexture;
  88241. /** @hidden */
  88242. _createDepthStencilTexture(size: number | {
  88243. width: number;
  88244. height: number;
  88245. layers?: number;
  88246. }, options: DepthTextureCreationOptions): InternalTexture;
  88247. }
  88248. }
  88249. declare module BABYLON {
  88250. /**
  88251. * Defines the kind of connection point for node based material
  88252. */
  88253. export enum NodeMaterialBlockConnectionPointTypes {
  88254. /** Float */
  88255. Float = 1,
  88256. /** Int */
  88257. Int = 2,
  88258. /** Vector2 */
  88259. Vector2 = 4,
  88260. /** Vector3 */
  88261. Vector3 = 8,
  88262. /** Vector4 */
  88263. Vector4 = 16,
  88264. /** Color3 */
  88265. Color3 = 32,
  88266. /** Color4 */
  88267. Color4 = 64,
  88268. /** Matrix */
  88269. Matrix = 128,
  88270. /** Custom object */
  88271. Object = 256,
  88272. /** Detect type based on connection */
  88273. AutoDetect = 1024,
  88274. /** Output type that will be defined by input type */
  88275. BasedOnInput = 2048
  88276. }
  88277. }
  88278. declare module BABYLON {
  88279. /**
  88280. * Enum used to define the target of a block
  88281. */
  88282. export enum NodeMaterialBlockTargets {
  88283. /** Vertex shader */
  88284. Vertex = 1,
  88285. /** Fragment shader */
  88286. Fragment = 2,
  88287. /** Neutral */
  88288. Neutral = 4,
  88289. /** Vertex and Fragment */
  88290. VertexAndFragment = 3
  88291. }
  88292. }
  88293. declare module BABYLON {
  88294. /**
  88295. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  88296. */
  88297. export enum NodeMaterialBlockConnectionPointMode {
  88298. /** Value is an uniform */
  88299. Uniform = 0,
  88300. /** Value is a mesh attribute */
  88301. Attribute = 1,
  88302. /** Value is a varying between vertex and fragment shaders */
  88303. Varying = 2,
  88304. /** Mode is undefined */
  88305. Undefined = 3
  88306. }
  88307. }
  88308. declare module BABYLON {
  88309. /**
  88310. * Enum used to define system values e.g. values automatically provided by the system
  88311. */
  88312. export enum NodeMaterialSystemValues {
  88313. /** World */
  88314. World = 1,
  88315. /** View */
  88316. View = 2,
  88317. /** Projection */
  88318. Projection = 3,
  88319. /** ViewProjection */
  88320. ViewProjection = 4,
  88321. /** WorldView */
  88322. WorldView = 5,
  88323. /** WorldViewProjection */
  88324. WorldViewProjection = 6,
  88325. /** CameraPosition */
  88326. CameraPosition = 7,
  88327. /** Fog Color */
  88328. FogColor = 8,
  88329. /** Delta time */
  88330. DeltaTime = 9
  88331. }
  88332. }
  88333. declare module BABYLON {
  88334. /** Defines supported spaces */
  88335. export enum Space {
  88336. /** Local (object) space */
  88337. LOCAL = 0,
  88338. /** World space */
  88339. WORLD = 1,
  88340. /** Bone space */
  88341. BONE = 2
  88342. }
  88343. /** Defines the 3 main axes */
  88344. export class Axis {
  88345. /** X axis */
  88346. static X: Vector3;
  88347. /** Y axis */
  88348. static Y: Vector3;
  88349. /** Z axis */
  88350. static Z: Vector3;
  88351. }
  88352. }
  88353. declare module BABYLON {
  88354. /**
  88355. * Represents a camera frustum
  88356. */
  88357. export class Frustum {
  88358. /**
  88359. * Gets the planes representing the frustum
  88360. * @param transform matrix to be applied to the returned planes
  88361. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  88362. */
  88363. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  88364. /**
  88365. * Gets the near frustum plane transformed by the transform matrix
  88366. * @param transform transformation matrix to be applied to the resulting frustum plane
  88367. * @param frustumPlane the resuling frustum plane
  88368. */
  88369. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88370. /**
  88371. * Gets the far frustum plane transformed by the transform matrix
  88372. * @param transform transformation matrix to be applied to the resulting frustum plane
  88373. * @param frustumPlane the resuling frustum plane
  88374. */
  88375. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88376. /**
  88377. * Gets the left frustum plane transformed by the transform matrix
  88378. * @param transform transformation matrix to be applied to the resulting frustum plane
  88379. * @param frustumPlane the resuling frustum plane
  88380. */
  88381. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88382. /**
  88383. * Gets the right frustum plane transformed by the transform matrix
  88384. * @param transform transformation matrix to be applied to the resulting frustum plane
  88385. * @param frustumPlane the resuling frustum plane
  88386. */
  88387. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88388. /**
  88389. * Gets the top frustum plane transformed by the transform matrix
  88390. * @param transform transformation matrix to be applied to the resulting frustum plane
  88391. * @param frustumPlane the resuling frustum plane
  88392. */
  88393. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88394. /**
  88395. * Gets the bottom frustum plane transformed by the transform matrix
  88396. * @param transform transformation matrix to be applied to the resulting frustum plane
  88397. * @param frustumPlane the resuling frustum plane
  88398. */
  88399. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88400. /**
  88401. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  88402. * @param transform transformation matrix to be applied to the resulting frustum planes
  88403. * @param frustumPlanes the resuling frustum planes
  88404. */
  88405. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  88406. }
  88407. }
  88408. declare module BABYLON {
  88409. /**
  88410. * Interface for the size containing width and height
  88411. */
  88412. export interface ISize {
  88413. /**
  88414. * Width
  88415. */
  88416. width: number;
  88417. /**
  88418. * Heighht
  88419. */
  88420. height: number;
  88421. }
  88422. /**
  88423. * Size containing widht and height
  88424. */
  88425. export class Size implements ISize {
  88426. /**
  88427. * Width
  88428. */
  88429. width: number;
  88430. /**
  88431. * Height
  88432. */
  88433. height: number;
  88434. /**
  88435. * Creates a Size object from the given width and height (floats).
  88436. * @param width width of the new size
  88437. * @param height height of the new size
  88438. */
  88439. constructor(width: number, height: number);
  88440. /**
  88441. * Returns a string with the Size width and height
  88442. * @returns a string with the Size width and height
  88443. */
  88444. toString(): string;
  88445. /**
  88446. * "Size"
  88447. * @returns the string "Size"
  88448. */
  88449. getClassName(): string;
  88450. /**
  88451. * Returns the Size hash code.
  88452. * @returns a hash code for a unique width and height
  88453. */
  88454. getHashCode(): number;
  88455. /**
  88456. * Updates the current size from the given one.
  88457. * @param src the given size
  88458. */
  88459. copyFrom(src: Size): void;
  88460. /**
  88461. * Updates in place the current Size from the given floats.
  88462. * @param width width of the new size
  88463. * @param height height of the new size
  88464. * @returns the updated Size.
  88465. */
  88466. copyFromFloats(width: number, height: number): Size;
  88467. /**
  88468. * Updates in place the current Size from the given floats.
  88469. * @param width width to set
  88470. * @param height height to set
  88471. * @returns the updated Size.
  88472. */
  88473. set(width: number, height: number): Size;
  88474. /**
  88475. * Multiplies the width and height by numbers
  88476. * @param w factor to multiple the width by
  88477. * @param h factor to multiple the height by
  88478. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  88479. */
  88480. multiplyByFloats(w: number, h: number): Size;
  88481. /**
  88482. * Clones the size
  88483. * @returns a new Size copied from the given one.
  88484. */
  88485. clone(): Size;
  88486. /**
  88487. * True if the current Size and the given one width and height are strictly equal.
  88488. * @param other the other size to compare against
  88489. * @returns True if the current Size and the given one width and height are strictly equal.
  88490. */
  88491. equals(other: Size): boolean;
  88492. /**
  88493. * The surface of the Size : width * height (float).
  88494. */
  88495. get surface(): number;
  88496. /**
  88497. * Create a new size of zero
  88498. * @returns a new Size set to (0.0, 0.0)
  88499. */
  88500. static Zero(): Size;
  88501. /**
  88502. * Sums the width and height of two sizes
  88503. * @param otherSize size to add to this size
  88504. * @returns a new Size set as the addition result of the current Size and the given one.
  88505. */
  88506. add(otherSize: Size): Size;
  88507. /**
  88508. * Subtracts the width and height of two
  88509. * @param otherSize size to subtract to this size
  88510. * @returns a new Size set as the subtraction result of the given one from the current Size.
  88511. */
  88512. subtract(otherSize: Size): Size;
  88513. /**
  88514. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  88515. * @param start starting size to lerp between
  88516. * @param end end size to lerp between
  88517. * @param amount amount to lerp between the start and end values
  88518. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  88519. */
  88520. static Lerp(start: Size, end: Size, amount: number): Size;
  88521. }
  88522. }
  88523. declare module BABYLON {
  88524. /**
  88525. * Contains position and normal vectors for a vertex
  88526. */
  88527. export class PositionNormalVertex {
  88528. /** the position of the vertex (defaut: 0,0,0) */
  88529. position: Vector3;
  88530. /** the normal of the vertex (defaut: 0,1,0) */
  88531. normal: Vector3;
  88532. /**
  88533. * Creates a PositionNormalVertex
  88534. * @param position the position of the vertex (defaut: 0,0,0)
  88535. * @param normal the normal of the vertex (defaut: 0,1,0)
  88536. */
  88537. constructor(
  88538. /** the position of the vertex (defaut: 0,0,0) */
  88539. position?: Vector3,
  88540. /** the normal of the vertex (defaut: 0,1,0) */
  88541. normal?: Vector3);
  88542. /**
  88543. * Clones the PositionNormalVertex
  88544. * @returns the cloned PositionNormalVertex
  88545. */
  88546. clone(): PositionNormalVertex;
  88547. }
  88548. /**
  88549. * Contains position, normal and uv vectors for a vertex
  88550. */
  88551. export class PositionNormalTextureVertex {
  88552. /** the position of the vertex (defaut: 0,0,0) */
  88553. position: Vector3;
  88554. /** the normal of the vertex (defaut: 0,1,0) */
  88555. normal: Vector3;
  88556. /** the uv of the vertex (default: 0,0) */
  88557. uv: Vector2;
  88558. /**
  88559. * Creates a PositionNormalTextureVertex
  88560. * @param position the position of the vertex (defaut: 0,0,0)
  88561. * @param normal the normal of the vertex (defaut: 0,1,0)
  88562. * @param uv the uv of the vertex (default: 0,0)
  88563. */
  88564. constructor(
  88565. /** the position of the vertex (defaut: 0,0,0) */
  88566. position?: Vector3,
  88567. /** the normal of the vertex (defaut: 0,1,0) */
  88568. normal?: Vector3,
  88569. /** the uv of the vertex (default: 0,0) */
  88570. uv?: Vector2);
  88571. /**
  88572. * Clones the PositionNormalTextureVertex
  88573. * @returns the cloned PositionNormalTextureVertex
  88574. */
  88575. clone(): PositionNormalTextureVertex;
  88576. }
  88577. }
  88578. declare module BABYLON {
  88579. /**
  88580. * Enum defining the type of animations supported by InputBlock
  88581. */
  88582. export enum AnimatedInputBlockTypes {
  88583. /** No animation */
  88584. None = 0,
  88585. /** Time based animation. Will only work for floats */
  88586. Time = 1
  88587. }
  88588. }
  88589. declare module BABYLON {
  88590. /**
  88591. * Interface describing all the common properties and methods a shadow light needs to implement.
  88592. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  88593. * as well as binding the different shadow properties to the effects.
  88594. */
  88595. export interface IShadowLight extends Light {
  88596. /**
  88597. * The light id in the scene (used in scene.findLighById for instance)
  88598. */
  88599. id: string;
  88600. /**
  88601. * The position the shdow will be casted from.
  88602. */
  88603. position: Vector3;
  88604. /**
  88605. * In 2d mode (needCube being false), the direction used to cast the shadow.
  88606. */
  88607. direction: Vector3;
  88608. /**
  88609. * The transformed position. Position of the light in world space taking parenting in account.
  88610. */
  88611. transformedPosition: Vector3;
  88612. /**
  88613. * The transformed direction. Direction of the light in world space taking parenting in account.
  88614. */
  88615. transformedDirection: Vector3;
  88616. /**
  88617. * The friendly name of the light in the scene.
  88618. */
  88619. name: string;
  88620. /**
  88621. * Defines the shadow projection clipping minimum z value.
  88622. */
  88623. shadowMinZ: number;
  88624. /**
  88625. * Defines the shadow projection clipping maximum z value.
  88626. */
  88627. shadowMaxZ: number;
  88628. /**
  88629. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88630. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88631. */
  88632. computeTransformedInformation(): boolean;
  88633. /**
  88634. * Gets the scene the light belongs to.
  88635. * @returns The scene
  88636. */
  88637. getScene(): Scene;
  88638. /**
  88639. * Callback defining a custom Projection Matrix Builder.
  88640. * This can be used to override the default projection matrix computation.
  88641. */
  88642. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88643. /**
  88644. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88645. * @param matrix The materix to updated with the projection information
  88646. * @param viewMatrix The transform matrix of the light
  88647. * @param renderList The list of mesh to render in the map
  88648. * @returns The current light
  88649. */
  88650. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88651. /**
  88652. * Gets the current depth scale used in ESM.
  88653. * @returns The scale
  88654. */
  88655. getDepthScale(): number;
  88656. /**
  88657. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88658. * @returns true if a cube texture needs to be use
  88659. */
  88660. needCube(): boolean;
  88661. /**
  88662. * Detects if the projection matrix requires to be recomputed this frame.
  88663. * @returns true if it requires to be recomputed otherwise, false.
  88664. */
  88665. needProjectionMatrixCompute(): boolean;
  88666. /**
  88667. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88668. */
  88669. forceProjectionMatrixCompute(): void;
  88670. /**
  88671. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88672. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88673. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88674. */
  88675. getShadowDirection(faceIndex?: number): Vector3;
  88676. /**
  88677. * Gets the minZ used for shadow according to both the scene and the light.
  88678. * @param activeCamera The camera we are returning the min for
  88679. * @returns the depth min z
  88680. */
  88681. getDepthMinZ(activeCamera: Camera): number;
  88682. /**
  88683. * Gets the maxZ used for shadow according to both the scene and the light.
  88684. * @param activeCamera The camera we are returning the max for
  88685. * @returns the depth max z
  88686. */
  88687. getDepthMaxZ(activeCamera: Camera): number;
  88688. }
  88689. /**
  88690. * Base implementation IShadowLight
  88691. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  88692. */
  88693. export abstract class ShadowLight extends Light implements IShadowLight {
  88694. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  88695. protected _position: Vector3;
  88696. protected _setPosition(value: Vector3): void;
  88697. /**
  88698. * Sets the position the shadow will be casted from. Also use as the light position for both
  88699. * point and spot lights.
  88700. */
  88701. get position(): Vector3;
  88702. /**
  88703. * Sets the position the shadow will be casted from. Also use as the light position for both
  88704. * point and spot lights.
  88705. */
  88706. set position(value: Vector3);
  88707. protected _direction: Vector3;
  88708. protected _setDirection(value: Vector3): void;
  88709. /**
  88710. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  88711. * Also use as the light direction on spot and directional lights.
  88712. */
  88713. get direction(): Vector3;
  88714. /**
  88715. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  88716. * Also use as the light direction on spot and directional lights.
  88717. */
  88718. set direction(value: Vector3);
  88719. protected _shadowMinZ: number;
  88720. /**
  88721. * Gets the shadow projection clipping minimum z value.
  88722. */
  88723. get shadowMinZ(): number;
  88724. /**
  88725. * Sets the shadow projection clipping minimum z value.
  88726. */
  88727. set shadowMinZ(value: number);
  88728. protected _shadowMaxZ: number;
  88729. /**
  88730. * Sets the shadow projection clipping maximum z value.
  88731. */
  88732. get shadowMaxZ(): number;
  88733. /**
  88734. * Gets the shadow projection clipping maximum z value.
  88735. */
  88736. set shadowMaxZ(value: number);
  88737. /**
  88738. * Callback defining a custom Projection Matrix Builder.
  88739. * This can be used to override the default projection matrix computation.
  88740. */
  88741. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88742. /**
  88743. * The transformed position. Position of the light in world space taking parenting in account.
  88744. */
  88745. transformedPosition: Vector3;
  88746. /**
  88747. * The transformed direction. Direction of the light in world space taking parenting in account.
  88748. */
  88749. transformedDirection: Vector3;
  88750. private _needProjectionMatrixCompute;
  88751. /**
  88752. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88753. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88754. */
  88755. computeTransformedInformation(): boolean;
  88756. /**
  88757. * Return the depth scale used for the shadow map.
  88758. * @returns the depth scale.
  88759. */
  88760. getDepthScale(): number;
  88761. /**
  88762. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88763. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88764. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88765. */
  88766. getShadowDirection(faceIndex?: number): Vector3;
  88767. /**
  88768. * Returns the ShadowLight absolute position in the World.
  88769. * @returns the position vector in world space
  88770. */
  88771. getAbsolutePosition(): Vector3;
  88772. /**
  88773. * Sets the ShadowLight direction toward the passed target.
  88774. * @param target The point to target in local space
  88775. * @returns the updated ShadowLight direction
  88776. */
  88777. setDirectionToTarget(target: Vector3): Vector3;
  88778. /**
  88779. * Returns the light rotation in euler definition.
  88780. * @returns the x y z rotation in local space.
  88781. */
  88782. getRotation(): Vector3;
  88783. /**
  88784. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88785. * @returns true if a cube texture needs to be use
  88786. */
  88787. needCube(): boolean;
  88788. /**
  88789. * Detects if the projection matrix requires to be recomputed this frame.
  88790. * @returns true if it requires to be recomputed otherwise, false.
  88791. */
  88792. needProjectionMatrixCompute(): boolean;
  88793. /**
  88794. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88795. */
  88796. forceProjectionMatrixCompute(): void;
  88797. /** @hidden */
  88798. _initCache(): void;
  88799. /** @hidden */
  88800. _isSynchronized(): boolean;
  88801. /**
  88802. * Computes the world matrix of the node
  88803. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  88804. * @returns the world matrix
  88805. */
  88806. computeWorldMatrix(force?: boolean): Matrix;
  88807. /**
  88808. * Gets the minZ used for shadow according to both the scene and the light.
  88809. * @param activeCamera The camera we are returning the min for
  88810. * @returns the depth min z
  88811. */
  88812. getDepthMinZ(activeCamera: Camera): number;
  88813. /**
  88814. * Gets the maxZ used for shadow according to both the scene and the light.
  88815. * @param activeCamera The camera we are returning the max for
  88816. * @returns the depth max z
  88817. */
  88818. getDepthMaxZ(activeCamera: Camera): number;
  88819. /**
  88820. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88821. * @param matrix The materix to updated with the projection information
  88822. * @param viewMatrix The transform matrix of the light
  88823. * @param renderList The list of mesh to render in the map
  88824. * @returns The current light
  88825. */
  88826. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88827. }
  88828. }
  88829. declare module BABYLON {
  88830. /** @hidden */
  88831. export var packingFunctions: {
  88832. name: string;
  88833. shader: string;
  88834. };
  88835. }
  88836. declare module BABYLON {
  88837. /** @hidden */
  88838. export var bayerDitherFunctions: {
  88839. name: string;
  88840. shader: string;
  88841. };
  88842. }
  88843. declare module BABYLON {
  88844. /** @hidden */
  88845. export var shadowMapFragmentDeclaration: {
  88846. name: string;
  88847. shader: string;
  88848. };
  88849. }
  88850. declare module BABYLON {
  88851. /** @hidden */
  88852. export var clipPlaneFragmentDeclaration: {
  88853. name: string;
  88854. shader: string;
  88855. };
  88856. }
  88857. declare module BABYLON {
  88858. /** @hidden */
  88859. export var clipPlaneFragment: {
  88860. name: string;
  88861. shader: string;
  88862. };
  88863. }
  88864. declare module BABYLON {
  88865. /** @hidden */
  88866. export var shadowMapFragment: {
  88867. name: string;
  88868. shader: string;
  88869. };
  88870. }
  88871. declare module BABYLON {
  88872. /** @hidden */
  88873. export var shadowMapPixelShader: {
  88874. name: string;
  88875. shader: string;
  88876. };
  88877. }
  88878. declare module BABYLON {
  88879. /** @hidden */
  88880. export var bonesDeclaration: {
  88881. name: string;
  88882. shader: string;
  88883. };
  88884. }
  88885. declare module BABYLON {
  88886. /** @hidden */
  88887. export var morphTargetsVertexGlobalDeclaration: {
  88888. name: string;
  88889. shader: string;
  88890. };
  88891. }
  88892. declare module BABYLON {
  88893. /** @hidden */
  88894. export var morphTargetsVertexDeclaration: {
  88895. name: string;
  88896. shader: string;
  88897. };
  88898. }
  88899. declare module BABYLON {
  88900. /** @hidden */
  88901. export var instancesDeclaration: {
  88902. name: string;
  88903. shader: string;
  88904. };
  88905. }
  88906. declare module BABYLON {
  88907. /** @hidden */
  88908. export var helperFunctions: {
  88909. name: string;
  88910. shader: string;
  88911. };
  88912. }
  88913. declare module BABYLON {
  88914. /** @hidden */
  88915. export var shadowMapVertexDeclaration: {
  88916. name: string;
  88917. shader: string;
  88918. };
  88919. }
  88920. declare module BABYLON {
  88921. /** @hidden */
  88922. export var clipPlaneVertexDeclaration: {
  88923. name: string;
  88924. shader: string;
  88925. };
  88926. }
  88927. declare module BABYLON {
  88928. /** @hidden */
  88929. export var morphTargetsVertex: {
  88930. name: string;
  88931. shader: string;
  88932. };
  88933. }
  88934. declare module BABYLON {
  88935. /** @hidden */
  88936. export var instancesVertex: {
  88937. name: string;
  88938. shader: string;
  88939. };
  88940. }
  88941. declare module BABYLON {
  88942. /** @hidden */
  88943. export var bonesVertex: {
  88944. name: string;
  88945. shader: string;
  88946. };
  88947. }
  88948. declare module BABYLON {
  88949. /** @hidden */
  88950. export var shadowMapVertexNormalBias: {
  88951. name: string;
  88952. shader: string;
  88953. };
  88954. }
  88955. declare module BABYLON {
  88956. /** @hidden */
  88957. export var shadowMapVertexMetric: {
  88958. name: string;
  88959. shader: string;
  88960. };
  88961. }
  88962. declare module BABYLON {
  88963. /** @hidden */
  88964. export var clipPlaneVertex: {
  88965. name: string;
  88966. shader: string;
  88967. };
  88968. }
  88969. declare module BABYLON {
  88970. /** @hidden */
  88971. export var shadowMapVertexShader: {
  88972. name: string;
  88973. shader: string;
  88974. };
  88975. }
  88976. declare module BABYLON {
  88977. /** @hidden */
  88978. export var depthBoxBlurPixelShader: {
  88979. name: string;
  88980. shader: string;
  88981. };
  88982. }
  88983. declare module BABYLON {
  88984. /** @hidden */
  88985. export var shadowMapFragmentSoftTransparentShadow: {
  88986. name: string;
  88987. shader: string;
  88988. };
  88989. }
  88990. declare module BABYLON {
  88991. /**
  88992. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  88993. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  88994. */
  88995. export class EffectFallbacks implements IEffectFallbacks {
  88996. private _defines;
  88997. private _currentRank;
  88998. private _maxRank;
  88999. private _mesh;
  89000. /**
  89001. * Removes the fallback from the bound mesh.
  89002. */
  89003. unBindMesh(): void;
  89004. /**
  89005. * Adds a fallback on the specified property.
  89006. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89007. * @param define The name of the define in the shader
  89008. */
  89009. addFallback(rank: number, define: string): void;
  89010. /**
  89011. * Sets the mesh to use CPU skinning when needing to fallback.
  89012. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89013. * @param mesh The mesh to use the fallbacks.
  89014. */
  89015. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  89016. /**
  89017. * Checks to see if more fallbacks are still availible.
  89018. */
  89019. get hasMoreFallbacks(): boolean;
  89020. /**
  89021. * Removes the defines that should be removed when falling back.
  89022. * @param currentDefines defines the current define statements for the shader.
  89023. * @param effect defines the current effect we try to compile
  89024. * @returns The resulting defines with defines of the current rank removed.
  89025. */
  89026. reduce(currentDefines: string, effect: Effect): string;
  89027. }
  89028. }
  89029. declare module BABYLON {
  89030. /**
  89031. * Interface used to define Action
  89032. */
  89033. export interface IAction {
  89034. /**
  89035. * Trigger for the action
  89036. */
  89037. trigger: number;
  89038. /** Options of the trigger */
  89039. triggerOptions: any;
  89040. /**
  89041. * Gets the trigger parameters
  89042. * @returns the trigger parameters
  89043. */
  89044. getTriggerParameter(): any;
  89045. /**
  89046. * Internal only - executes current action event
  89047. * @hidden
  89048. */
  89049. _executeCurrent(evt?: ActionEvent): void;
  89050. /**
  89051. * Serialize placeholder for child classes
  89052. * @param parent of child
  89053. * @returns the serialized object
  89054. */
  89055. serialize(parent: any): any;
  89056. /**
  89057. * Internal only
  89058. * @hidden
  89059. */
  89060. _prepare(): void;
  89061. /**
  89062. * Internal only - manager for action
  89063. * @hidden
  89064. */
  89065. _actionManager: Nullable<AbstractActionManager>;
  89066. /**
  89067. * Adds action to chain of actions, may be a DoNothingAction
  89068. * @param action defines the next action to execute
  89069. * @returns The action passed in
  89070. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89071. */
  89072. then(action: IAction): IAction;
  89073. }
  89074. /**
  89075. * The action to be carried out following a trigger
  89076. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  89077. */
  89078. export class Action implements IAction {
  89079. /** the trigger, with or without parameters, for the action */
  89080. triggerOptions: any;
  89081. /**
  89082. * Trigger for the action
  89083. */
  89084. trigger: number;
  89085. /**
  89086. * Internal only - manager for action
  89087. * @hidden
  89088. */
  89089. _actionManager: ActionManager;
  89090. private _nextActiveAction;
  89091. private _child;
  89092. private _condition?;
  89093. private _triggerParameter;
  89094. /**
  89095. * An event triggered prior to action being executed.
  89096. */
  89097. onBeforeExecuteObservable: Observable<Action>;
  89098. /**
  89099. * Creates a new Action
  89100. * @param triggerOptions the trigger, with or without parameters, for the action
  89101. * @param condition an optional determinant of action
  89102. */
  89103. constructor(
  89104. /** the trigger, with or without parameters, for the action */
  89105. triggerOptions: any, condition?: Condition);
  89106. /**
  89107. * Internal only
  89108. * @hidden
  89109. */
  89110. _prepare(): void;
  89111. /**
  89112. * Gets the trigger parameters
  89113. * @returns the trigger parameters
  89114. */
  89115. getTriggerParameter(): any;
  89116. /**
  89117. * Internal only - executes current action event
  89118. * @hidden
  89119. */
  89120. _executeCurrent(evt?: ActionEvent): void;
  89121. /**
  89122. * Execute placeholder for child classes
  89123. * @param evt optional action event
  89124. */
  89125. execute(evt?: ActionEvent): void;
  89126. /**
  89127. * Skips to next active action
  89128. */
  89129. skipToNextActiveAction(): void;
  89130. /**
  89131. * Adds action to chain of actions, may be a DoNothingAction
  89132. * @param action defines the next action to execute
  89133. * @returns The action passed in
  89134. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89135. */
  89136. then(action: Action): Action;
  89137. /**
  89138. * Internal only
  89139. * @hidden
  89140. */
  89141. _getProperty(propertyPath: string): string;
  89142. /**
  89143. * Internal only
  89144. * @hidden
  89145. */
  89146. _getEffectiveTarget(target: any, propertyPath: string): any;
  89147. /**
  89148. * Serialize placeholder for child classes
  89149. * @param parent of child
  89150. * @returns the serialized object
  89151. */
  89152. serialize(parent: any): any;
  89153. /**
  89154. * Internal only called by serialize
  89155. * @hidden
  89156. */
  89157. protected _serialize(serializedAction: any, parent?: any): any;
  89158. /**
  89159. * Internal only
  89160. * @hidden
  89161. */
  89162. static _SerializeValueAsString: (value: any) => string;
  89163. /**
  89164. * Internal only
  89165. * @hidden
  89166. */
  89167. static _GetTargetProperty: (target: Scene | Node) => {
  89168. name: string;
  89169. targetType: string;
  89170. value: string;
  89171. };
  89172. }
  89173. }
  89174. declare module BABYLON {
  89175. /**
  89176. * A Condition applied to an Action
  89177. */
  89178. export class Condition {
  89179. /**
  89180. * Internal only - manager for action
  89181. * @hidden
  89182. */
  89183. _actionManager: ActionManager;
  89184. /**
  89185. * Internal only
  89186. * @hidden
  89187. */
  89188. _evaluationId: number;
  89189. /**
  89190. * Internal only
  89191. * @hidden
  89192. */
  89193. _currentResult: boolean;
  89194. /**
  89195. * Creates a new Condition
  89196. * @param actionManager the manager of the action the condition is applied to
  89197. */
  89198. constructor(actionManager: ActionManager);
  89199. /**
  89200. * Check if the current condition is valid
  89201. * @returns a boolean
  89202. */
  89203. isValid(): boolean;
  89204. /**
  89205. * Internal only
  89206. * @hidden
  89207. */
  89208. _getProperty(propertyPath: string): string;
  89209. /**
  89210. * Internal only
  89211. * @hidden
  89212. */
  89213. _getEffectiveTarget(target: any, propertyPath: string): any;
  89214. /**
  89215. * Serialize placeholder for child classes
  89216. * @returns the serialized object
  89217. */
  89218. serialize(): any;
  89219. /**
  89220. * Internal only
  89221. * @hidden
  89222. */
  89223. protected _serialize(serializedCondition: any): any;
  89224. }
  89225. /**
  89226. * Defines specific conditional operators as extensions of Condition
  89227. */
  89228. export class ValueCondition extends Condition {
  89229. /** path to specify the property of the target the conditional operator uses */
  89230. propertyPath: string;
  89231. /** the value compared by the conditional operator against the current value of the property */
  89232. value: any;
  89233. /** the conditional operator, default ValueCondition.IsEqual */
  89234. operator: number;
  89235. /**
  89236. * Internal only
  89237. * @hidden
  89238. */
  89239. private static _IsEqual;
  89240. /**
  89241. * Internal only
  89242. * @hidden
  89243. */
  89244. private static _IsDifferent;
  89245. /**
  89246. * Internal only
  89247. * @hidden
  89248. */
  89249. private static _IsGreater;
  89250. /**
  89251. * Internal only
  89252. * @hidden
  89253. */
  89254. private static _IsLesser;
  89255. /**
  89256. * returns the number for IsEqual
  89257. */
  89258. static get IsEqual(): number;
  89259. /**
  89260. * Returns the number for IsDifferent
  89261. */
  89262. static get IsDifferent(): number;
  89263. /**
  89264. * Returns the number for IsGreater
  89265. */
  89266. static get IsGreater(): number;
  89267. /**
  89268. * Returns the number for IsLesser
  89269. */
  89270. static get IsLesser(): number;
  89271. /**
  89272. * Internal only The action manager for the condition
  89273. * @hidden
  89274. */
  89275. _actionManager: ActionManager;
  89276. /**
  89277. * Internal only
  89278. * @hidden
  89279. */
  89280. private _target;
  89281. /**
  89282. * Internal only
  89283. * @hidden
  89284. */
  89285. private _effectiveTarget;
  89286. /**
  89287. * Internal only
  89288. * @hidden
  89289. */
  89290. private _property;
  89291. /**
  89292. * Creates a new ValueCondition
  89293. * @param actionManager manager for the action the condition applies to
  89294. * @param target for the action
  89295. * @param propertyPath path to specify the property of the target the conditional operator uses
  89296. * @param value the value compared by the conditional operator against the current value of the property
  89297. * @param operator the conditional operator, default ValueCondition.IsEqual
  89298. */
  89299. constructor(actionManager: ActionManager, target: any,
  89300. /** path to specify the property of the target the conditional operator uses */
  89301. propertyPath: string,
  89302. /** the value compared by the conditional operator against the current value of the property */
  89303. value: any,
  89304. /** the conditional operator, default ValueCondition.IsEqual */
  89305. operator?: number);
  89306. /**
  89307. * Compares the given value with the property value for the specified conditional operator
  89308. * @returns the result of the comparison
  89309. */
  89310. isValid(): boolean;
  89311. /**
  89312. * Serialize the ValueCondition into a JSON compatible object
  89313. * @returns serialization object
  89314. */
  89315. serialize(): any;
  89316. /**
  89317. * Gets the name of the conditional operator for the ValueCondition
  89318. * @param operator the conditional operator
  89319. * @returns the name
  89320. */
  89321. static GetOperatorName(operator: number): string;
  89322. }
  89323. /**
  89324. * Defines a predicate condition as an extension of Condition
  89325. */
  89326. export class PredicateCondition extends Condition {
  89327. /** defines the predicate function used to validate the condition */
  89328. predicate: () => boolean;
  89329. /**
  89330. * Internal only - manager for action
  89331. * @hidden
  89332. */
  89333. _actionManager: ActionManager;
  89334. /**
  89335. * Creates a new PredicateCondition
  89336. * @param actionManager manager for the action the condition applies to
  89337. * @param predicate defines the predicate function used to validate the condition
  89338. */
  89339. constructor(actionManager: ActionManager,
  89340. /** defines the predicate function used to validate the condition */
  89341. predicate: () => boolean);
  89342. /**
  89343. * @returns the validity of the predicate condition
  89344. */
  89345. isValid(): boolean;
  89346. }
  89347. /**
  89348. * Defines a state condition as an extension of Condition
  89349. */
  89350. export class StateCondition extends Condition {
  89351. /** Value to compare with target state */
  89352. value: string;
  89353. /**
  89354. * Internal only - manager for action
  89355. * @hidden
  89356. */
  89357. _actionManager: ActionManager;
  89358. /**
  89359. * Internal only
  89360. * @hidden
  89361. */
  89362. private _target;
  89363. /**
  89364. * Creates a new StateCondition
  89365. * @param actionManager manager for the action the condition applies to
  89366. * @param target of the condition
  89367. * @param value to compare with target state
  89368. */
  89369. constructor(actionManager: ActionManager, target: any,
  89370. /** Value to compare with target state */
  89371. value: string);
  89372. /**
  89373. * Gets a boolean indicating if the current condition is met
  89374. * @returns the validity of the state
  89375. */
  89376. isValid(): boolean;
  89377. /**
  89378. * Serialize the StateCondition into a JSON compatible object
  89379. * @returns serialization object
  89380. */
  89381. serialize(): any;
  89382. }
  89383. }
  89384. declare module BABYLON {
  89385. /**
  89386. * This defines an action responsible to toggle a boolean once triggered.
  89387. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89388. */
  89389. export class SwitchBooleanAction extends Action {
  89390. /**
  89391. * The path to the boolean property in the target object
  89392. */
  89393. propertyPath: string;
  89394. private _target;
  89395. private _effectiveTarget;
  89396. private _property;
  89397. /**
  89398. * Instantiate the action
  89399. * @param triggerOptions defines the trigger options
  89400. * @param target defines the object containing the boolean
  89401. * @param propertyPath defines the path to the boolean property in the target object
  89402. * @param condition defines the trigger related conditions
  89403. */
  89404. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  89405. /** @hidden */
  89406. _prepare(): void;
  89407. /**
  89408. * Execute the action toggle the boolean value.
  89409. */
  89410. execute(): void;
  89411. /**
  89412. * Serializes the actions and its related information.
  89413. * @param parent defines the object to serialize in
  89414. * @returns the serialized object
  89415. */
  89416. serialize(parent: any): any;
  89417. }
  89418. /**
  89419. * This defines an action responsible to set a the state field of the target
  89420. * to a desired value once triggered.
  89421. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89422. */
  89423. export class SetStateAction extends Action {
  89424. /**
  89425. * The value to store in the state field.
  89426. */
  89427. value: string;
  89428. private _target;
  89429. /**
  89430. * Instantiate the action
  89431. * @param triggerOptions defines the trigger options
  89432. * @param target defines the object containing the state property
  89433. * @param value defines the value to store in the state field
  89434. * @param condition defines the trigger related conditions
  89435. */
  89436. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  89437. /**
  89438. * Execute the action and store the value on the target state property.
  89439. */
  89440. execute(): void;
  89441. /**
  89442. * Serializes the actions and its related information.
  89443. * @param parent defines the object to serialize in
  89444. * @returns the serialized object
  89445. */
  89446. serialize(parent: any): any;
  89447. }
  89448. /**
  89449. * This defines an action responsible to set a property of the target
  89450. * to a desired value once triggered.
  89451. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89452. */
  89453. export class SetValueAction extends Action {
  89454. /**
  89455. * The path of the property to set in the target.
  89456. */
  89457. propertyPath: string;
  89458. /**
  89459. * The value to set in the property
  89460. */
  89461. value: any;
  89462. private _target;
  89463. private _effectiveTarget;
  89464. private _property;
  89465. /**
  89466. * Instantiate the action
  89467. * @param triggerOptions defines the trigger options
  89468. * @param target defines the object containing the property
  89469. * @param propertyPath defines the path of the property to set in the target
  89470. * @param value defines the value to set in the property
  89471. * @param condition defines the trigger related conditions
  89472. */
  89473. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89474. /** @hidden */
  89475. _prepare(): void;
  89476. /**
  89477. * Execute the action and set the targetted property to the desired value.
  89478. */
  89479. execute(): void;
  89480. /**
  89481. * Serializes the actions and its related information.
  89482. * @param parent defines the object to serialize in
  89483. * @returns the serialized object
  89484. */
  89485. serialize(parent: any): any;
  89486. }
  89487. /**
  89488. * This defines an action responsible to increment the target value
  89489. * to a desired value once triggered.
  89490. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89491. */
  89492. export class IncrementValueAction extends Action {
  89493. /**
  89494. * The path of the property to increment in the target.
  89495. */
  89496. propertyPath: string;
  89497. /**
  89498. * The value we should increment the property by.
  89499. */
  89500. value: any;
  89501. private _target;
  89502. private _effectiveTarget;
  89503. private _property;
  89504. /**
  89505. * Instantiate the action
  89506. * @param triggerOptions defines the trigger options
  89507. * @param target defines the object containing the property
  89508. * @param propertyPath defines the path of the property to increment in the target
  89509. * @param value defines the value value we should increment the property by
  89510. * @param condition defines the trigger related conditions
  89511. */
  89512. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89513. /** @hidden */
  89514. _prepare(): void;
  89515. /**
  89516. * Execute the action and increment the target of the value amount.
  89517. */
  89518. execute(): void;
  89519. /**
  89520. * Serializes the actions and its related information.
  89521. * @param parent defines the object to serialize in
  89522. * @returns the serialized object
  89523. */
  89524. serialize(parent: any): any;
  89525. }
  89526. /**
  89527. * This defines an action responsible to start an animation once triggered.
  89528. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89529. */
  89530. export class PlayAnimationAction extends Action {
  89531. /**
  89532. * Where the animation should start (animation frame)
  89533. */
  89534. from: number;
  89535. /**
  89536. * Where the animation should stop (animation frame)
  89537. */
  89538. to: number;
  89539. /**
  89540. * Define if the animation should loop or stop after the first play.
  89541. */
  89542. loop?: boolean;
  89543. private _target;
  89544. /**
  89545. * Instantiate the action
  89546. * @param triggerOptions defines the trigger options
  89547. * @param target defines the target animation or animation name
  89548. * @param from defines from where the animation should start (animation frame)
  89549. * @param end defines where the animation should stop (animation frame)
  89550. * @param loop defines if the animation should loop or stop after the first play
  89551. * @param condition defines the trigger related conditions
  89552. */
  89553. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  89554. /** @hidden */
  89555. _prepare(): void;
  89556. /**
  89557. * Execute the action and play the animation.
  89558. */
  89559. execute(): void;
  89560. /**
  89561. * Serializes the actions and its related information.
  89562. * @param parent defines the object to serialize in
  89563. * @returns the serialized object
  89564. */
  89565. serialize(parent: any): any;
  89566. }
  89567. /**
  89568. * This defines an action responsible to stop an animation once triggered.
  89569. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89570. */
  89571. export class StopAnimationAction extends Action {
  89572. private _target;
  89573. /**
  89574. * Instantiate the action
  89575. * @param triggerOptions defines the trigger options
  89576. * @param target defines the target animation or animation name
  89577. * @param condition defines the trigger related conditions
  89578. */
  89579. constructor(triggerOptions: any, target: any, condition?: Condition);
  89580. /** @hidden */
  89581. _prepare(): void;
  89582. /**
  89583. * Execute the action and stop the animation.
  89584. */
  89585. execute(): void;
  89586. /**
  89587. * Serializes the actions and its related information.
  89588. * @param parent defines the object to serialize in
  89589. * @returns the serialized object
  89590. */
  89591. serialize(parent: any): any;
  89592. }
  89593. /**
  89594. * This defines an action responsible that does nothing once triggered.
  89595. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89596. */
  89597. export class DoNothingAction extends Action {
  89598. /**
  89599. * Instantiate the action
  89600. * @param triggerOptions defines the trigger options
  89601. * @param condition defines the trigger related conditions
  89602. */
  89603. constructor(triggerOptions?: any, condition?: Condition);
  89604. /**
  89605. * Execute the action and do nothing.
  89606. */
  89607. execute(): void;
  89608. /**
  89609. * Serializes the actions and its related information.
  89610. * @param parent defines the object to serialize in
  89611. * @returns the serialized object
  89612. */
  89613. serialize(parent: any): any;
  89614. }
  89615. /**
  89616. * This defines an action responsible to trigger several actions once triggered.
  89617. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89618. */
  89619. export class CombineAction extends Action {
  89620. /**
  89621. * The list of aggregated animations to run.
  89622. */
  89623. children: Action[];
  89624. /**
  89625. * Instantiate the action
  89626. * @param triggerOptions defines the trigger options
  89627. * @param children defines the list of aggregated animations to run
  89628. * @param condition defines the trigger related conditions
  89629. */
  89630. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  89631. /** @hidden */
  89632. _prepare(): void;
  89633. /**
  89634. * Execute the action and executes all the aggregated actions.
  89635. */
  89636. execute(evt: ActionEvent): void;
  89637. /**
  89638. * Serializes the actions and its related information.
  89639. * @param parent defines the object to serialize in
  89640. * @returns the serialized object
  89641. */
  89642. serialize(parent: any): any;
  89643. }
  89644. /**
  89645. * This defines an action responsible to run code (external event) once triggered.
  89646. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89647. */
  89648. export class ExecuteCodeAction extends Action {
  89649. /**
  89650. * The callback function to run.
  89651. */
  89652. func: (evt: ActionEvent) => void;
  89653. /**
  89654. * Instantiate the action
  89655. * @param triggerOptions defines the trigger options
  89656. * @param func defines the callback function to run
  89657. * @param condition defines the trigger related conditions
  89658. */
  89659. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  89660. /**
  89661. * Execute the action and run the attached code.
  89662. */
  89663. execute(evt: ActionEvent): void;
  89664. }
  89665. /**
  89666. * This defines an action responsible to set the parent property of the target once triggered.
  89667. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89668. */
  89669. export class SetParentAction extends Action {
  89670. private _parent;
  89671. private _target;
  89672. /**
  89673. * Instantiate the action
  89674. * @param triggerOptions defines the trigger options
  89675. * @param target defines the target containing the parent property
  89676. * @param parent defines from where the animation should start (animation frame)
  89677. * @param condition defines the trigger related conditions
  89678. */
  89679. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  89680. /** @hidden */
  89681. _prepare(): void;
  89682. /**
  89683. * Execute the action and set the parent property.
  89684. */
  89685. execute(): void;
  89686. /**
  89687. * Serializes the actions and its related information.
  89688. * @param parent defines the object to serialize in
  89689. * @returns the serialized object
  89690. */
  89691. serialize(parent: any): any;
  89692. }
  89693. }
  89694. declare module BABYLON {
  89695. /**
  89696. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  89697. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  89698. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89699. */
  89700. export class ActionManager extends AbstractActionManager {
  89701. /**
  89702. * Nothing
  89703. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89704. */
  89705. static readonly NothingTrigger: number;
  89706. /**
  89707. * On pick
  89708. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89709. */
  89710. static readonly OnPickTrigger: number;
  89711. /**
  89712. * On left pick
  89713. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89714. */
  89715. static readonly OnLeftPickTrigger: number;
  89716. /**
  89717. * On right pick
  89718. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89719. */
  89720. static readonly OnRightPickTrigger: number;
  89721. /**
  89722. * On center pick
  89723. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89724. */
  89725. static readonly OnCenterPickTrigger: number;
  89726. /**
  89727. * On pick down
  89728. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89729. */
  89730. static readonly OnPickDownTrigger: number;
  89731. /**
  89732. * On double pick
  89733. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89734. */
  89735. static readonly OnDoublePickTrigger: number;
  89736. /**
  89737. * On pick up
  89738. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89739. */
  89740. static readonly OnPickUpTrigger: number;
  89741. /**
  89742. * On pick out.
  89743. * This trigger will only be raised if you also declared a OnPickDown
  89744. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89745. */
  89746. static readonly OnPickOutTrigger: number;
  89747. /**
  89748. * On long press
  89749. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89750. */
  89751. static readonly OnLongPressTrigger: number;
  89752. /**
  89753. * On pointer over
  89754. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89755. */
  89756. static readonly OnPointerOverTrigger: number;
  89757. /**
  89758. * On pointer out
  89759. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89760. */
  89761. static readonly OnPointerOutTrigger: number;
  89762. /**
  89763. * On every frame
  89764. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89765. */
  89766. static readonly OnEveryFrameTrigger: number;
  89767. /**
  89768. * On intersection enter
  89769. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89770. */
  89771. static readonly OnIntersectionEnterTrigger: number;
  89772. /**
  89773. * On intersection exit
  89774. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89775. */
  89776. static readonly OnIntersectionExitTrigger: number;
  89777. /**
  89778. * On key down
  89779. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89780. */
  89781. static readonly OnKeyDownTrigger: number;
  89782. /**
  89783. * On key up
  89784. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89785. */
  89786. static readonly OnKeyUpTrigger: number;
  89787. private _scene;
  89788. /**
  89789. * Creates a new action manager
  89790. * @param scene defines the hosting scene
  89791. */
  89792. constructor(scene: Scene);
  89793. /**
  89794. * Releases all associated resources
  89795. */
  89796. dispose(): void;
  89797. /**
  89798. * Gets hosting scene
  89799. * @returns the hosting scene
  89800. */
  89801. getScene(): Scene;
  89802. /**
  89803. * Does this action manager handles actions of any of the given triggers
  89804. * @param triggers defines the triggers to be tested
  89805. * @return a boolean indicating whether one (or more) of the triggers is handled
  89806. */
  89807. hasSpecificTriggers(triggers: number[]): boolean;
  89808. /**
  89809. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  89810. * speed.
  89811. * @param triggerA defines the trigger to be tested
  89812. * @param triggerB defines the trigger to be tested
  89813. * @return a boolean indicating whether one (or more) of the triggers is handled
  89814. */
  89815. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  89816. /**
  89817. * Does this action manager handles actions of a given trigger
  89818. * @param trigger defines the trigger to be tested
  89819. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  89820. * @return whether the trigger is handled
  89821. */
  89822. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  89823. /**
  89824. * Does this action manager has pointer triggers
  89825. */
  89826. get hasPointerTriggers(): boolean;
  89827. /**
  89828. * Does this action manager has pick triggers
  89829. */
  89830. get hasPickTriggers(): boolean;
  89831. /**
  89832. * Registers an action to this action manager
  89833. * @param action defines the action to be registered
  89834. * @return the action amended (prepared) after registration
  89835. */
  89836. registerAction(action: IAction): Nullable<IAction>;
  89837. /**
  89838. * Unregisters an action to this action manager
  89839. * @param action defines the action to be unregistered
  89840. * @return a boolean indicating whether the action has been unregistered
  89841. */
  89842. unregisterAction(action: IAction): Boolean;
  89843. /**
  89844. * Process a specific trigger
  89845. * @param trigger defines the trigger to process
  89846. * @param evt defines the event details to be processed
  89847. */
  89848. processTrigger(trigger: number, evt?: IActionEvent): void;
  89849. /** @hidden */
  89850. _getEffectiveTarget(target: any, propertyPath: string): any;
  89851. /** @hidden */
  89852. _getProperty(propertyPath: string): string;
  89853. /**
  89854. * Serialize this manager to a JSON object
  89855. * @param name defines the property name to store this manager
  89856. * @returns a JSON representation of this manager
  89857. */
  89858. serialize(name: string): any;
  89859. /**
  89860. * Creates a new ActionManager from a JSON data
  89861. * @param parsedActions defines the JSON data to read from
  89862. * @param object defines the hosting mesh
  89863. * @param scene defines the hosting scene
  89864. */
  89865. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  89866. /**
  89867. * Get a trigger name by index
  89868. * @param trigger defines the trigger index
  89869. * @returns a trigger name
  89870. */
  89871. static GetTriggerName(trigger: number): string;
  89872. }
  89873. }
  89874. declare module BABYLON {
  89875. /**
  89876. * Class used to represent a sprite
  89877. * @see https://doc.babylonjs.com/babylon101/sprites
  89878. */
  89879. export class Sprite implements IAnimatable {
  89880. /** defines the name */
  89881. name: string;
  89882. /** Gets or sets the current world position */
  89883. position: Vector3;
  89884. /** Gets or sets the main color */
  89885. color: Color4;
  89886. /** Gets or sets the width */
  89887. width: number;
  89888. /** Gets or sets the height */
  89889. height: number;
  89890. /** Gets or sets rotation angle */
  89891. angle: number;
  89892. /** Gets or sets the cell index in the sprite sheet */
  89893. cellIndex: number;
  89894. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  89895. cellRef: string;
  89896. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  89897. invertU: boolean;
  89898. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  89899. invertV: boolean;
  89900. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  89901. disposeWhenFinishedAnimating: boolean;
  89902. /** Gets the list of attached animations */
  89903. animations: Nullable<Array<Animation>>;
  89904. /** Gets or sets a boolean indicating if the sprite can be picked */
  89905. isPickable: boolean;
  89906. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  89907. useAlphaForPicking: boolean;
  89908. /** @hidden */
  89909. _xOffset: number;
  89910. /** @hidden */
  89911. _yOffset: number;
  89912. /** @hidden */
  89913. _xSize: number;
  89914. /** @hidden */
  89915. _ySize: number;
  89916. /**
  89917. * Gets or sets the associated action manager
  89918. */
  89919. actionManager: Nullable<ActionManager>;
  89920. /**
  89921. * An event triggered when the control has been disposed
  89922. */
  89923. onDisposeObservable: Observable<Sprite>;
  89924. private _animationStarted;
  89925. private _loopAnimation;
  89926. private _fromIndex;
  89927. private _toIndex;
  89928. private _delay;
  89929. private _direction;
  89930. private _manager;
  89931. private _time;
  89932. private _onAnimationEnd;
  89933. /**
  89934. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  89935. */
  89936. isVisible: boolean;
  89937. /**
  89938. * Gets or sets the sprite size
  89939. */
  89940. get size(): number;
  89941. set size(value: number);
  89942. /**
  89943. * Returns a boolean indicating if the animation is started
  89944. */
  89945. get animationStarted(): boolean;
  89946. /**
  89947. * Gets or sets the unique id of the sprite
  89948. */
  89949. uniqueId: number;
  89950. /**
  89951. * Gets the manager of this sprite
  89952. */
  89953. get manager(): ISpriteManager;
  89954. /**
  89955. * Creates a new Sprite
  89956. * @param name defines the name
  89957. * @param manager defines the manager
  89958. */
  89959. constructor(
  89960. /** defines the name */
  89961. name: string, manager: ISpriteManager);
  89962. /**
  89963. * Returns the string "Sprite"
  89964. * @returns "Sprite"
  89965. */
  89966. getClassName(): string;
  89967. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  89968. get fromIndex(): number;
  89969. set fromIndex(value: number);
  89970. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  89971. get toIndex(): number;
  89972. set toIndex(value: number);
  89973. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  89974. get loopAnimation(): boolean;
  89975. set loopAnimation(value: boolean);
  89976. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  89977. get delay(): number;
  89978. set delay(value: number);
  89979. /**
  89980. * Starts an animation
  89981. * @param from defines the initial key
  89982. * @param to defines the end key
  89983. * @param loop defines if the animation must loop
  89984. * @param delay defines the start delay (in ms)
  89985. * @param onAnimationEnd defines a callback to call when animation ends
  89986. */
  89987. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  89988. /** Stops current animation (if any) */
  89989. stopAnimation(): void;
  89990. /** @hidden */
  89991. _animate(deltaTime: number): void;
  89992. /** Release associated resources */
  89993. dispose(): void;
  89994. /**
  89995. * Serializes the sprite to a JSON object
  89996. * @returns the JSON object
  89997. */
  89998. serialize(): any;
  89999. /**
  90000. * Parses a JSON object to create a new sprite
  90001. * @param parsedSprite The JSON object to parse
  90002. * @param manager defines the hosting manager
  90003. * @returns the new sprite
  90004. */
  90005. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  90006. }
  90007. }
  90008. declare module BABYLON {
  90009. /**
  90010. * Information about the result of picking within a scene
  90011. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  90012. */
  90013. export class PickingInfo {
  90014. /** @hidden */
  90015. _pickingUnavailable: boolean;
  90016. /**
  90017. * If the pick collided with an object
  90018. */
  90019. hit: boolean;
  90020. /**
  90021. * Distance away where the pick collided
  90022. */
  90023. distance: number;
  90024. /**
  90025. * The location of pick collision
  90026. */
  90027. pickedPoint: Nullable<Vector3>;
  90028. /**
  90029. * The mesh corresponding the the pick collision
  90030. */
  90031. pickedMesh: Nullable<AbstractMesh>;
  90032. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  90033. bu: number;
  90034. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  90035. bv: number;
  90036. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90037. faceId: number;
  90038. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90039. subMeshFaceId: number;
  90040. /** Id of the the submesh that was picked */
  90041. subMeshId: number;
  90042. /** If a sprite was picked, this will be the sprite the pick collided with */
  90043. pickedSprite: Nullable<Sprite>;
  90044. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  90045. thinInstanceIndex: number;
  90046. /**
  90047. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  90048. */
  90049. originMesh: Nullable<AbstractMesh>;
  90050. /**
  90051. * The ray that was used to perform the picking.
  90052. */
  90053. ray: Nullable<Ray>;
  90054. /**
  90055. * Gets the normal correspodning to the face the pick collided with
  90056. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  90057. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  90058. * @returns The normal correspodning to the face the pick collided with
  90059. */
  90060. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  90061. /**
  90062. * Gets the texture coordinates of where the pick occured
  90063. * @returns the vector containing the coordnates of the texture
  90064. */
  90065. getTextureCoordinates(): Nullable<Vector2>;
  90066. }
  90067. }
  90068. declare module BABYLON {
  90069. /**
  90070. * Class representing a ray with position and direction
  90071. */
  90072. export class Ray {
  90073. /** origin point */
  90074. origin: Vector3;
  90075. /** direction */
  90076. direction: Vector3;
  90077. /** length of the ray */
  90078. length: number;
  90079. private static readonly _TmpVector3;
  90080. private _tmpRay;
  90081. /**
  90082. * Creates a new ray
  90083. * @param origin origin point
  90084. * @param direction direction
  90085. * @param length length of the ray
  90086. */
  90087. constructor(
  90088. /** origin point */
  90089. origin: Vector3,
  90090. /** direction */
  90091. direction: Vector3,
  90092. /** length of the ray */
  90093. length?: number);
  90094. /**
  90095. * Checks if the ray intersects a box
  90096. * This does not account for the ray lenght by design to improve perfs.
  90097. * @param minimum bound of the box
  90098. * @param maximum bound of the box
  90099. * @param intersectionTreshold extra extend to be added to the box in all direction
  90100. * @returns if the box was hit
  90101. */
  90102. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  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 box the bounding box to check
  90107. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  90108. * @returns if the box was hit
  90109. */
  90110. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  90111. /**
  90112. * If the ray hits a sphere
  90113. * @param sphere the bounding sphere to check
  90114. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  90115. * @returns true if it hits the sphere
  90116. */
  90117. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  90118. /**
  90119. * If the ray hits a triange
  90120. * @param vertex0 triangle vertex
  90121. * @param vertex1 triangle vertex
  90122. * @param vertex2 triangle vertex
  90123. * @returns intersection information if hit
  90124. */
  90125. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  90126. /**
  90127. * Checks if ray intersects a plane
  90128. * @param plane the plane to check
  90129. * @returns the distance away it was hit
  90130. */
  90131. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  90132. /**
  90133. * Calculate the intercept of a ray on a given axis
  90134. * @param axis to check 'x' | 'y' | 'z'
  90135. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  90136. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  90137. */
  90138. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  90139. /**
  90140. * Checks if ray intersects a mesh
  90141. * @param mesh the mesh to check
  90142. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90143. * @returns picking info of the intersecton
  90144. */
  90145. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  90146. /**
  90147. * Checks if ray intersects a mesh
  90148. * @param meshes the meshes to check
  90149. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90150. * @param results array to store result in
  90151. * @returns Array of picking infos
  90152. */
  90153. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  90154. private _comparePickingInfo;
  90155. private static smallnum;
  90156. private static rayl;
  90157. /**
  90158. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  90159. * @param sega the first point of the segment to test the intersection against
  90160. * @param segb the second point of the segment to test the intersection against
  90161. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  90162. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  90163. */
  90164. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  90165. /**
  90166. * Update the ray from viewport position
  90167. * @param x position
  90168. * @param y y position
  90169. * @param viewportWidth viewport width
  90170. * @param viewportHeight viewport height
  90171. * @param world world matrix
  90172. * @param view view matrix
  90173. * @param projection projection matrix
  90174. * @returns this ray updated
  90175. */
  90176. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90177. /**
  90178. * Creates a ray with origin and direction of 0,0,0
  90179. * @returns the new ray
  90180. */
  90181. static Zero(): Ray;
  90182. /**
  90183. * Creates a new ray from screen space and viewport
  90184. * @param x position
  90185. * @param y y position
  90186. * @param viewportWidth viewport width
  90187. * @param viewportHeight viewport height
  90188. * @param world world matrix
  90189. * @param view view matrix
  90190. * @param projection projection matrix
  90191. * @returns new ray
  90192. */
  90193. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90194. /**
  90195. * 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
  90196. * transformed to the given world matrix.
  90197. * @param origin The origin point
  90198. * @param end The end point
  90199. * @param world a matrix to transform the ray to. Default is the identity matrix.
  90200. * @returns the new ray
  90201. */
  90202. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  90203. /**
  90204. * Transforms a ray by a matrix
  90205. * @param ray ray to transform
  90206. * @param matrix matrix to apply
  90207. * @returns the resulting new ray
  90208. */
  90209. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  90210. /**
  90211. * Transforms a ray by a matrix
  90212. * @param ray ray to transform
  90213. * @param matrix matrix to apply
  90214. * @param result ray to store result in
  90215. */
  90216. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  90217. /**
  90218. * Unproject a ray from screen space to object space
  90219. * @param sourceX defines the screen space x coordinate to use
  90220. * @param sourceY defines the screen space y coordinate to use
  90221. * @param viewportWidth defines the current width of the viewport
  90222. * @param viewportHeight defines the current height of the viewport
  90223. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  90224. * @param view defines the view matrix to use
  90225. * @param projection defines the projection matrix to use
  90226. */
  90227. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  90228. }
  90229. /**
  90230. * Type used to define predicate used to select faces when a mesh intersection is detected
  90231. */
  90232. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  90233. interface Scene {
  90234. /** @hidden */
  90235. _tempPickingRay: Nullable<Ray>;
  90236. /** @hidden */
  90237. _cachedRayForTransform: Ray;
  90238. /** @hidden */
  90239. _pickWithRayInverseMatrix: Matrix;
  90240. /** @hidden */
  90241. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90242. /** @hidden */
  90243. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  90244. /** @hidden */
  90245. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90246. }
  90247. }
  90248. declare module BABYLON {
  90249. /**
  90250. * Groups all the scene component constants in one place to ease maintenance.
  90251. * @hidden
  90252. */
  90253. export class SceneComponentConstants {
  90254. static readonly NAME_EFFECTLAYER: string;
  90255. static readonly NAME_LAYER: string;
  90256. static readonly NAME_LENSFLARESYSTEM: string;
  90257. static readonly NAME_BOUNDINGBOXRENDERER: string;
  90258. static readonly NAME_PARTICLESYSTEM: string;
  90259. static readonly NAME_GAMEPAD: string;
  90260. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  90261. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  90262. static readonly NAME_PREPASSRENDERER: string;
  90263. static readonly NAME_DEPTHRENDERER: string;
  90264. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  90265. static readonly NAME_SPRITE: string;
  90266. static readonly NAME_OUTLINERENDERER: string;
  90267. static readonly NAME_PROCEDURALTEXTURE: string;
  90268. static readonly NAME_SHADOWGENERATOR: string;
  90269. static readonly NAME_OCTREE: string;
  90270. static readonly NAME_PHYSICSENGINE: string;
  90271. static readonly NAME_AUDIO: string;
  90272. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  90273. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90274. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  90275. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90276. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  90277. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  90278. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  90279. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  90280. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  90281. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  90282. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  90283. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  90284. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  90285. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  90286. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  90287. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  90288. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  90289. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  90290. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  90291. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  90292. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  90293. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  90294. static readonly STEP_AFTERRENDER_AUDIO: number;
  90295. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  90296. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  90297. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  90298. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  90299. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  90300. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  90301. static readonly STEP_POINTERMOVE_SPRITE: number;
  90302. static readonly STEP_POINTERDOWN_SPRITE: number;
  90303. static readonly STEP_POINTERUP_SPRITE: number;
  90304. }
  90305. /**
  90306. * This represents a scene component.
  90307. *
  90308. * This is used to decouple the dependency the scene is having on the different workloads like
  90309. * layers, post processes...
  90310. */
  90311. export interface ISceneComponent {
  90312. /**
  90313. * The name of the component. Each component must have a unique name.
  90314. */
  90315. name: string;
  90316. /**
  90317. * The scene the component belongs to.
  90318. */
  90319. scene: Scene;
  90320. /**
  90321. * Register the component to one instance of a scene.
  90322. */
  90323. register(): void;
  90324. /**
  90325. * Rebuilds the elements related to this component in case of
  90326. * context lost for instance.
  90327. */
  90328. rebuild(): void;
  90329. /**
  90330. * Disposes the component and the associated ressources.
  90331. */
  90332. dispose(): void;
  90333. }
  90334. /**
  90335. * This represents a SERIALIZABLE scene component.
  90336. *
  90337. * This extends Scene Component to add Serialization methods on top.
  90338. */
  90339. export interface ISceneSerializableComponent extends ISceneComponent {
  90340. /**
  90341. * Adds all the elements from the container to the scene
  90342. * @param container the container holding the elements
  90343. */
  90344. addFromContainer(container: AbstractScene): void;
  90345. /**
  90346. * Removes all the elements in the container from the scene
  90347. * @param container contains the elements to remove
  90348. * @param dispose if the removed element should be disposed (default: false)
  90349. */
  90350. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  90351. /**
  90352. * Serializes the component data to the specified json object
  90353. * @param serializationObject The object to serialize to
  90354. */
  90355. serialize(serializationObject: any): void;
  90356. }
  90357. /**
  90358. * Strong typing of a Mesh related stage step action
  90359. */
  90360. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  90361. /**
  90362. * Strong typing of a Evaluate Sub Mesh related stage step action
  90363. */
  90364. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  90365. /**
  90366. * Strong typing of a Active Mesh related stage step action
  90367. */
  90368. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  90369. /**
  90370. * Strong typing of a Camera related stage step action
  90371. */
  90372. export type CameraStageAction = (camera: Camera) => void;
  90373. /**
  90374. * Strong typing of a Camera Frame buffer related stage step action
  90375. */
  90376. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  90377. /**
  90378. * Strong typing of a Render Target related stage step action
  90379. */
  90380. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  90381. /**
  90382. * Strong typing of a RenderingGroup related stage step action
  90383. */
  90384. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  90385. /**
  90386. * Strong typing of a Mesh Render related stage step action
  90387. */
  90388. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  90389. /**
  90390. * Strong typing of a simple stage step action
  90391. */
  90392. export type SimpleStageAction = () => void;
  90393. /**
  90394. * Strong typing of a render target action.
  90395. */
  90396. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  90397. /**
  90398. * Strong typing of a pointer move action.
  90399. */
  90400. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  90401. /**
  90402. * Strong typing of a pointer up/down action.
  90403. */
  90404. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  90405. /**
  90406. * Representation of a stage in the scene (Basically a list of ordered steps)
  90407. * @hidden
  90408. */
  90409. export class Stage<T extends Function> extends Array<{
  90410. index: number;
  90411. component: ISceneComponent;
  90412. action: T;
  90413. }> {
  90414. /**
  90415. * Hide ctor from the rest of the world.
  90416. * @param items The items to add.
  90417. */
  90418. private constructor();
  90419. /**
  90420. * Creates a new Stage.
  90421. * @returns A new instance of a Stage
  90422. */
  90423. static Create<T extends Function>(): Stage<T>;
  90424. /**
  90425. * Registers a step in an ordered way in the targeted stage.
  90426. * @param index Defines the position to register the step in
  90427. * @param component Defines the component attached to the step
  90428. * @param action Defines the action to launch during the step
  90429. */
  90430. registerStep(index: number, component: ISceneComponent, action: T): void;
  90431. /**
  90432. * Clears all the steps from the stage.
  90433. */
  90434. clear(): void;
  90435. }
  90436. }
  90437. declare module BABYLON {
  90438. interface Scene {
  90439. /** @hidden */
  90440. _pointerOverSprite: Nullable<Sprite>;
  90441. /** @hidden */
  90442. _pickedDownSprite: Nullable<Sprite>;
  90443. /** @hidden */
  90444. _tempSpritePickingRay: Nullable<Ray>;
  90445. /**
  90446. * All of the sprite managers added to this scene
  90447. * @see https://doc.babylonjs.com/babylon101/sprites
  90448. */
  90449. spriteManagers: Array<ISpriteManager>;
  90450. /**
  90451. * An event triggered when sprites rendering is about to start
  90452. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90453. */
  90454. onBeforeSpritesRenderingObservable: Observable<Scene>;
  90455. /**
  90456. * An event triggered when sprites rendering is done
  90457. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90458. */
  90459. onAfterSpritesRenderingObservable: Observable<Scene>;
  90460. /** @hidden */
  90461. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90462. /** Launch a ray to try to pick a sprite in the scene
  90463. * @param x position on screen
  90464. * @param y position on screen
  90465. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  90466. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90467. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90468. * @returns a PickingInfo
  90469. */
  90470. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90471. /** Use the given ray to pick a sprite in the scene
  90472. * @param ray The ray (in world space) to use to pick meshes
  90473. * @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
  90474. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90475. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90476. * @returns a PickingInfo
  90477. */
  90478. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90479. /** @hidden */
  90480. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90481. /** Launch a ray to try to pick sprites in the scene
  90482. * @param x position on screen
  90483. * @param y position on screen
  90484. * @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
  90485. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90486. * @returns a PickingInfo array
  90487. */
  90488. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90489. /** Use the given ray to pick sprites in the scene
  90490. * @param ray The ray (in world space) to use to pick meshes
  90491. * @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
  90492. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90493. * @returns a PickingInfo array
  90494. */
  90495. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90496. /**
  90497. * Force the sprite under the pointer
  90498. * @param sprite defines the sprite to use
  90499. */
  90500. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  90501. /**
  90502. * Gets the sprite under the pointer
  90503. * @returns a Sprite or null if no sprite is under the pointer
  90504. */
  90505. getPointerOverSprite(): Nullable<Sprite>;
  90506. }
  90507. /**
  90508. * Defines the sprite scene component responsible to manage sprites
  90509. * in a given scene.
  90510. */
  90511. export class SpriteSceneComponent implements ISceneComponent {
  90512. /**
  90513. * The component name helpfull to identify the component in the list of scene components.
  90514. */
  90515. readonly name: string;
  90516. /**
  90517. * The scene the component belongs to.
  90518. */
  90519. scene: Scene;
  90520. /** @hidden */
  90521. private _spritePredicate;
  90522. /**
  90523. * Creates a new instance of the component for the given scene
  90524. * @param scene Defines the scene to register the component in
  90525. */
  90526. constructor(scene: Scene);
  90527. /**
  90528. * Registers the component in a given scene
  90529. */
  90530. register(): void;
  90531. /**
  90532. * Rebuilds the elements related to this component in case of
  90533. * context lost for instance.
  90534. */
  90535. rebuild(): void;
  90536. /**
  90537. * Disposes the component and the associated ressources.
  90538. */
  90539. dispose(): void;
  90540. private _pickSpriteButKeepRay;
  90541. private _pointerMove;
  90542. private _pointerDown;
  90543. private _pointerUp;
  90544. }
  90545. }
  90546. declare module BABYLON {
  90547. /** @hidden */
  90548. export var fogFragmentDeclaration: {
  90549. name: string;
  90550. shader: string;
  90551. };
  90552. }
  90553. declare module BABYLON {
  90554. /** @hidden */
  90555. export var fogFragment: {
  90556. name: string;
  90557. shader: string;
  90558. };
  90559. }
  90560. declare module BABYLON {
  90561. /** @hidden */
  90562. export var spritesPixelShader: {
  90563. name: string;
  90564. shader: string;
  90565. };
  90566. }
  90567. declare module BABYLON {
  90568. /** @hidden */
  90569. export var fogVertexDeclaration: {
  90570. name: string;
  90571. shader: string;
  90572. };
  90573. }
  90574. declare module BABYLON {
  90575. /** @hidden */
  90576. export var spritesVertexShader: {
  90577. name: string;
  90578. shader: string;
  90579. };
  90580. }
  90581. declare module BABYLON {
  90582. /**
  90583. * Defines the minimum interface to fullfil in order to be a sprite manager.
  90584. */
  90585. export interface ISpriteManager extends IDisposable {
  90586. /**
  90587. * Gets manager's name
  90588. */
  90589. name: string;
  90590. /**
  90591. * Restricts the camera to viewing objects with the same layerMask.
  90592. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  90593. */
  90594. layerMask: number;
  90595. /**
  90596. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  90597. */
  90598. isPickable: boolean;
  90599. /**
  90600. * Gets the hosting scene
  90601. */
  90602. scene: Scene;
  90603. /**
  90604. * Specifies the rendering group id for this mesh (0 by default)
  90605. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  90606. */
  90607. renderingGroupId: number;
  90608. /**
  90609. * Defines the list of sprites managed by the manager.
  90610. */
  90611. sprites: Array<Sprite>;
  90612. /**
  90613. * Gets or sets the spritesheet texture
  90614. */
  90615. texture: Texture;
  90616. /** Defines the default width of a cell in the spritesheet */
  90617. cellWidth: number;
  90618. /** Defines the default height of a cell in the spritesheet */
  90619. cellHeight: number;
  90620. /**
  90621. * Tests the intersection of a sprite with a specific ray.
  90622. * @param ray The ray we are sending to test the collision
  90623. * @param camera The camera space we are sending rays in
  90624. * @param predicate A predicate allowing excluding sprites from the list of object to test
  90625. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90626. * @returns picking info or null.
  90627. */
  90628. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90629. /**
  90630. * Intersects the sprites with a ray
  90631. * @param ray defines the ray to intersect with
  90632. * @param camera defines the current active camera
  90633. * @param predicate defines a predicate used to select candidate sprites
  90634. * @returns null if no hit or a PickingInfo array
  90635. */
  90636. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90637. /**
  90638. * Renders the list of sprites on screen.
  90639. */
  90640. render(): void;
  90641. }
  90642. /**
  90643. * Class used to manage multiple sprites on the same spritesheet
  90644. * @see https://doc.babylonjs.com/babylon101/sprites
  90645. */
  90646. export class SpriteManager implements ISpriteManager {
  90647. /** defines the manager's name */
  90648. name: string;
  90649. /** Define the Url to load snippets */
  90650. static SnippetUrl: string;
  90651. /** Snippet ID if the manager was created from the snippet server */
  90652. snippetId: string;
  90653. /** Gets the list of sprites */
  90654. sprites: Sprite[];
  90655. /** Gets or sets the rendering group id (0 by default) */
  90656. renderingGroupId: number;
  90657. /** Gets or sets camera layer mask */
  90658. layerMask: number;
  90659. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  90660. fogEnabled: boolean;
  90661. /** Gets or sets a boolean indicating if the sprites are pickable */
  90662. isPickable: boolean;
  90663. /** Defines the default width of a cell in the spritesheet */
  90664. cellWidth: number;
  90665. /** Defines the default height of a cell in the spritesheet */
  90666. cellHeight: number;
  90667. /** Associative array from JSON sprite data file */
  90668. private _cellData;
  90669. /** Array of sprite names from JSON sprite data file */
  90670. private _spriteMap;
  90671. /** True when packed cell data from JSON file is ready*/
  90672. private _packedAndReady;
  90673. private _textureContent;
  90674. private _useInstancing;
  90675. /**
  90676. * An event triggered when the manager is disposed.
  90677. */
  90678. onDisposeObservable: Observable<SpriteManager>;
  90679. private _onDisposeObserver;
  90680. /**
  90681. * Callback called when the manager is disposed
  90682. */
  90683. set onDispose(callback: () => void);
  90684. private _capacity;
  90685. private _fromPacked;
  90686. private _spriteTexture;
  90687. private _epsilon;
  90688. private _scene;
  90689. private _vertexData;
  90690. private _buffer;
  90691. private _vertexBuffers;
  90692. private _spriteBuffer;
  90693. private _indexBuffer;
  90694. private _effectBase;
  90695. private _effectFog;
  90696. private _vertexBufferSize;
  90697. /**
  90698. * Gets or sets the unique id of the sprite
  90699. */
  90700. uniqueId: number;
  90701. /**
  90702. * Gets the array of sprites
  90703. */
  90704. get children(): Sprite[];
  90705. /**
  90706. * Gets the hosting scene
  90707. */
  90708. get scene(): Scene;
  90709. /**
  90710. * Gets the capacity of the manager
  90711. */
  90712. get capacity(): number;
  90713. /**
  90714. * Gets or sets the spritesheet texture
  90715. */
  90716. get texture(): Texture;
  90717. set texture(value: Texture);
  90718. private _blendMode;
  90719. /**
  90720. * Blend mode use to render the particle, it can be any of
  90721. * the static Constants.ALPHA_x properties provided in this class.
  90722. * Default value is Constants.ALPHA_COMBINE
  90723. */
  90724. get blendMode(): number;
  90725. set blendMode(blendMode: number);
  90726. /** Disables writing to the depth buffer when rendering the sprites.
  90727. * It can be handy to disable depth writing when using textures without alpha channel
  90728. * and setting some specific blend modes.
  90729. */
  90730. disableDepthWrite: boolean;
  90731. /**
  90732. * Creates a new sprite manager
  90733. * @param name defines the manager's name
  90734. * @param imgUrl defines the sprite sheet url
  90735. * @param capacity defines the maximum allowed number of sprites
  90736. * @param cellSize defines the size of a sprite cell
  90737. * @param scene defines the hosting scene
  90738. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  90739. * @param samplingMode defines the smapling mode to use with spritesheet
  90740. * @param fromPacked set to false; do not alter
  90741. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  90742. */
  90743. constructor(
  90744. /** defines the manager's name */
  90745. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  90746. /**
  90747. * Returns the string "SpriteManager"
  90748. * @returns "SpriteManager"
  90749. */
  90750. getClassName(): string;
  90751. private _makePacked;
  90752. private _appendSpriteVertex;
  90753. private _checkTextureAlpha;
  90754. /**
  90755. * Intersects the sprites with a ray
  90756. * @param ray defines the ray to intersect with
  90757. * @param camera defines the current active camera
  90758. * @param predicate defines a predicate used to select candidate sprites
  90759. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  90760. * @returns null if no hit or a PickingInfo
  90761. */
  90762. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  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. * @returns null if no hit or a PickingInfo array
  90769. */
  90770. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90771. /**
  90772. * Render all child sprites
  90773. */
  90774. render(): void;
  90775. /**
  90776. * Release associated resources
  90777. */
  90778. dispose(): void;
  90779. /**
  90780. * Serializes the sprite manager to a JSON object
  90781. * @param serializeTexture defines if the texture must be serialized as well
  90782. * @returns the JSON object
  90783. */
  90784. serialize(serializeTexture?: boolean): any;
  90785. /**
  90786. * Parses a JSON object to create a new sprite manager.
  90787. * @param parsedManager The JSON object to parse
  90788. * @param scene The scene to create the sprite managerin
  90789. * @param rootUrl The root url to use to load external dependencies like texture
  90790. * @returns the new sprite manager
  90791. */
  90792. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  90793. /**
  90794. * Creates a sprite manager from a snippet saved in a remote file
  90795. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  90796. * @param url defines the url to load from
  90797. * @param scene defines the hosting scene
  90798. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90799. * @returns a promise that will resolve to the new sprite manager
  90800. */
  90801. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90802. /**
  90803. * Creates a sprite manager from a snippet saved by the sprite editor
  90804. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  90805. * @param scene defines the hosting scene
  90806. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90807. * @returns a promise that will resolve to the new sprite manager
  90808. */
  90809. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90810. }
  90811. }
  90812. declare module BABYLON {
  90813. /** Interface used by value gradients (color, factor, ...) */
  90814. export interface IValueGradient {
  90815. /**
  90816. * Gets or sets the gradient value (between 0 and 1)
  90817. */
  90818. gradient: number;
  90819. }
  90820. /** Class used to store color4 gradient */
  90821. export class ColorGradient implements IValueGradient {
  90822. /**
  90823. * Gets or sets the gradient value (between 0 and 1)
  90824. */
  90825. gradient: number;
  90826. /**
  90827. * Gets or sets first associated color
  90828. */
  90829. color1: Color4;
  90830. /**
  90831. * Gets or sets second associated color
  90832. */
  90833. color2?: Color4 | undefined;
  90834. /**
  90835. * Creates a new color4 gradient
  90836. * @param gradient gets or sets the gradient value (between 0 and 1)
  90837. * @param color1 gets or sets first associated color
  90838. * @param color2 gets or sets first second color
  90839. */
  90840. constructor(
  90841. /**
  90842. * Gets or sets the gradient value (between 0 and 1)
  90843. */
  90844. gradient: number,
  90845. /**
  90846. * Gets or sets first associated color
  90847. */
  90848. color1: Color4,
  90849. /**
  90850. * Gets or sets second associated color
  90851. */
  90852. color2?: Color4 | undefined);
  90853. /**
  90854. * Will get a color picked randomly between color1 and color2.
  90855. * If color2 is undefined then color1 will be used
  90856. * @param result defines the target Color4 to store the result in
  90857. */
  90858. getColorToRef(result: Color4): void;
  90859. }
  90860. /** Class used to store color 3 gradient */
  90861. export class Color3Gradient implements IValueGradient {
  90862. /**
  90863. * Gets or sets the gradient value (between 0 and 1)
  90864. */
  90865. gradient: number;
  90866. /**
  90867. * Gets or sets the associated color
  90868. */
  90869. color: Color3;
  90870. /**
  90871. * Creates a new color3 gradient
  90872. * @param gradient gets or sets the gradient value (between 0 and 1)
  90873. * @param color gets or sets associated color
  90874. */
  90875. constructor(
  90876. /**
  90877. * Gets or sets the gradient value (between 0 and 1)
  90878. */
  90879. gradient: number,
  90880. /**
  90881. * Gets or sets the associated color
  90882. */
  90883. color: Color3);
  90884. }
  90885. /** Class used to store factor gradient */
  90886. export class FactorGradient implements IValueGradient {
  90887. /**
  90888. * Gets or sets the gradient value (between 0 and 1)
  90889. */
  90890. gradient: number;
  90891. /**
  90892. * Gets or sets first associated factor
  90893. */
  90894. factor1: number;
  90895. /**
  90896. * Gets or sets second associated factor
  90897. */
  90898. factor2?: number | undefined;
  90899. /**
  90900. * Creates a new factor gradient
  90901. * @param gradient gets or sets the gradient value (between 0 and 1)
  90902. * @param factor1 gets or sets first associated factor
  90903. * @param factor2 gets or sets second associated factor
  90904. */
  90905. constructor(
  90906. /**
  90907. * Gets or sets the gradient value (between 0 and 1)
  90908. */
  90909. gradient: number,
  90910. /**
  90911. * Gets or sets first associated factor
  90912. */
  90913. factor1: number,
  90914. /**
  90915. * Gets or sets second associated factor
  90916. */
  90917. factor2?: number | undefined);
  90918. /**
  90919. * Will get a number picked randomly between factor1 and factor2.
  90920. * If factor2 is undefined then factor1 will be used
  90921. * @returns the picked number
  90922. */
  90923. getFactor(): number;
  90924. }
  90925. /**
  90926. * Helper used to simplify some generic gradient tasks
  90927. */
  90928. export class GradientHelper {
  90929. /**
  90930. * Gets the current gradient from an array of IValueGradient
  90931. * @param ratio defines the current ratio to get
  90932. * @param gradients defines the array of IValueGradient
  90933. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  90934. */
  90935. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  90936. }
  90937. }
  90938. declare module BABYLON {
  90939. interface ThinEngine {
  90940. /**
  90941. * Creates a raw texture
  90942. * @param data defines the data to store in the texture
  90943. * @param width defines the width of the texture
  90944. * @param height defines the height of the texture
  90945. * @param format defines the format of the data
  90946. * @param generateMipMaps defines if the engine should generate the mip levels
  90947. * @param invertY defines if data must be stored with Y axis inverted
  90948. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  90949. * @param compression defines the compression used (null by default)
  90950. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90951. * @returns the raw texture inside an InternalTexture
  90952. */
  90953. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  90954. /**
  90955. * Update a raw texture
  90956. * @param texture defines the texture to update
  90957. * @param data defines the data to store in the texture
  90958. * @param format defines the format of the data
  90959. * @param invertY defines if data must be stored with Y axis inverted
  90960. */
  90961. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  90962. /**
  90963. * Update a raw texture
  90964. * @param texture defines the texture to update
  90965. * @param data defines the data to store in the texture
  90966. * @param format defines the format of the data
  90967. * @param invertY defines if data must be stored with Y axis inverted
  90968. * @param compression defines the compression used (null by default)
  90969. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90970. */
  90971. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  90972. /**
  90973. * Creates a new raw cube texture
  90974. * @param data defines the array of data to use to create each face
  90975. * @param size defines the size of the textures
  90976. * @param format defines the format of the data
  90977. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90978. * @param generateMipMaps defines if the engine should generate the mip levels
  90979. * @param invertY defines if data must be stored with Y axis inverted
  90980. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90981. * @param compression defines the compression used (null by default)
  90982. * @returns the cube texture as an InternalTexture
  90983. */
  90984. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  90985. /**
  90986. * Update a raw cube texture
  90987. * @param texture defines the texture to udpdate
  90988. * @param data defines the data to store
  90989. * @param format defines the data format
  90990. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90991. * @param invertY defines if data must be stored with Y axis inverted
  90992. */
  90993. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  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. * @param compression defines the compression used (null by default)
  91002. */
  91003. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  91004. /**
  91005. * Update a raw cube texture
  91006. * @param texture defines the texture to udpdate
  91007. * @param data defines the data to store
  91008. * @param format defines the data format
  91009. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91010. * @param invertY defines if data must be stored with Y axis inverted
  91011. * @param compression defines the compression used (null by default)
  91012. * @param level defines which level of the texture to update
  91013. */
  91014. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  91015. /**
  91016. * Creates a new raw cube texture from a specified url
  91017. * @param url defines the url where the data is located
  91018. * @param scene defines the current scene
  91019. * @param size defines the size of the textures
  91020. * @param format defines the format of the data
  91021. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91022. * @param noMipmap defines if the engine should avoid generating the mip levels
  91023. * @param callback defines a callback used to extract texture data from loaded data
  91024. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91025. * @param onLoad defines a callback called when texture is loaded
  91026. * @param onError defines a callback called if there is an error
  91027. * @returns the cube texture as an InternalTexture
  91028. */
  91029. 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;
  91030. /**
  91031. * Creates a new raw cube texture from a specified url
  91032. * @param url defines the url where the data is located
  91033. * @param scene defines the current scene
  91034. * @param size defines the size of the textures
  91035. * @param format defines the format of the data
  91036. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91037. * @param noMipmap defines if the engine should avoid generating the mip levels
  91038. * @param callback defines a callback used to extract texture data from loaded data
  91039. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91040. * @param onLoad defines a callback called when texture is loaded
  91041. * @param onError defines a callback called if there is an error
  91042. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91043. * @param invertY defines if data must be stored with Y axis inverted
  91044. * @returns the cube texture as an InternalTexture
  91045. */
  91046. 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;
  91047. /**
  91048. * Creates a new raw 3D texture
  91049. * @param data defines the data used to create the texture
  91050. * @param width defines the width of the texture
  91051. * @param height defines the height of the texture
  91052. * @param depth defines the depth of the texture
  91053. * @param format defines the format of the texture
  91054. * @param generateMipMaps defines if the engine must generate mip levels
  91055. * @param invertY defines if data must be stored with Y axis inverted
  91056. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91057. * @param compression defines the compressed used (can be null)
  91058. * @param textureType defines the compressed used (can be null)
  91059. * @returns a new raw 3D texture (stored in an InternalTexture)
  91060. */
  91061. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91062. /**
  91063. * Update a raw 3D texture
  91064. * @param texture defines the texture to update
  91065. * @param data defines the data to store
  91066. * @param format defines the data format
  91067. * @param invertY defines if data must be stored with Y axis inverted
  91068. */
  91069. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91070. /**
  91071. * Update a raw 3D texture
  91072. * @param texture defines the texture to update
  91073. * @param data defines the data to store
  91074. * @param format defines the data format
  91075. * @param invertY defines if data must be stored with Y axis inverted
  91076. * @param compression defines the used compression (can be null)
  91077. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91078. */
  91079. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91080. /**
  91081. * Creates a new raw 2D array texture
  91082. * @param data defines the data used to create the texture
  91083. * @param width defines the width of the texture
  91084. * @param height defines the height of the texture
  91085. * @param depth defines the number of layers of the texture
  91086. * @param format defines the format of the texture
  91087. * @param generateMipMaps defines if the engine must generate mip levels
  91088. * @param invertY defines if data must be stored with Y axis inverted
  91089. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91090. * @param compression defines the compressed used (can be null)
  91091. * @param textureType defines the compressed used (can be null)
  91092. * @returns a new raw 2D array texture (stored in an InternalTexture)
  91093. */
  91094. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91095. /**
  91096. * Update a raw 2D array texture
  91097. * @param texture defines the texture to update
  91098. * @param data defines the data to store
  91099. * @param format defines the data format
  91100. * @param invertY defines if data must be stored with Y axis inverted
  91101. */
  91102. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91103. /**
  91104. * Update a raw 2D array texture
  91105. * @param texture defines the texture to update
  91106. * @param data defines the data to store
  91107. * @param format defines the data format
  91108. * @param invertY defines if data must be stored with Y axis inverted
  91109. * @param compression defines the used compression (can be null)
  91110. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91111. */
  91112. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91113. }
  91114. }
  91115. declare module BABYLON {
  91116. /**
  91117. * Raw texture can help creating a texture directly from an array of data.
  91118. * This can be super useful if you either get the data from an uncompressed source or
  91119. * if you wish to create your texture pixel by pixel.
  91120. */
  91121. export class RawTexture extends Texture {
  91122. /**
  91123. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91124. */
  91125. format: number;
  91126. /**
  91127. * Instantiates a new RawTexture.
  91128. * Raw texture can help creating a texture directly from an array of data.
  91129. * This can be super useful if you either get the data from an uncompressed source or
  91130. * if you wish to create your texture pixel by pixel.
  91131. * @param data define the array of data to use to create the texture
  91132. * @param width define the width of the texture
  91133. * @param height define the height of the texture
  91134. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91135. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91136. * @param generateMipMaps define whether mip maps should be generated or not
  91137. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91138. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91139. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91140. */
  91141. constructor(data: ArrayBufferView, width: number, height: number,
  91142. /**
  91143. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91144. */
  91145. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  91146. /**
  91147. * Updates the texture underlying data.
  91148. * @param data Define the new data of the texture
  91149. */
  91150. update(data: ArrayBufferView): void;
  91151. /**
  91152. * Creates a luminance texture from some data.
  91153. * @param data Define the texture data
  91154. * @param width Define the width of the texture
  91155. * @param height Define the height of the texture
  91156. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91157. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91158. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91159. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91160. * @returns the luminance texture
  91161. */
  91162. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91163. /**
  91164. * Creates a luminance alpha texture from some data.
  91165. * @param data Define the texture data
  91166. * @param width Define the width of the texture
  91167. * @param height Define the height of the texture
  91168. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91169. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91170. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91171. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91172. * @returns the luminance alpha texture
  91173. */
  91174. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91175. /**
  91176. * Creates an alpha texture from some data.
  91177. * @param data Define the texture data
  91178. * @param width Define the width of the texture
  91179. * @param height Define the height of the texture
  91180. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91181. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91182. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91183. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91184. * @returns the alpha texture
  91185. */
  91186. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91187. /**
  91188. * Creates a RGB texture from some data.
  91189. * @param data Define the texture data
  91190. * @param width Define the width of the texture
  91191. * @param height Define the height of the texture
  91192. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91193. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91194. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91195. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91196. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91197. * @returns the RGB alpha texture
  91198. */
  91199. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91200. /**
  91201. * Creates a RGBA texture from some data.
  91202. * @param data Define the texture data
  91203. * @param width Define the width of the texture
  91204. * @param height Define the height of the texture
  91205. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91206. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91207. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91208. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91209. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91210. * @returns the RGBA texture
  91211. */
  91212. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91213. /**
  91214. * Creates a R texture from some data.
  91215. * @param data Define the texture data
  91216. * @param width Define the width of the texture
  91217. * @param height Define the height of the texture
  91218. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91219. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91220. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91221. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91222. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91223. * @returns the R texture
  91224. */
  91225. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91226. }
  91227. }
  91228. declare module BABYLON {
  91229. interface ThinEngine {
  91230. /**
  91231. * Update a dynamic index buffer
  91232. * @param indexBuffer defines the target index buffer
  91233. * @param indices defines the data to update
  91234. * @param offset defines the offset in the target index buffer where update should start
  91235. */
  91236. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  91237. /**
  91238. * Updates a dynamic vertex buffer.
  91239. * @param vertexBuffer the vertex buffer to update
  91240. * @param data the data used to update the vertex buffer
  91241. * @param byteOffset the byte offset of the data
  91242. * @param byteLength the byte length of the data
  91243. */
  91244. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  91245. }
  91246. }
  91247. declare module BABYLON {
  91248. interface AbstractScene {
  91249. /**
  91250. * The list of procedural textures added to the scene
  91251. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91252. */
  91253. proceduralTextures: Array<ProceduralTexture>;
  91254. }
  91255. /**
  91256. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  91257. * in a given scene.
  91258. */
  91259. export class ProceduralTextureSceneComponent implements ISceneComponent {
  91260. /**
  91261. * The component name helpfull to identify the component in the list of scene components.
  91262. */
  91263. readonly name: string;
  91264. /**
  91265. * The scene the component belongs to.
  91266. */
  91267. scene: Scene;
  91268. /**
  91269. * Creates a new instance of the component for the given scene
  91270. * @param scene Defines the scene to register the component in
  91271. */
  91272. constructor(scene: Scene);
  91273. /**
  91274. * Registers the component in a given scene
  91275. */
  91276. register(): void;
  91277. /**
  91278. * Rebuilds the elements related to this component in case of
  91279. * context lost for instance.
  91280. */
  91281. rebuild(): void;
  91282. /**
  91283. * Disposes the component and the associated ressources.
  91284. */
  91285. dispose(): void;
  91286. private _beforeClear;
  91287. }
  91288. }
  91289. declare module BABYLON {
  91290. interface ThinEngine {
  91291. /**
  91292. * Creates a new render target cube texture
  91293. * @param size defines the size of the texture
  91294. * @param options defines the options used to create the texture
  91295. * @returns a new render target cube texture stored in an InternalTexture
  91296. */
  91297. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  91298. }
  91299. }
  91300. declare module BABYLON {
  91301. /** @hidden */
  91302. export var proceduralVertexShader: {
  91303. name: string;
  91304. shader: string;
  91305. };
  91306. }
  91307. declare module BABYLON {
  91308. /**
  91309. * 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.
  91310. * This is the base class of any Procedural texture and contains most of the shareable code.
  91311. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91312. */
  91313. export class ProceduralTexture extends Texture {
  91314. /**
  91315. * Define if the texture is enabled or not (disabled texture will not render)
  91316. */
  91317. isEnabled: boolean;
  91318. /**
  91319. * Define if the texture must be cleared before rendering (default is true)
  91320. */
  91321. autoClear: boolean;
  91322. /**
  91323. * Callback called when the texture is generated
  91324. */
  91325. onGenerated: () => void;
  91326. /**
  91327. * Event raised when the texture is generated
  91328. */
  91329. onGeneratedObservable: Observable<ProceduralTexture>;
  91330. /** @hidden */
  91331. _generateMipMaps: boolean;
  91332. /** @hidden **/
  91333. _effect: Effect;
  91334. /** @hidden */
  91335. _textures: {
  91336. [key: string]: Texture;
  91337. };
  91338. /** @hidden */
  91339. protected _fallbackTexture: Nullable<Texture>;
  91340. private _size;
  91341. private _currentRefreshId;
  91342. private _frameId;
  91343. private _refreshRate;
  91344. private _vertexBuffers;
  91345. private _indexBuffer;
  91346. private _uniforms;
  91347. private _samplers;
  91348. private _fragment;
  91349. private _floats;
  91350. private _ints;
  91351. private _floatsArrays;
  91352. private _colors3;
  91353. private _colors4;
  91354. private _vectors2;
  91355. private _vectors3;
  91356. private _matrices;
  91357. private _fallbackTextureUsed;
  91358. private _fullEngine;
  91359. private _cachedDefines;
  91360. private _contentUpdateId;
  91361. private _contentData;
  91362. /**
  91363. * Instantiates a new procedural texture.
  91364. * 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.
  91365. * This is the base class of any Procedural texture and contains most of the shareable code.
  91366. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91367. * @param name Define the name of the texture
  91368. * @param size Define the size of the texture to create
  91369. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  91370. * @param scene Define the scene the texture belongs to
  91371. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  91372. * @param generateMipMaps Define if the texture should creates mip maps or not
  91373. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  91374. */
  91375. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  91376. /**
  91377. * The effect that is created when initializing the post process.
  91378. * @returns The created effect corresponding the the postprocess.
  91379. */
  91380. getEffect(): Effect;
  91381. /**
  91382. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  91383. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  91384. */
  91385. getContent(): Nullable<ArrayBufferView>;
  91386. private _createIndexBuffer;
  91387. /** @hidden */
  91388. _rebuild(): void;
  91389. /**
  91390. * Resets the texture in order to recreate its associated resources.
  91391. * This can be called in case of context loss
  91392. */
  91393. reset(): void;
  91394. protected _getDefines(): string;
  91395. /**
  91396. * Is the texture ready to be used ? (rendered at least once)
  91397. * @returns true if ready, otherwise, false.
  91398. */
  91399. isReady(): boolean;
  91400. /**
  91401. * Resets the refresh counter of the texture and start bak from scratch.
  91402. * Could be useful to regenerate the texture if it is setup to render only once.
  91403. */
  91404. resetRefreshCounter(): void;
  91405. /**
  91406. * Set the fragment shader to use in order to render the texture.
  91407. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  91408. */
  91409. setFragment(fragment: any): void;
  91410. /**
  91411. * Define the refresh rate of the texture or the rendering frequency.
  91412. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  91413. */
  91414. get refreshRate(): number;
  91415. set refreshRate(value: number);
  91416. /** @hidden */
  91417. _shouldRender(): boolean;
  91418. /**
  91419. * Get the size the texture is rendering at.
  91420. * @returns the size (texture is always squared)
  91421. */
  91422. getRenderSize(): number;
  91423. /**
  91424. * Resize the texture to new value.
  91425. * @param size Define the new size the texture should have
  91426. * @param generateMipMaps Define whether the new texture should create mip maps
  91427. */
  91428. resize(size: number, generateMipMaps: boolean): void;
  91429. private _checkUniform;
  91430. /**
  91431. * Set a texture in the shader program used to render.
  91432. * @param name Define the name of the uniform samplers as defined in the shader
  91433. * @param texture Define the texture to bind to this sampler
  91434. * @return the texture itself allowing "fluent" like uniform updates
  91435. */
  91436. setTexture(name: string, texture: Texture): ProceduralTexture;
  91437. /**
  91438. * Set a float in the shader.
  91439. * @param name Define the name of the uniform as defined in the shader
  91440. * @param value Define the value to give to the uniform
  91441. * @return the texture itself allowing "fluent" like uniform updates
  91442. */
  91443. setFloat(name: string, value: number): ProceduralTexture;
  91444. /**
  91445. * Set a int in the shader.
  91446. * @param name Define the name of the uniform as defined in the shader
  91447. * @param value Define the value to give to the uniform
  91448. * @return the texture itself allowing "fluent" like uniform updates
  91449. */
  91450. setInt(name: string, value: number): ProceduralTexture;
  91451. /**
  91452. * Set an array of floats in the shader.
  91453. * @param name Define the name of the uniform as defined in the shader
  91454. * @param value Define the value to give to the uniform
  91455. * @return the texture itself allowing "fluent" like uniform updates
  91456. */
  91457. setFloats(name: string, value: number[]): ProceduralTexture;
  91458. /**
  91459. * Set a vec3 in the shader from a Color3.
  91460. * @param name Define the name of the uniform as defined in the shader
  91461. * @param value Define the value to give to the uniform
  91462. * @return the texture itself allowing "fluent" like uniform updates
  91463. */
  91464. setColor3(name: string, value: Color3): ProceduralTexture;
  91465. /**
  91466. * Set a vec4 in the shader from a Color4.
  91467. * @param name Define the name of the uniform as defined in the shader
  91468. * @param value Define the value to give to the uniform
  91469. * @return the texture itself allowing "fluent" like uniform updates
  91470. */
  91471. setColor4(name: string, value: Color4): ProceduralTexture;
  91472. /**
  91473. * Set a vec2 in the shader from a Vector2.
  91474. * @param name Define the name of the uniform as defined in the shader
  91475. * @param value Define the value to give to the uniform
  91476. * @return the texture itself allowing "fluent" like uniform updates
  91477. */
  91478. setVector2(name: string, value: Vector2): ProceduralTexture;
  91479. /**
  91480. * Set a vec3 in the shader from a Vector3.
  91481. * @param name Define the name of the uniform as defined in the shader
  91482. * @param value Define the value to give to the uniform
  91483. * @return the texture itself allowing "fluent" like uniform updates
  91484. */
  91485. setVector3(name: string, value: Vector3): ProceduralTexture;
  91486. /**
  91487. * Set a mat4 in the shader from a MAtrix.
  91488. * @param name Define the name of the uniform as defined in the shader
  91489. * @param value Define the value to give to the uniform
  91490. * @return the texture itself allowing "fluent" like uniform updates
  91491. */
  91492. setMatrix(name: string, value: Matrix): ProceduralTexture;
  91493. /**
  91494. * Render the texture to its associated render target.
  91495. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  91496. */
  91497. render(useCameraPostProcess?: boolean): void;
  91498. /**
  91499. * Clone the texture.
  91500. * @returns the cloned texture
  91501. */
  91502. clone(): ProceduralTexture;
  91503. /**
  91504. * Dispose the texture and release its asoociated resources.
  91505. */
  91506. dispose(): void;
  91507. }
  91508. }
  91509. declare module BABYLON {
  91510. /**
  91511. * This represents the base class for particle system in Babylon.
  91512. * 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.
  91513. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  91514. * @example https://doc.babylonjs.com/babylon101/particles
  91515. */
  91516. export class BaseParticleSystem {
  91517. /**
  91518. * Source color is added to the destination color without alpha affecting the result
  91519. */
  91520. static BLENDMODE_ONEONE: number;
  91521. /**
  91522. * Blend current color and particle color using particle’s alpha
  91523. */
  91524. static BLENDMODE_STANDARD: number;
  91525. /**
  91526. * Add current color and particle color multiplied by particle’s alpha
  91527. */
  91528. static BLENDMODE_ADD: number;
  91529. /**
  91530. * Multiply current color with particle color
  91531. */
  91532. static BLENDMODE_MULTIPLY: number;
  91533. /**
  91534. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  91535. */
  91536. static BLENDMODE_MULTIPLYADD: number;
  91537. /**
  91538. * List of animations used by the particle system.
  91539. */
  91540. animations: Animation[];
  91541. /**
  91542. * Gets or sets the unique id of the particle system
  91543. */
  91544. uniqueId: number;
  91545. /**
  91546. * The id of the Particle system.
  91547. */
  91548. id: string;
  91549. /**
  91550. * The friendly name of the Particle system.
  91551. */
  91552. name: string;
  91553. /**
  91554. * Snippet ID if the particle system was created from the snippet server
  91555. */
  91556. snippetId: string;
  91557. /**
  91558. * The rendering group used by the Particle system to chose when to render.
  91559. */
  91560. renderingGroupId: number;
  91561. /**
  91562. * The emitter represents the Mesh or position we are attaching the particle system to.
  91563. */
  91564. emitter: Nullable<AbstractMesh | Vector3>;
  91565. /**
  91566. * The maximum number of particles to emit per frame
  91567. */
  91568. emitRate: number;
  91569. /**
  91570. * If you want to launch only a few particles at once, that can be done, as well.
  91571. */
  91572. manualEmitCount: number;
  91573. /**
  91574. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  91575. */
  91576. updateSpeed: number;
  91577. /**
  91578. * The amount of time the particle system is running (depends of the overall update speed).
  91579. */
  91580. targetStopDuration: number;
  91581. /**
  91582. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  91583. */
  91584. disposeOnStop: boolean;
  91585. /**
  91586. * Minimum power of emitting particles.
  91587. */
  91588. minEmitPower: number;
  91589. /**
  91590. * Maximum power of emitting particles.
  91591. */
  91592. maxEmitPower: number;
  91593. /**
  91594. * Minimum life time of emitting particles.
  91595. */
  91596. minLifeTime: number;
  91597. /**
  91598. * Maximum life time of emitting particles.
  91599. */
  91600. maxLifeTime: number;
  91601. /**
  91602. * Minimum Size of emitting particles.
  91603. */
  91604. minSize: number;
  91605. /**
  91606. * Maximum Size of emitting particles.
  91607. */
  91608. maxSize: number;
  91609. /**
  91610. * Minimum scale of emitting particles on X axis.
  91611. */
  91612. minScaleX: number;
  91613. /**
  91614. * Maximum scale of emitting particles on X axis.
  91615. */
  91616. maxScaleX: number;
  91617. /**
  91618. * Minimum scale of emitting particles on Y axis.
  91619. */
  91620. minScaleY: number;
  91621. /**
  91622. * Maximum scale of emitting particles on Y axis.
  91623. */
  91624. maxScaleY: number;
  91625. /**
  91626. * Gets or sets the minimal initial rotation in radians.
  91627. */
  91628. minInitialRotation: number;
  91629. /**
  91630. * Gets or sets the maximal initial rotation in radians.
  91631. */
  91632. maxInitialRotation: number;
  91633. /**
  91634. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  91635. */
  91636. minAngularSpeed: number;
  91637. /**
  91638. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  91639. */
  91640. maxAngularSpeed: number;
  91641. /**
  91642. * The texture used to render each particle. (this can be a spritesheet)
  91643. */
  91644. particleTexture: Nullable<BaseTexture>;
  91645. /**
  91646. * The layer mask we are rendering the particles through.
  91647. */
  91648. layerMask: number;
  91649. /**
  91650. * This can help using your own shader to render the particle system.
  91651. * The according effect will be created
  91652. */
  91653. customShader: any;
  91654. /**
  91655. * By default particle system starts as soon as they are created. This prevents the
  91656. * automatic start to happen and let you decide when to start emitting particles.
  91657. */
  91658. preventAutoStart: boolean;
  91659. private _noiseTexture;
  91660. /**
  91661. * Gets or sets a texture used to add random noise to particle positions
  91662. */
  91663. get noiseTexture(): Nullable<ProceduralTexture>;
  91664. set noiseTexture(value: Nullable<ProceduralTexture>);
  91665. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  91666. noiseStrength: Vector3;
  91667. /**
  91668. * Callback triggered when the particle animation is ending.
  91669. */
  91670. onAnimationEnd: Nullable<() => void>;
  91671. /**
  91672. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  91673. */
  91674. blendMode: number;
  91675. /**
  91676. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  91677. * to override the particles.
  91678. */
  91679. forceDepthWrite: boolean;
  91680. /** 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 */
  91681. preWarmCycles: number;
  91682. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  91683. preWarmStepOffset: number;
  91684. /**
  91685. * 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)
  91686. */
  91687. spriteCellChangeSpeed: number;
  91688. /**
  91689. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  91690. */
  91691. startSpriteCellID: number;
  91692. /**
  91693. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  91694. */
  91695. endSpriteCellID: number;
  91696. /**
  91697. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  91698. */
  91699. spriteCellWidth: number;
  91700. /**
  91701. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  91702. */
  91703. spriteCellHeight: number;
  91704. /**
  91705. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  91706. */
  91707. spriteRandomStartCell: boolean;
  91708. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  91709. translationPivot: Vector2;
  91710. /** @hidden */
  91711. protected _isAnimationSheetEnabled: boolean;
  91712. /**
  91713. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  91714. */
  91715. beginAnimationOnStart: boolean;
  91716. /**
  91717. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  91718. */
  91719. beginAnimationFrom: number;
  91720. /**
  91721. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  91722. */
  91723. beginAnimationTo: number;
  91724. /**
  91725. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  91726. */
  91727. beginAnimationLoop: boolean;
  91728. /**
  91729. * Gets or sets a world offset applied to all particles
  91730. */
  91731. worldOffset: Vector3;
  91732. /**
  91733. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  91734. */
  91735. get isAnimationSheetEnabled(): boolean;
  91736. set isAnimationSheetEnabled(value: boolean);
  91737. /**
  91738. * Get hosting scene
  91739. * @returns the scene
  91740. */
  91741. getScene(): Nullable<Scene>;
  91742. /**
  91743. * You can use gravity if you want to give an orientation to your particles.
  91744. */
  91745. gravity: Vector3;
  91746. protected _colorGradients: Nullable<Array<ColorGradient>>;
  91747. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  91748. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  91749. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  91750. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  91751. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  91752. protected _dragGradients: Nullable<Array<FactorGradient>>;
  91753. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  91754. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  91755. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  91756. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  91757. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  91758. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  91759. /**
  91760. * Defines the delay in milliseconds before starting the system (0 by default)
  91761. */
  91762. startDelay: number;
  91763. /**
  91764. * Gets the current list of drag gradients.
  91765. * You must use addDragGradient and removeDragGradient to udpate this list
  91766. * @returns the list of drag gradients
  91767. */
  91768. getDragGradients(): Nullable<Array<FactorGradient>>;
  91769. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  91770. limitVelocityDamping: number;
  91771. /**
  91772. * Gets the current list of limit velocity gradients.
  91773. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  91774. * @returns the list of limit velocity gradients
  91775. */
  91776. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  91777. /**
  91778. * Gets the current list of color gradients.
  91779. * You must use addColorGradient and removeColorGradient to udpate this list
  91780. * @returns the list of color gradients
  91781. */
  91782. getColorGradients(): Nullable<Array<ColorGradient>>;
  91783. /**
  91784. * Gets the current list of size gradients.
  91785. * You must use addSizeGradient and removeSizeGradient to udpate this list
  91786. * @returns the list of size gradients
  91787. */
  91788. getSizeGradients(): Nullable<Array<FactorGradient>>;
  91789. /**
  91790. * Gets the current list of color remap gradients.
  91791. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  91792. * @returns the list of color remap gradients
  91793. */
  91794. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  91795. /**
  91796. * Gets the current list of alpha remap gradients.
  91797. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  91798. * @returns the list of alpha remap gradients
  91799. */
  91800. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  91801. /**
  91802. * Gets the current list of life time gradients.
  91803. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  91804. * @returns the list of life time gradients
  91805. */
  91806. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  91807. /**
  91808. * Gets the current list of angular speed gradients.
  91809. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  91810. * @returns the list of angular speed gradients
  91811. */
  91812. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  91813. /**
  91814. * Gets the current list of velocity gradients.
  91815. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  91816. * @returns the list of velocity gradients
  91817. */
  91818. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  91819. /**
  91820. * Gets the current list of start size gradients.
  91821. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  91822. * @returns the list of start size gradients
  91823. */
  91824. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  91825. /**
  91826. * Gets the current list of emit rate gradients.
  91827. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  91828. * @returns the list of emit rate gradients
  91829. */
  91830. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  91831. /**
  91832. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91833. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91834. */
  91835. get direction1(): Vector3;
  91836. set direction1(value: Vector3);
  91837. /**
  91838. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91839. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91840. */
  91841. get direction2(): Vector3;
  91842. set direction2(value: Vector3);
  91843. /**
  91844. * 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.
  91845. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91846. */
  91847. get minEmitBox(): Vector3;
  91848. set minEmitBox(value: Vector3);
  91849. /**
  91850. * 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.
  91851. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91852. */
  91853. get maxEmitBox(): Vector3;
  91854. set maxEmitBox(value: Vector3);
  91855. /**
  91856. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91857. */
  91858. color1: Color4;
  91859. /**
  91860. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91861. */
  91862. color2: Color4;
  91863. /**
  91864. * Color the particle will have at the end of its lifetime
  91865. */
  91866. colorDead: Color4;
  91867. /**
  91868. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  91869. */
  91870. textureMask: Color4;
  91871. /**
  91872. * The particle emitter type defines the emitter used by the particle system.
  91873. * It can be for example box, sphere, or cone...
  91874. */
  91875. particleEmitterType: IParticleEmitterType;
  91876. /** @hidden */
  91877. _isSubEmitter: boolean;
  91878. /**
  91879. * Gets or sets the billboard mode to use when isBillboardBased = true.
  91880. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  91881. */
  91882. billboardMode: number;
  91883. protected _isBillboardBased: boolean;
  91884. /**
  91885. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  91886. */
  91887. get isBillboardBased(): boolean;
  91888. set isBillboardBased(value: boolean);
  91889. /**
  91890. * The scene the particle system belongs to.
  91891. */
  91892. protected _scene: Nullable<Scene>;
  91893. /**
  91894. * The engine the particle system belongs to.
  91895. */
  91896. protected _engine: ThinEngine;
  91897. /**
  91898. * Local cache of defines for image processing.
  91899. */
  91900. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  91901. /**
  91902. * Default configuration related to image processing available in the standard Material.
  91903. */
  91904. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  91905. /**
  91906. * Gets the image processing configuration used either in this material.
  91907. */
  91908. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  91909. /**
  91910. * Sets the Default image processing configuration used either in the this material.
  91911. *
  91912. * If sets to null, the scene one is in use.
  91913. */
  91914. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  91915. /**
  91916. * Attaches a new image processing configuration to the Standard Material.
  91917. * @param configuration
  91918. */
  91919. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  91920. /** @hidden */
  91921. protected _reset(): void;
  91922. /** @hidden */
  91923. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  91924. /**
  91925. * Instantiates a particle system.
  91926. * 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.
  91927. * @param name The name of the particle system
  91928. */
  91929. constructor(name: string);
  91930. /**
  91931. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  91932. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91933. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91934. * @returns the emitter
  91935. */
  91936. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  91937. /**
  91938. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  91939. * @param radius The radius of the hemisphere to emit from
  91940. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91941. * @returns the emitter
  91942. */
  91943. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  91944. /**
  91945. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  91946. * @param radius The radius of the sphere to emit from
  91947. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91948. * @returns the emitter
  91949. */
  91950. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  91951. /**
  91952. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  91953. * @param radius The radius of the sphere to emit from
  91954. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  91955. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  91956. * @returns the emitter
  91957. */
  91958. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  91959. /**
  91960. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  91961. * @param radius The radius of the emission cylinder
  91962. * @param height The height of the emission cylinder
  91963. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  91964. * @param directionRandomizer How much to randomize the particle direction [0-1]
  91965. * @returns the emitter
  91966. */
  91967. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  91968. /**
  91969. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  91970. * @param radius The radius of the cylinder to emit from
  91971. * @param height The height of the emission cylinder
  91972. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91973. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  91974. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  91975. * @returns the emitter
  91976. */
  91977. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  91978. /**
  91979. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  91980. * @param radius The radius of the cone to emit from
  91981. * @param angle The base angle of the cone
  91982. * @returns the emitter
  91983. */
  91984. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  91985. /**
  91986. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  91987. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91988. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91989. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  91990. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  91991. * @returns the emitter
  91992. */
  91993. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  91994. }
  91995. }
  91996. declare module BABYLON {
  91997. /**
  91998. * Type of sub emitter
  91999. */
  92000. export enum SubEmitterType {
  92001. /**
  92002. * Attached to the particle over it's lifetime
  92003. */
  92004. ATTACHED = 0,
  92005. /**
  92006. * Created when the particle dies
  92007. */
  92008. END = 1
  92009. }
  92010. /**
  92011. * Sub emitter class used to emit particles from an existing particle
  92012. */
  92013. export class SubEmitter {
  92014. /**
  92015. * the particle system to be used by the sub emitter
  92016. */
  92017. particleSystem: ParticleSystem;
  92018. /**
  92019. * Type of the submitter (Default: END)
  92020. */
  92021. type: SubEmitterType;
  92022. /**
  92023. * 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)
  92024. * Note: This only is supported when using an emitter of type Mesh
  92025. */
  92026. inheritDirection: boolean;
  92027. /**
  92028. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  92029. */
  92030. inheritedVelocityAmount: number;
  92031. /**
  92032. * Creates a sub emitter
  92033. * @param particleSystem the particle system to be used by the sub emitter
  92034. */
  92035. constructor(
  92036. /**
  92037. * the particle system to be used by the sub emitter
  92038. */
  92039. particleSystem: ParticleSystem);
  92040. /**
  92041. * Clones the sub emitter
  92042. * @returns the cloned sub emitter
  92043. */
  92044. clone(): SubEmitter;
  92045. /**
  92046. * Serialize current object to a JSON object
  92047. * @returns the serialized object
  92048. */
  92049. serialize(): any;
  92050. /** @hidden */
  92051. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  92052. /**
  92053. * Creates a new SubEmitter from a serialized JSON version
  92054. * @param serializationObject defines the JSON object to read from
  92055. * @param sceneOrEngine defines the hosting scene or the hosting engine
  92056. * @param rootUrl defines the rootUrl for data loading
  92057. * @returns a new SubEmitter
  92058. */
  92059. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  92060. /** Release associated resources */
  92061. dispose(): void;
  92062. }
  92063. }
  92064. declare module BABYLON {
  92065. /** @hidden */
  92066. export var imageProcessingDeclaration: {
  92067. name: string;
  92068. shader: string;
  92069. };
  92070. }
  92071. declare module BABYLON {
  92072. /** @hidden */
  92073. export var imageProcessingFunctions: {
  92074. name: string;
  92075. shader: string;
  92076. };
  92077. }
  92078. declare module BABYLON {
  92079. /** @hidden */
  92080. export var particlesPixelShader: {
  92081. name: string;
  92082. shader: string;
  92083. };
  92084. }
  92085. declare module BABYLON {
  92086. /** @hidden */
  92087. export var particlesVertexShader: {
  92088. name: string;
  92089. shader: string;
  92090. };
  92091. }
  92092. declare module BABYLON {
  92093. /**
  92094. * Interface used to define entities containing multiple clip planes
  92095. */
  92096. export interface IClipPlanesHolder {
  92097. /**
  92098. * Gets or sets the active clipplane 1
  92099. */
  92100. clipPlane: Nullable<Plane>;
  92101. /**
  92102. * Gets or sets the active clipplane 2
  92103. */
  92104. clipPlane2: Nullable<Plane>;
  92105. /**
  92106. * Gets or sets the active clipplane 3
  92107. */
  92108. clipPlane3: Nullable<Plane>;
  92109. /**
  92110. * Gets or sets the active clipplane 4
  92111. */
  92112. clipPlane4: Nullable<Plane>;
  92113. /**
  92114. * Gets or sets the active clipplane 5
  92115. */
  92116. clipPlane5: Nullable<Plane>;
  92117. /**
  92118. * Gets or sets the active clipplane 6
  92119. */
  92120. clipPlane6: Nullable<Plane>;
  92121. }
  92122. }
  92123. declare module BABYLON {
  92124. /**
  92125. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  92126. *
  92127. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  92128. *
  92129. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  92130. */
  92131. export class ThinMaterialHelper {
  92132. /**
  92133. * Binds the clip plane information from the holder to the effect.
  92134. * @param effect The effect we are binding the data to
  92135. * @param holder The entity containing the clip plane information
  92136. */
  92137. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  92138. }
  92139. }
  92140. declare module BABYLON {
  92141. interface ThinEngine {
  92142. /**
  92143. * Sets alpha constants used by some alpha blending modes
  92144. * @param r defines the red component
  92145. * @param g defines the green component
  92146. * @param b defines the blue component
  92147. * @param a defines the alpha component
  92148. */
  92149. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  92150. /**
  92151. * Sets the current alpha mode
  92152. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  92153. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  92154. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92155. */
  92156. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  92157. /**
  92158. * Gets the current alpha mode
  92159. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92160. * @returns the current alpha mode
  92161. */
  92162. getAlphaMode(): number;
  92163. /**
  92164. * Sets the current alpha equation
  92165. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  92166. */
  92167. setAlphaEquation(equation: number): void;
  92168. /**
  92169. * Gets the current alpha equation.
  92170. * @returns the current alpha equation
  92171. */
  92172. getAlphaEquation(): number;
  92173. }
  92174. }
  92175. declare module BABYLON {
  92176. /**
  92177. * This represents a particle system in Babylon.
  92178. * 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.
  92179. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  92180. * @example https://doc.babylonjs.com/babylon101/particles
  92181. */
  92182. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  92183. /**
  92184. * Billboard mode will only apply to Y axis
  92185. */
  92186. static readonly BILLBOARDMODE_Y: number;
  92187. /**
  92188. * Billboard mode will apply to all axes
  92189. */
  92190. static readonly BILLBOARDMODE_ALL: number;
  92191. /**
  92192. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  92193. */
  92194. static readonly BILLBOARDMODE_STRETCHED: number;
  92195. /**
  92196. * This function can be defined to provide custom update for active particles.
  92197. * This function will be called instead of regular update (age, position, color, etc.).
  92198. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  92199. */
  92200. updateFunction: (particles: Particle[]) => void;
  92201. private _emitterWorldMatrix;
  92202. /**
  92203. * This function can be defined to specify initial direction for every new particle.
  92204. * It by default use the emitterType defined function
  92205. */
  92206. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92207. /**
  92208. * This function can be defined to specify initial position for every new particle.
  92209. * It by default use the emitterType defined function
  92210. */
  92211. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92212. /**
  92213. * @hidden
  92214. */
  92215. _inheritedVelocityOffset: Vector3;
  92216. /**
  92217. * An event triggered when the system is disposed
  92218. */
  92219. onDisposeObservable: Observable<IParticleSystem>;
  92220. private _onDisposeObserver;
  92221. /**
  92222. * Sets a callback that will be triggered when the system is disposed
  92223. */
  92224. set onDispose(callback: () => void);
  92225. private _particles;
  92226. private _epsilon;
  92227. private _capacity;
  92228. private _stockParticles;
  92229. private _newPartsExcess;
  92230. private _vertexData;
  92231. private _vertexBuffer;
  92232. private _vertexBuffers;
  92233. private _spriteBuffer;
  92234. private _indexBuffer;
  92235. private _effect;
  92236. private _customEffect;
  92237. private _cachedDefines;
  92238. private _scaledColorStep;
  92239. private _colorDiff;
  92240. private _scaledDirection;
  92241. private _scaledGravity;
  92242. private _currentRenderId;
  92243. private _alive;
  92244. private _useInstancing;
  92245. private _started;
  92246. private _stopped;
  92247. private _actualFrame;
  92248. private _scaledUpdateSpeed;
  92249. private _vertexBufferSize;
  92250. /** @hidden */
  92251. _currentEmitRateGradient: Nullable<FactorGradient>;
  92252. /** @hidden */
  92253. _currentEmitRate1: number;
  92254. /** @hidden */
  92255. _currentEmitRate2: number;
  92256. /** @hidden */
  92257. _currentStartSizeGradient: Nullable<FactorGradient>;
  92258. /** @hidden */
  92259. _currentStartSize1: number;
  92260. /** @hidden */
  92261. _currentStartSize2: number;
  92262. private readonly _rawTextureWidth;
  92263. private _rampGradientsTexture;
  92264. private _useRampGradients;
  92265. /** Gets or sets a matrix to use to compute projection */
  92266. defaultProjectionMatrix: Matrix;
  92267. /** Gets or sets a matrix to use to compute view */
  92268. defaultViewMatrix: Matrix;
  92269. /** Gets or sets a boolean indicating that ramp gradients must be used
  92270. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  92271. */
  92272. get useRampGradients(): boolean;
  92273. set useRampGradients(value: boolean);
  92274. /**
  92275. * 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.
  92276. * 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: [])
  92277. */
  92278. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  92279. private _subEmitters;
  92280. /**
  92281. * @hidden
  92282. * If the particle systems emitter should be disposed when the particle system is disposed
  92283. */
  92284. _disposeEmitterOnDispose: boolean;
  92285. /**
  92286. * The current active Sub-systems, this property is used by the root particle system only.
  92287. */
  92288. activeSubSystems: Array<ParticleSystem>;
  92289. /**
  92290. * Specifies if the particles are updated in emitter local space or world space
  92291. */
  92292. isLocal: boolean;
  92293. private _rootParticleSystem;
  92294. /**
  92295. * Gets the current list of active particles
  92296. */
  92297. get particles(): Particle[];
  92298. /**
  92299. * Gets the number of particles active at the same time.
  92300. * @returns The number of active particles.
  92301. */
  92302. getActiveCount(): number;
  92303. /**
  92304. * Returns the string "ParticleSystem"
  92305. * @returns a string containing the class name
  92306. */
  92307. getClassName(): string;
  92308. /**
  92309. * Gets a boolean indicating that the system is stopping
  92310. * @returns true if the system is currently stopping
  92311. */
  92312. isStopping(): boolean;
  92313. /**
  92314. * Gets the custom effect used to render the particles
  92315. * @param blendMode Blend mode for which the effect should be retrieved
  92316. * @returns The effect
  92317. */
  92318. getCustomEffect(blendMode?: number): Nullable<Effect>;
  92319. /**
  92320. * Sets the custom effect used to render the particles
  92321. * @param effect The effect to set
  92322. * @param blendMode Blend mode for which the effect should be set
  92323. */
  92324. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  92325. /** @hidden */
  92326. private _onBeforeDrawParticlesObservable;
  92327. /**
  92328. * Observable that will be called just before the particles are drawn
  92329. */
  92330. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  92331. /**
  92332. * Gets the name of the particle vertex shader
  92333. */
  92334. get vertexShaderName(): string;
  92335. /**
  92336. * Instantiates a particle system.
  92337. * 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.
  92338. * @param name The name of the particle system
  92339. * @param capacity The max number of particles alive at the same time
  92340. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  92341. * @param customEffect a custom effect used to change the way particles are rendered by default
  92342. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  92343. * @param epsilon Offset used to render the particles
  92344. */
  92345. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  92346. private _addFactorGradient;
  92347. private _removeFactorGradient;
  92348. /**
  92349. * Adds a new life time gradient
  92350. * @param gradient defines the gradient to use (between 0 and 1)
  92351. * @param factor defines the life time factor to affect to the specified gradient
  92352. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92353. * @returns the current particle system
  92354. */
  92355. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92356. /**
  92357. * Remove a specific life time gradient
  92358. * @param gradient defines the gradient to remove
  92359. * @returns the current particle system
  92360. */
  92361. removeLifeTimeGradient(gradient: number): IParticleSystem;
  92362. /**
  92363. * Adds a new size gradient
  92364. * @param gradient defines the gradient to use (between 0 and 1)
  92365. * @param factor defines the size factor to affect to the specified gradient
  92366. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92367. * @returns the current particle system
  92368. */
  92369. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92370. /**
  92371. * Remove a specific size gradient
  92372. * @param gradient defines the gradient to remove
  92373. * @returns the current particle system
  92374. */
  92375. removeSizeGradient(gradient: number): IParticleSystem;
  92376. /**
  92377. * Adds a new color remap gradient
  92378. * @param gradient defines the gradient to use (between 0 and 1)
  92379. * @param min defines the color remap minimal range
  92380. * @param max defines the color remap maximal range
  92381. * @returns the current particle system
  92382. */
  92383. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92384. /**
  92385. * Remove a specific color remap gradient
  92386. * @param gradient defines the gradient to remove
  92387. * @returns the current particle system
  92388. */
  92389. removeColorRemapGradient(gradient: number): IParticleSystem;
  92390. /**
  92391. * Adds a new alpha remap gradient
  92392. * @param gradient defines the gradient to use (between 0 and 1)
  92393. * @param min defines the alpha remap minimal range
  92394. * @param max defines the alpha remap maximal range
  92395. * @returns the current particle system
  92396. */
  92397. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92398. /**
  92399. * Remove a specific alpha remap gradient
  92400. * @param gradient defines the gradient to remove
  92401. * @returns the current particle system
  92402. */
  92403. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  92404. /**
  92405. * Adds a new angular speed gradient
  92406. * @param gradient defines the gradient to use (between 0 and 1)
  92407. * @param factor defines the angular speed to affect to the specified gradient
  92408. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92409. * @returns the current particle system
  92410. */
  92411. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92412. /**
  92413. * Remove a specific angular speed gradient
  92414. * @param gradient defines the gradient to remove
  92415. * @returns the current particle system
  92416. */
  92417. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  92418. /**
  92419. * Adds a new velocity gradient
  92420. * @param gradient defines the gradient to use (between 0 and 1)
  92421. * @param factor defines the velocity to affect to the specified gradient
  92422. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92423. * @returns the current particle system
  92424. */
  92425. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92426. /**
  92427. * Remove a specific velocity gradient
  92428. * @param gradient defines the gradient to remove
  92429. * @returns the current particle system
  92430. */
  92431. removeVelocityGradient(gradient: number): IParticleSystem;
  92432. /**
  92433. * Adds a new limit velocity gradient
  92434. * @param gradient defines the gradient to use (between 0 and 1)
  92435. * @param factor defines the limit velocity value to affect to the specified gradient
  92436. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92437. * @returns the current particle system
  92438. */
  92439. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92440. /**
  92441. * Remove a specific limit velocity gradient
  92442. * @param gradient defines the gradient to remove
  92443. * @returns the current particle system
  92444. */
  92445. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  92446. /**
  92447. * Adds a new drag gradient
  92448. * @param gradient defines the gradient to use (between 0 and 1)
  92449. * @param factor defines the drag value to affect to the specified gradient
  92450. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92451. * @returns the current particle system
  92452. */
  92453. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92454. /**
  92455. * Remove a specific drag gradient
  92456. * @param gradient defines the gradient to remove
  92457. * @returns the current particle system
  92458. */
  92459. removeDragGradient(gradient: number): IParticleSystem;
  92460. /**
  92461. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  92462. * @param gradient defines the gradient to use (between 0 and 1)
  92463. * @param factor defines the emit rate value to affect to the specified gradient
  92464. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92465. * @returns the current particle system
  92466. */
  92467. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92468. /**
  92469. * Remove a specific emit rate gradient
  92470. * @param gradient defines the gradient to remove
  92471. * @returns the current particle system
  92472. */
  92473. removeEmitRateGradient(gradient: number): IParticleSystem;
  92474. /**
  92475. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  92476. * @param gradient defines the gradient to use (between 0 and 1)
  92477. * @param factor defines the start size value to affect to the specified gradient
  92478. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92479. * @returns the current particle system
  92480. */
  92481. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92482. /**
  92483. * Remove a specific start size gradient
  92484. * @param gradient defines the gradient to remove
  92485. * @returns the current particle system
  92486. */
  92487. removeStartSizeGradient(gradient: number): IParticleSystem;
  92488. private _createRampGradientTexture;
  92489. /**
  92490. * Gets the current list of ramp gradients.
  92491. * You must use addRampGradient and removeRampGradient to udpate this list
  92492. * @returns the list of ramp gradients
  92493. */
  92494. getRampGradients(): Nullable<Array<Color3Gradient>>;
  92495. /** Force the system to rebuild all gradients that need to be resync */
  92496. forceRefreshGradients(): void;
  92497. private _syncRampGradientTexture;
  92498. /**
  92499. * Adds a new ramp gradient used to remap particle colors
  92500. * @param gradient defines the gradient to use (between 0 and 1)
  92501. * @param color defines the color to affect to the specified gradient
  92502. * @returns the current particle system
  92503. */
  92504. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  92505. /**
  92506. * Remove a specific ramp gradient
  92507. * @param gradient defines the gradient to remove
  92508. * @returns the current particle system
  92509. */
  92510. removeRampGradient(gradient: number): ParticleSystem;
  92511. /**
  92512. * Adds a new color gradient
  92513. * @param gradient defines the gradient to use (between 0 and 1)
  92514. * @param color1 defines the color to affect to the specified gradient
  92515. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  92516. * @returns this particle system
  92517. */
  92518. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  92519. /**
  92520. * Remove a specific color gradient
  92521. * @param gradient defines the gradient to remove
  92522. * @returns this particle system
  92523. */
  92524. removeColorGradient(gradient: number): IParticleSystem;
  92525. private _fetchR;
  92526. protected _reset(): void;
  92527. private _resetEffect;
  92528. private _createVertexBuffers;
  92529. private _createIndexBuffer;
  92530. /**
  92531. * Gets the maximum number of particles active at the same time.
  92532. * @returns The max number of active particles.
  92533. */
  92534. getCapacity(): number;
  92535. /**
  92536. * Gets whether there are still active particles in the system.
  92537. * @returns True if it is alive, otherwise false.
  92538. */
  92539. isAlive(): boolean;
  92540. /**
  92541. * Gets if the system has been started. (Note: this will still be true after stop is called)
  92542. * @returns True if it has been started, otherwise false.
  92543. */
  92544. isStarted(): boolean;
  92545. private _prepareSubEmitterInternalArray;
  92546. /**
  92547. * Starts the particle system and begins to emit
  92548. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  92549. */
  92550. start(delay?: number): void;
  92551. /**
  92552. * Stops the particle system.
  92553. * @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.
  92554. */
  92555. stop(stopSubEmitters?: boolean): void;
  92556. /**
  92557. * Remove all active particles
  92558. */
  92559. reset(): void;
  92560. /**
  92561. * @hidden (for internal use only)
  92562. */
  92563. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  92564. /**
  92565. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  92566. * Its lifetime will start back at 0.
  92567. */
  92568. recycleParticle: (particle: Particle) => void;
  92569. private _stopSubEmitters;
  92570. private _createParticle;
  92571. private _removeFromRoot;
  92572. private _emitFromParticle;
  92573. private _update;
  92574. /** @hidden */
  92575. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  92576. /** @hidden */
  92577. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  92578. /**
  92579. * Fill the defines array according to the current settings of the particle system
  92580. * @param defines Array to be updated
  92581. * @param blendMode blend mode to take into account when updating the array
  92582. */
  92583. fillDefines(defines: Array<string>, blendMode: number): void;
  92584. /**
  92585. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  92586. * @param uniforms Uniforms array to fill
  92587. * @param attributes Attributes array to fill
  92588. * @param samplers Samplers array to fill
  92589. */
  92590. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  92591. /** @hidden */
  92592. private _getEffect;
  92593. /**
  92594. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  92595. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  92596. */
  92597. animate(preWarmOnly?: boolean): void;
  92598. private _appendParticleVertices;
  92599. /**
  92600. * Rebuilds the particle system.
  92601. */
  92602. rebuild(): void;
  92603. /**
  92604. * Is this system ready to be used/rendered
  92605. * @return true if the system is ready
  92606. */
  92607. isReady(): boolean;
  92608. private _render;
  92609. /**
  92610. * Renders the particle system in its current state.
  92611. * @returns the current number of particles
  92612. */
  92613. render(): number;
  92614. /**
  92615. * Disposes the particle system and free the associated resources
  92616. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  92617. */
  92618. dispose(disposeTexture?: boolean): void;
  92619. /**
  92620. * Clones the particle system.
  92621. * @param name The name of the cloned object
  92622. * @param newEmitter The new emitter to use
  92623. * @returns the cloned particle system
  92624. */
  92625. clone(name: string, newEmitter: any): ParticleSystem;
  92626. /**
  92627. * Serializes the particle system to a JSON object
  92628. * @param serializeTexture defines if the texture must be serialized as well
  92629. * @returns the JSON object
  92630. */
  92631. serialize(serializeTexture?: boolean): any;
  92632. /** @hidden */
  92633. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  92634. /** @hidden */
  92635. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  92636. /**
  92637. * Parses a JSON object to create a particle system.
  92638. * @param parsedParticleSystem The JSON object to parse
  92639. * @param sceneOrEngine The scene or the engine to create the particle system in
  92640. * @param rootUrl The root url to use to load external dependencies like texture
  92641. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  92642. * @returns the Parsed particle system
  92643. */
  92644. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  92645. }
  92646. }
  92647. declare module BABYLON {
  92648. /**
  92649. * A particle represents one of the element emitted by a particle system.
  92650. * This is mainly define by its coordinates, direction, velocity and age.
  92651. */
  92652. export class Particle {
  92653. /**
  92654. * The particle system the particle belongs to.
  92655. */
  92656. particleSystem: ParticleSystem;
  92657. private static _Count;
  92658. /**
  92659. * Unique ID of the particle
  92660. */
  92661. id: number;
  92662. /**
  92663. * The world position of the particle in the scene.
  92664. */
  92665. position: Vector3;
  92666. /**
  92667. * The world direction of the particle in the scene.
  92668. */
  92669. direction: Vector3;
  92670. /**
  92671. * The color of the particle.
  92672. */
  92673. color: Color4;
  92674. /**
  92675. * The color change of the particle per step.
  92676. */
  92677. colorStep: Color4;
  92678. /**
  92679. * Defines how long will the life of the particle be.
  92680. */
  92681. lifeTime: number;
  92682. /**
  92683. * The current age of the particle.
  92684. */
  92685. age: number;
  92686. /**
  92687. * The current size of the particle.
  92688. */
  92689. size: number;
  92690. /**
  92691. * The current scale of the particle.
  92692. */
  92693. scale: Vector2;
  92694. /**
  92695. * The current angle of the particle.
  92696. */
  92697. angle: number;
  92698. /**
  92699. * Defines how fast is the angle changing.
  92700. */
  92701. angularSpeed: number;
  92702. /**
  92703. * Defines the cell index used by the particle to be rendered from a sprite.
  92704. */
  92705. cellIndex: number;
  92706. /**
  92707. * The information required to support color remapping
  92708. */
  92709. remapData: Vector4;
  92710. /** @hidden */
  92711. _randomCellOffset?: number;
  92712. /** @hidden */
  92713. _initialDirection: Nullable<Vector3>;
  92714. /** @hidden */
  92715. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  92716. /** @hidden */
  92717. _initialStartSpriteCellID: number;
  92718. /** @hidden */
  92719. _initialEndSpriteCellID: number;
  92720. /** @hidden */
  92721. _currentColorGradient: Nullable<ColorGradient>;
  92722. /** @hidden */
  92723. _currentColor1: Color4;
  92724. /** @hidden */
  92725. _currentColor2: Color4;
  92726. /** @hidden */
  92727. _currentSizeGradient: Nullable<FactorGradient>;
  92728. /** @hidden */
  92729. _currentSize1: number;
  92730. /** @hidden */
  92731. _currentSize2: number;
  92732. /** @hidden */
  92733. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  92734. /** @hidden */
  92735. _currentAngularSpeed1: number;
  92736. /** @hidden */
  92737. _currentAngularSpeed2: number;
  92738. /** @hidden */
  92739. _currentVelocityGradient: Nullable<FactorGradient>;
  92740. /** @hidden */
  92741. _currentVelocity1: number;
  92742. /** @hidden */
  92743. _currentVelocity2: number;
  92744. /** @hidden */
  92745. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  92746. /** @hidden */
  92747. _currentLimitVelocity1: number;
  92748. /** @hidden */
  92749. _currentLimitVelocity2: number;
  92750. /** @hidden */
  92751. _currentDragGradient: Nullable<FactorGradient>;
  92752. /** @hidden */
  92753. _currentDrag1: number;
  92754. /** @hidden */
  92755. _currentDrag2: number;
  92756. /** @hidden */
  92757. _randomNoiseCoordinates1: Vector3;
  92758. /** @hidden */
  92759. _randomNoiseCoordinates2: Vector3;
  92760. /** @hidden */
  92761. _localPosition?: Vector3;
  92762. /**
  92763. * Creates a new instance Particle
  92764. * @param particleSystem the particle system the particle belongs to
  92765. */
  92766. constructor(
  92767. /**
  92768. * The particle system the particle belongs to.
  92769. */
  92770. particleSystem: ParticleSystem);
  92771. private updateCellInfoFromSystem;
  92772. /**
  92773. * Defines how the sprite cell index is updated for the particle
  92774. */
  92775. updateCellIndex(): void;
  92776. /** @hidden */
  92777. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  92778. /** @hidden */
  92779. _inheritParticleInfoToSubEmitters(): void;
  92780. /** @hidden */
  92781. _reset(): void;
  92782. /**
  92783. * Copy the properties of particle to another one.
  92784. * @param other the particle to copy the information to.
  92785. */
  92786. copyTo(other: Particle): void;
  92787. }
  92788. }
  92789. declare module BABYLON {
  92790. /**
  92791. * Particle emitter represents a volume emitting particles.
  92792. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  92793. */
  92794. export interface IParticleEmitterType {
  92795. /**
  92796. * Called by the particle System when the direction is computed for the created particle.
  92797. * @param worldMatrix is the world matrix of the particle system
  92798. * @param directionToUpdate is the direction vector to update with the result
  92799. * @param particle is the particle we are computed the direction for
  92800. * @param isLocal defines if the direction should be set in local space
  92801. */
  92802. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92803. /**
  92804. * Called by the particle System when the position is computed for the created particle.
  92805. * @param worldMatrix is the world matrix of the particle system
  92806. * @param positionToUpdate is the position vector to update with the result
  92807. * @param particle is the particle we are computed the position for
  92808. * @param isLocal defines if the position should be set in local space
  92809. */
  92810. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92811. /**
  92812. * Clones the current emitter and returns a copy of it
  92813. * @returns the new emitter
  92814. */
  92815. clone(): IParticleEmitterType;
  92816. /**
  92817. * Called by the GPUParticleSystem to setup the update shader
  92818. * @param effect defines the update shader
  92819. */
  92820. applyToShader(effect: Effect): void;
  92821. /**
  92822. * Returns a string to use to update the GPU particles update shader
  92823. * @returns the effect defines string
  92824. */
  92825. getEffectDefines(): string;
  92826. /**
  92827. * Returns a string representing the class name
  92828. * @returns a string containing the class name
  92829. */
  92830. getClassName(): string;
  92831. /**
  92832. * Serializes the particle system to a JSON object.
  92833. * @returns the JSON object
  92834. */
  92835. serialize(): any;
  92836. /**
  92837. * Parse properties from a JSON object
  92838. * @param serializationObject defines the JSON object
  92839. * @param scene defines the hosting scene
  92840. */
  92841. parse(serializationObject: any, scene: Nullable<Scene>): void;
  92842. }
  92843. }
  92844. declare module BABYLON {
  92845. /**
  92846. * Particle emitter emitting particles from the inside of a box.
  92847. * It emits the particles randomly between 2 given directions.
  92848. */
  92849. export class BoxParticleEmitter implements IParticleEmitterType {
  92850. /**
  92851. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92852. */
  92853. direction1: Vector3;
  92854. /**
  92855. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92856. */
  92857. direction2: Vector3;
  92858. /**
  92859. * 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.
  92860. */
  92861. minEmitBox: Vector3;
  92862. /**
  92863. * 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.
  92864. */
  92865. maxEmitBox: Vector3;
  92866. /**
  92867. * Creates a new instance BoxParticleEmitter
  92868. */
  92869. constructor();
  92870. /**
  92871. * Called by the particle System when the direction is computed for the created particle.
  92872. * @param worldMatrix is the world matrix of the particle system
  92873. * @param directionToUpdate is the direction vector to update with the result
  92874. * @param particle is the particle we are computed the direction for
  92875. * @param isLocal defines if the direction should be set in local space
  92876. */
  92877. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92878. /**
  92879. * Called by the particle System when the position is computed for the created particle.
  92880. * @param worldMatrix is the world matrix of the particle system
  92881. * @param positionToUpdate is the position vector to update with the result
  92882. * @param particle is the particle we are computed the position for
  92883. * @param isLocal defines if the position should be set in local space
  92884. */
  92885. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92886. /**
  92887. * Clones the current emitter and returns a copy of it
  92888. * @returns the new emitter
  92889. */
  92890. clone(): BoxParticleEmitter;
  92891. /**
  92892. * Called by the GPUParticleSystem to setup the update shader
  92893. * @param effect defines the update shader
  92894. */
  92895. applyToShader(effect: Effect): void;
  92896. /**
  92897. * Returns a string to use to update the GPU particles update shader
  92898. * @returns a string containng the defines string
  92899. */
  92900. getEffectDefines(): string;
  92901. /**
  92902. * Returns the string "BoxParticleEmitter"
  92903. * @returns a string containing the class name
  92904. */
  92905. getClassName(): string;
  92906. /**
  92907. * Serializes the particle system to a JSON object.
  92908. * @returns the JSON object
  92909. */
  92910. serialize(): any;
  92911. /**
  92912. * Parse properties from a JSON object
  92913. * @param serializationObject defines the JSON object
  92914. */
  92915. parse(serializationObject: any): void;
  92916. }
  92917. }
  92918. declare module BABYLON {
  92919. /**
  92920. * Particle emitter emitting particles from the inside of a cone.
  92921. * It emits the particles alongside the cone volume from the base to the particle.
  92922. * The emission direction might be randomized.
  92923. */
  92924. export class ConeParticleEmitter implements IParticleEmitterType {
  92925. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92926. directionRandomizer: number;
  92927. private _radius;
  92928. private _angle;
  92929. private _height;
  92930. /**
  92931. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  92932. */
  92933. radiusRange: number;
  92934. /**
  92935. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  92936. */
  92937. heightRange: number;
  92938. /**
  92939. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  92940. */
  92941. emitFromSpawnPointOnly: boolean;
  92942. /**
  92943. * Gets or sets the radius of the emission cone
  92944. */
  92945. get radius(): number;
  92946. set radius(value: number);
  92947. /**
  92948. * Gets or sets the angle of the emission cone
  92949. */
  92950. get angle(): number;
  92951. set angle(value: number);
  92952. private _buildHeight;
  92953. /**
  92954. * Creates a new instance ConeParticleEmitter
  92955. * @param radius the radius of the emission cone (1 by default)
  92956. * @param angle the cone base angle (PI by default)
  92957. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  92958. */
  92959. constructor(radius?: number, angle?: number,
  92960. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92961. directionRandomizer?: number);
  92962. /**
  92963. * Called by the particle System when the direction is computed for the created particle.
  92964. * @param worldMatrix is the world matrix of the particle system
  92965. * @param directionToUpdate is the direction vector to update with the result
  92966. * @param particle is the particle we are computed the direction for
  92967. * @param isLocal defines if the direction should be set in local space
  92968. */
  92969. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92970. /**
  92971. * Called by the particle System when the position is computed for the created particle.
  92972. * @param worldMatrix is the world matrix of the particle system
  92973. * @param positionToUpdate is the position vector to update with the result
  92974. * @param particle is the particle we are computed the position for
  92975. * @param isLocal defines if the position should be set in local space
  92976. */
  92977. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92978. /**
  92979. * Clones the current emitter and returns a copy of it
  92980. * @returns the new emitter
  92981. */
  92982. clone(): ConeParticleEmitter;
  92983. /**
  92984. * Called by the GPUParticleSystem to setup the update shader
  92985. * @param effect defines the update shader
  92986. */
  92987. applyToShader(effect: Effect): void;
  92988. /**
  92989. * Returns a string to use to update the GPU particles update shader
  92990. * @returns a string containng the defines string
  92991. */
  92992. getEffectDefines(): string;
  92993. /**
  92994. * Returns the string "ConeParticleEmitter"
  92995. * @returns a string containing the class name
  92996. */
  92997. getClassName(): string;
  92998. /**
  92999. * Serializes the particle system to a JSON object.
  93000. * @returns the JSON object
  93001. */
  93002. serialize(): any;
  93003. /**
  93004. * Parse properties from a JSON object
  93005. * @param serializationObject defines the JSON object
  93006. */
  93007. parse(serializationObject: any): void;
  93008. }
  93009. }
  93010. declare module BABYLON {
  93011. /**
  93012. * Particle emitter emitting particles from the inside of a cylinder.
  93013. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  93014. */
  93015. export class CylinderParticleEmitter implements IParticleEmitterType {
  93016. /**
  93017. * The radius of the emission cylinder.
  93018. */
  93019. radius: number;
  93020. /**
  93021. * The height of the emission cylinder.
  93022. */
  93023. height: number;
  93024. /**
  93025. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93026. */
  93027. radiusRange: number;
  93028. /**
  93029. * How much to randomize the particle direction [0-1].
  93030. */
  93031. directionRandomizer: number;
  93032. /**
  93033. * Creates a new instance CylinderParticleEmitter
  93034. * @param radius the radius of the emission cylinder (1 by default)
  93035. * @param height the height of the emission cylinder (1 by default)
  93036. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93037. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93038. */
  93039. constructor(
  93040. /**
  93041. * The radius of the emission cylinder.
  93042. */
  93043. radius?: number,
  93044. /**
  93045. * The height of the emission cylinder.
  93046. */
  93047. height?: number,
  93048. /**
  93049. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93050. */
  93051. radiusRange?: number,
  93052. /**
  93053. * How much to randomize the particle direction [0-1].
  93054. */
  93055. directionRandomizer?: number);
  93056. /**
  93057. * Called by the particle System when the direction is computed for the created particle.
  93058. * @param worldMatrix is the world matrix of the particle system
  93059. * @param directionToUpdate is the direction vector to update with the result
  93060. * @param particle is the particle we are computed the direction for
  93061. * @param isLocal defines if the direction should be set in local space
  93062. */
  93063. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93064. /**
  93065. * Called by the particle System when the position is computed for the created particle.
  93066. * @param worldMatrix is the world matrix of the particle system
  93067. * @param positionToUpdate is the position vector to update with the result
  93068. * @param particle is the particle we are computed the position for
  93069. * @param isLocal defines if the position should be set in local space
  93070. */
  93071. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93072. /**
  93073. * Clones the current emitter and returns a copy of it
  93074. * @returns the new emitter
  93075. */
  93076. clone(): CylinderParticleEmitter;
  93077. /**
  93078. * Called by the GPUParticleSystem to setup the update shader
  93079. * @param effect defines the update shader
  93080. */
  93081. applyToShader(effect: Effect): void;
  93082. /**
  93083. * Returns a string to use to update the GPU particles update shader
  93084. * @returns a string containng the defines string
  93085. */
  93086. getEffectDefines(): string;
  93087. /**
  93088. * Returns the string "CylinderParticleEmitter"
  93089. * @returns a string containing the class name
  93090. */
  93091. getClassName(): string;
  93092. /**
  93093. * Serializes the particle system to a JSON object.
  93094. * @returns the JSON object
  93095. */
  93096. serialize(): any;
  93097. /**
  93098. * Parse properties from a JSON object
  93099. * @param serializationObject defines the JSON object
  93100. */
  93101. parse(serializationObject: any): void;
  93102. }
  93103. /**
  93104. * Particle emitter emitting particles from the inside of a cylinder.
  93105. * It emits the particles randomly between two vectors.
  93106. */
  93107. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  93108. /**
  93109. * The min limit of the emission direction.
  93110. */
  93111. direction1: Vector3;
  93112. /**
  93113. * The max limit of the emission direction.
  93114. */
  93115. direction2: Vector3;
  93116. /**
  93117. * Creates a new instance CylinderDirectedParticleEmitter
  93118. * @param radius the radius of the emission cylinder (1 by default)
  93119. * @param height the height of the emission cylinder (1 by default)
  93120. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93121. * @param direction1 the min limit of the emission direction (up vector by default)
  93122. * @param direction2 the max limit of the emission direction (up vector by default)
  93123. */
  93124. constructor(radius?: number, height?: number, radiusRange?: number,
  93125. /**
  93126. * The min limit of the emission direction.
  93127. */
  93128. direction1?: Vector3,
  93129. /**
  93130. * The max limit of the emission direction.
  93131. */
  93132. direction2?: Vector3);
  93133. /**
  93134. * Called by the particle System when the direction is computed for the created particle.
  93135. * @param worldMatrix is the world matrix of the particle system
  93136. * @param directionToUpdate is the direction vector to update with the result
  93137. * @param particle is the particle we are computed the direction for
  93138. */
  93139. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93140. /**
  93141. * Clones the current emitter and returns a copy of it
  93142. * @returns the new emitter
  93143. */
  93144. clone(): CylinderDirectedParticleEmitter;
  93145. /**
  93146. * Called by the GPUParticleSystem to setup the update shader
  93147. * @param effect defines the update shader
  93148. */
  93149. applyToShader(effect: Effect): void;
  93150. /**
  93151. * Returns a string to use to update the GPU particles update shader
  93152. * @returns a string containng the defines string
  93153. */
  93154. getEffectDefines(): string;
  93155. /**
  93156. * Returns the string "CylinderDirectedParticleEmitter"
  93157. * @returns a string containing the class name
  93158. */
  93159. getClassName(): string;
  93160. /**
  93161. * Serializes the particle system to a JSON object.
  93162. * @returns the JSON object
  93163. */
  93164. serialize(): any;
  93165. /**
  93166. * Parse properties from a JSON object
  93167. * @param serializationObject defines the JSON object
  93168. */
  93169. parse(serializationObject: any): void;
  93170. }
  93171. }
  93172. declare module BABYLON {
  93173. /**
  93174. * Particle emitter emitting particles from the inside of a hemisphere.
  93175. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  93176. */
  93177. export class HemisphericParticleEmitter implements IParticleEmitterType {
  93178. /**
  93179. * The radius of the emission hemisphere.
  93180. */
  93181. radius: number;
  93182. /**
  93183. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93184. */
  93185. radiusRange: number;
  93186. /**
  93187. * How much to randomize the particle direction [0-1].
  93188. */
  93189. directionRandomizer: number;
  93190. /**
  93191. * Creates a new instance HemisphericParticleEmitter
  93192. * @param radius the radius of the emission hemisphere (1 by default)
  93193. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93194. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93195. */
  93196. constructor(
  93197. /**
  93198. * The radius of the emission hemisphere.
  93199. */
  93200. radius?: number,
  93201. /**
  93202. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93203. */
  93204. radiusRange?: number,
  93205. /**
  93206. * How much to randomize the particle direction [0-1].
  93207. */
  93208. directionRandomizer?: number);
  93209. /**
  93210. * Called by the particle System when the direction is computed for the created particle.
  93211. * @param worldMatrix is the world matrix of the particle system
  93212. * @param directionToUpdate is the direction vector to update with the result
  93213. * @param particle is the particle we are computed the direction for
  93214. * @param isLocal defines if the direction should be set in local space
  93215. */
  93216. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93217. /**
  93218. * Called by the particle System when the position is computed for the created particle.
  93219. * @param worldMatrix is the world matrix of the particle system
  93220. * @param positionToUpdate is the position vector to update with the result
  93221. * @param particle is the particle we are computed the position for
  93222. * @param isLocal defines if the position should be set in local space
  93223. */
  93224. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93225. /**
  93226. * Clones the current emitter and returns a copy of it
  93227. * @returns the new emitter
  93228. */
  93229. clone(): HemisphericParticleEmitter;
  93230. /**
  93231. * Called by the GPUParticleSystem to setup the update shader
  93232. * @param effect defines the update shader
  93233. */
  93234. applyToShader(effect: Effect): void;
  93235. /**
  93236. * Returns a string to use to update the GPU particles update shader
  93237. * @returns a string containng the defines string
  93238. */
  93239. getEffectDefines(): string;
  93240. /**
  93241. * Returns the string "HemisphericParticleEmitter"
  93242. * @returns a string containing the class name
  93243. */
  93244. getClassName(): string;
  93245. /**
  93246. * Serializes the particle system to a JSON object.
  93247. * @returns the JSON object
  93248. */
  93249. serialize(): any;
  93250. /**
  93251. * Parse properties from a JSON object
  93252. * @param serializationObject defines the JSON object
  93253. */
  93254. parse(serializationObject: any): void;
  93255. }
  93256. }
  93257. declare module BABYLON {
  93258. /**
  93259. * Particle emitter emitting particles from a point.
  93260. * It emits the particles randomly between 2 given directions.
  93261. */
  93262. export class PointParticleEmitter implements IParticleEmitterType {
  93263. /**
  93264. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93265. */
  93266. direction1: Vector3;
  93267. /**
  93268. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93269. */
  93270. direction2: Vector3;
  93271. /**
  93272. * Creates a new instance PointParticleEmitter
  93273. */
  93274. constructor();
  93275. /**
  93276. * Called by the particle System when the direction is computed for the created particle.
  93277. * @param worldMatrix is the world matrix of the particle system
  93278. * @param directionToUpdate is the direction vector to update with the result
  93279. * @param particle is the particle we are computed the direction for
  93280. * @param isLocal defines if the direction should be set in local space
  93281. */
  93282. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93283. /**
  93284. * Called by the particle System when the position is computed for the created particle.
  93285. * @param worldMatrix is the world matrix of the particle system
  93286. * @param positionToUpdate is the position vector to update with the result
  93287. * @param particle is the particle we are computed the position for
  93288. * @param isLocal defines if the position should be set in local space
  93289. */
  93290. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93291. /**
  93292. * Clones the current emitter and returns a copy of it
  93293. * @returns the new emitter
  93294. */
  93295. clone(): PointParticleEmitter;
  93296. /**
  93297. * Called by the GPUParticleSystem to setup the update shader
  93298. * @param effect defines the update shader
  93299. */
  93300. applyToShader(effect: Effect): void;
  93301. /**
  93302. * Returns a string to use to update the GPU particles update shader
  93303. * @returns a string containng the defines string
  93304. */
  93305. getEffectDefines(): string;
  93306. /**
  93307. * Returns the string "PointParticleEmitter"
  93308. * @returns a string containing the class name
  93309. */
  93310. getClassName(): string;
  93311. /**
  93312. * Serializes the particle system to a JSON object.
  93313. * @returns the JSON object
  93314. */
  93315. serialize(): any;
  93316. /**
  93317. * Parse properties from a JSON object
  93318. * @param serializationObject defines the JSON object
  93319. */
  93320. parse(serializationObject: any): void;
  93321. }
  93322. }
  93323. declare module BABYLON {
  93324. /**
  93325. * Particle emitter emitting particles from the inside of a sphere.
  93326. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  93327. */
  93328. export class SphereParticleEmitter implements IParticleEmitterType {
  93329. /**
  93330. * The radius of the emission sphere.
  93331. */
  93332. radius: number;
  93333. /**
  93334. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93335. */
  93336. radiusRange: number;
  93337. /**
  93338. * How much to randomize the particle direction [0-1].
  93339. */
  93340. directionRandomizer: number;
  93341. /**
  93342. * Creates a new instance SphereParticleEmitter
  93343. * @param radius the radius of the emission sphere (1 by default)
  93344. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93345. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93346. */
  93347. constructor(
  93348. /**
  93349. * The radius of the emission sphere.
  93350. */
  93351. radius?: number,
  93352. /**
  93353. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93354. */
  93355. radiusRange?: number,
  93356. /**
  93357. * How much to randomize the particle direction [0-1].
  93358. */
  93359. directionRandomizer?: number);
  93360. /**
  93361. * Called by the particle System when the direction is computed for the created particle.
  93362. * @param worldMatrix is the world matrix of the particle system
  93363. * @param directionToUpdate is the direction vector to update with the result
  93364. * @param particle is the particle we are computed the direction for
  93365. * @param isLocal defines if the direction should be set in local space
  93366. */
  93367. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93368. /**
  93369. * Called by the particle System when the position is computed for the created particle.
  93370. * @param worldMatrix is the world matrix of the particle system
  93371. * @param positionToUpdate is the position vector to update with the result
  93372. * @param particle is the particle we are computed the position for
  93373. * @param isLocal defines if the position should be set in local space
  93374. */
  93375. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93376. /**
  93377. * Clones the current emitter and returns a copy of it
  93378. * @returns the new emitter
  93379. */
  93380. clone(): SphereParticleEmitter;
  93381. /**
  93382. * Called by the GPUParticleSystem to setup the update shader
  93383. * @param effect defines the update shader
  93384. */
  93385. applyToShader(effect: Effect): void;
  93386. /**
  93387. * Returns a string to use to update the GPU particles update shader
  93388. * @returns a string containng the defines string
  93389. */
  93390. getEffectDefines(): string;
  93391. /**
  93392. * Returns the string "SphereParticleEmitter"
  93393. * @returns a string containing the class name
  93394. */
  93395. getClassName(): string;
  93396. /**
  93397. * Serializes the particle system to a JSON object.
  93398. * @returns the JSON object
  93399. */
  93400. serialize(): any;
  93401. /**
  93402. * Parse properties from a JSON object
  93403. * @param serializationObject defines the JSON object
  93404. */
  93405. parse(serializationObject: any): void;
  93406. }
  93407. /**
  93408. * Particle emitter emitting particles from the inside of a sphere.
  93409. * It emits the particles randomly between two vectors.
  93410. */
  93411. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  93412. /**
  93413. * The min limit of the emission direction.
  93414. */
  93415. direction1: Vector3;
  93416. /**
  93417. * The max limit of the emission direction.
  93418. */
  93419. direction2: Vector3;
  93420. /**
  93421. * Creates a new instance SphereDirectedParticleEmitter
  93422. * @param radius the radius of the emission sphere (1 by default)
  93423. * @param direction1 the min limit of the emission direction (up vector by default)
  93424. * @param direction2 the max limit of the emission direction (up vector by default)
  93425. */
  93426. constructor(radius?: number,
  93427. /**
  93428. * The min limit of the emission direction.
  93429. */
  93430. direction1?: Vector3,
  93431. /**
  93432. * The max limit of the emission direction.
  93433. */
  93434. direction2?: Vector3);
  93435. /**
  93436. * Called by the particle System when the direction is computed for the created particle.
  93437. * @param worldMatrix is the world matrix of the particle system
  93438. * @param directionToUpdate is the direction vector to update with the result
  93439. * @param particle is the particle we are computed the direction for
  93440. */
  93441. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93442. /**
  93443. * Clones the current emitter and returns a copy of it
  93444. * @returns the new emitter
  93445. */
  93446. clone(): SphereDirectedParticleEmitter;
  93447. /**
  93448. * Called by the GPUParticleSystem to setup the update shader
  93449. * @param effect defines the update shader
  93450. */
  93451. applyToShader(effect: Effect): void;
  93452. /**
  93453. * Returns a string to use to update the GPU particles update shader
  93454. * @returns a string containng the defines string
  93455. */
  93456. getEffectDefines(): string;
  93457. /**
  93458. * Returns the string "SphereDirectedParticleEmitter"
  93459. * @returns a string containing the class name
  93460. */
  93461. getClassName(): string;
  93462. /**
  93463. * Serializes the particle system to a JSON object.
  93464. * @returns the JSON object
  93465. */
  93466. serialize(): any;
  93467. /**
  93468. * Parse properties from a JSON object
  93469. * @param serializationObject defines the JSON object
  93470. */
  93471. parse(serializationObject: any): void;
  93472. }
  93473. }
  93474. declare module BABYLON {
  93475. /**
  93476. * Particle emitter emitting particles from a custom list of positions.
  93477. */
  93478. export class CustomParticleEmitter implements IParticleEmitterType {
  93479. /**
  93480. * Gets or sets the position generator that will create the inital position of each particle.
  93481. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93482. */
  93483. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  93484. /**
  93485. * Gets or sets the destination generator that will create the final destination of each particle.
  93486. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93487. */
  93488. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  93489. /**
  93490. * Creates a new instance CustomParticleEmitter
  93491. */
  93492. constructor();
  93493. /**
  93494. * Called by the particle System when the direction is computed for the created particle.
  93495. * @param worldMatrix is the world matrix of the particle system
  93496. * @param directionToUpdate is the direction vector to update with the result
  93497. * @param particle is the particle we are computed the direction for
  93498. * @param isLocal defines if the direction should be set in local space
  93499. */
  93500. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93501. /**
  93502. * Called by the particle System when the position is computed for the created particle.
  93503. * @param worldMatrix is the world matrix of the particle system
  93504. * @param positionToUpdate is the position vector to update with the result
  93505. * @param particle is the particle we are computed the position for
  93506. * @param isLocal defines if the position should be set in local space
  93507. */
  93508. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93509. /**
  93510. * Clones the current emitter and returns a copy of it
  93511. * @returns the new emitter
  93512. */
  93513. clone(): CustomParticleEmitter;
  93514. /**
  93515. * Called by the GPUParticleSystem to setup the update shader
  93516. * @param effect defines the update shader
  93517. */
  93518. applyToShader(effect: Effect): void;
  93519. /**
  93520. * Returns a string to use to update the GPU particles update shader
  93521. * @returns a string containng the defines string
  93522. */
  93523. getEffectDefines(): string;
  93524. /**
  93525. * Returns the string "PointParticleEmitter"
  93526. * @returns a string containing the class name
  93527. */
  93528. getClassName(): string;
  93529. /**
  93530. * Serializes the particle system to a JSON object.
  93531. * @returns the JSON object
  93532. */
  93533. serialize(): any;
  93534. /**
  93535. * Parse properties from a JSON object
  93536. * @param serializationObject defines the JSON object
  93537. */
  93538. parse(serializationObject: any): void;
  93539. }
  93540. }
  93541. declare module BABYLON {
  93542. /**
  93543. * Particle emitter emitting particles from the inside of a box.
  93544. * It emits the particles randomly between 2 given directions.
  93545. */
  93546. export class MeshParticleEmitter implements IParticleEmitterType {
  93547. private _indices;
  93548. private _positions;
  93549. private _normals;
  93550. private _storedNormal;
  93551. private _mesh;
  93552. /**
  93553. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93554. */
  93555. direction1: Vector3;
  93556. /**
  93557. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93558. */
  93559. direction2: Vector3;
  93560. /**
  93561. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  93562. */
  93563. useMeshNormalsForDirection: boolean;
  93564. /** Defines the mesh to use as source */
  93565. get mesh(): Nullable<AbstractMesh>;
  93566. set mesh(value: Nullable<AbstractMesh>);
  93567. /**
  93568. * Creates a new instance MeshParticleEmitter
  93569. * @param mesh defines the mesh to use as source
  93570. */
  93571. constructor(mesh?: Nullable<AbstractMesh>);
  93572. /**
  93573. * Called by the particle System when the direction is computed for the created particle.
  93574. * @param worldMatrix is the world matrix of the particle system
  93575. * @param directionToUpdate is the direction vector to update with the result
  93576. * @param particle is the particle we are computed the direction for
  93577. * @param isLocal defines if the direction should be set in local space
  93578. */
  93579. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93580. /**
  93581. * Called by the particle System when the position is computed for the created particle.
  93582. * @param worldMatrix is the world matrix of the particle system
  93583. * @param positionToUpdate is the position vector to update with the result
  93584. * @param particle is the particle we are computed the position for
  93585. * @param isLocal defines if the position should be set in local space
  93586. */
  93587. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93588. /**
  93589. * Clones the current emitter and returns a copy of it
  93590. * @returns the new emitter
  93591. */
  93592. clone(): MeshParticleEmitter;
  93593. /**
  93594. * Called by the GPUParticleSystem to setup the update shader
  93595. * @param effect defines the update shader
  93596. */
  93597. applyToShader(effect: Effect): void;
  93598. /**
  93599. * Returns a string to use to update the GPU particles update shader
  93600. * @returns a string containng the defines string
  93601. */
  93602. getEffectDefines(): string;
  93603. /**
  93604. * Returns the string "BoxParticleEmitter"
  93605. * @returns a string containing the class name
  93606. */
  93607. getClassName(): string;
  93608. /**
  93609. * Serializes the particle system to a JSON object.
  93610. * @returns the JSON object
  93611. */
  93612. serialize(): any;
  93613. /**
  93614. * Parse properties from a JSON object
  93615. * @param serializationObject defines the JSON object
  93616. * @param scene defines the hosting scene
  93617. */
  93618. parse(serializationObject: any, scene: Nullable<Scene>): void;
  93619. }
  93620. }
  93621. declare module BABYLON {
  93622. /**
  93623. * Interface representing a particle system in Babylon.js.
  93624. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  93625. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  93626. */
  93627. export interface IParticleSystem {
  93628. /**
  93629. * List of animations used by the particle system.
  93630. */
  93631. animations: Animation[];
  93632. /**
  93633. * The id of the Particle system.
  93634. */
  93635. id: string;
  93636. /**
  93637. * The name of the Particle system.
  93638. */
  93639. name: string;
  93640. /**
  93641. * The emitter represents the Mesh or position we are attaching the particle system to.
  93642. */
  93643. emitter: Nullable<AbstractMesh | Vector3>;
  93644. /**
  93645. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  93646. */
  93647. isBillboardBased: boolean;
  93648. /**
  93649. * The rendering group used by the Particle system to chose when to render.
  93650. */
  93651. renderingGroupId: number;
  93652. /**
  93653. * The layer mask we are rendering the particles through.
  93654. */
  93655. layerMask: number;
  93656. /**
  93657. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  93658. */
  93659. updateSpeed: number;
  93660. /**
  93661. * The amount of time the particle system is running (depends of the overall update speed).
  93662. */
  93663. targetStopDuration: number;
  93664. /**
  93665. * The texture used to render each particle. (this can be a spritesheet)
  93666. */
  93667. particleTexture: Nullable<BaseTexture>;
  93668. /**
  93669. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  93670. */
  93671. blendMode: number;
  93672. /**
  93673. * Minimum life time of emitting particles.
  93674. */
  93675. minLifeTime: number;
  93676. /**
  93677. * Maximum life time of emitting particles.
  93678. */
  93679. maxLifeTime: number;
  93680. /**
  93681. * Minimum Size of emitting particles.
  93682. */
  93683. minSize: number;
  93684. /**
  93685. * Maximum Size of emitting particles.
  93686. */
  93687. maxSize: number;
  93688. /**
  93689. * Minimum scale of emitting particles on X axis.
  93690. */
  93691. minScaleX: number;
  93692. /**
  93693. * Maximum scale of emitting particles on X axis.
  93694. */
  93695. maxScaleX: number;
  93696. /**
  93697. * Minimum scale of emitting particles on Y axis.
  93698. */
  93699. minScaleY: number;
  93700. /**
  93701. * Maximum scale of emitting particles on Y axis.
  93702. */
  93703. maxScaleY: number;
  93704. /**
  93705. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93706. */
  93707. color1: Color4;
  93708. /**
  93709. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93710. */
  93711. color2: Color4;
  93712. /**
  93713. * Color the particle will have at the end of its lifetime.
  93714. */
  93715. colorDead: Color4;
  93716. /**
  93717. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  93718. */
  93719. emitRate: number;
  93720. /**
  93721. * You can use gravity if you want to give an orientation to your particles.
  93722. */
  93723. gravity: Vector3;
  93724. /**
  93725. * Minimum power of emitting particles.
  93726. */
  93727. minEmitPower: number;
  93728. /**
  93729. * Maximum power of emitting particles.
  93730. */
  93731. maxEmitPower: number;
  93732. /**
  93733. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  93734. */
  93735. minAngularSpeed: number;
  93736. /**
  93737. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  93738. */
  93739. maxAngularSpeed: number;
  93740. /**
  93741. * Gets or sets the minimal initial rotation in radians.
  93742. */
  93743. minInitialRotation: number;
  93744. /**
  93745. * Gets or sets the maximal initial rotation in radians.
  93746. */
  93747. maxInitialRotation: number;
  93748. /**
  93749. * The particle emitter type defines the emitter used by the particle system.
  93750. * It can be for example box, sphere, or cone...
  93751. */
  93752. particleEmitterType: Nullable<IParticleEmitterType>;
  93753. /**
  93754. * Defines the delay in milliseconds before starting the system (0 by default)
  93755. */
  93756. startDelay: number;
  93757. /**
  93758. * 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
  93759. */
  93760. preWarmCycles: number;
  93761. /**
  93762. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  93763. */
  93764. preWarmStepOffset: number;
  93765. /**
  93766. * 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)
  93767. */
  93768. spriteCellChangeSpeed: number;
  93769. /**
  93770. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  93771. */
  93772. startSpriteCellID: number;
  93773. /**
  93774. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  93775. */
  93776. endSpriteCellID: number;
  93777. /**
  93778. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  93779. */
  93780. spriteCellWidth: number;
  93781. /**
  93782. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  93783. */
  93784. spriteCellHeight: number;
  93785. /**
  93786. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  93787. */
  93788. spriteRandomStartCell: boolean;
  93789. /**
  93790. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  93791. */
  93792. isAnimationSheetEnabled: boolean;
  93793. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  93794. translationPivot: Vector2;
  93795. /**
  93796. * Gets or sets a texture used to add random noise to particle positions
  93797. */
  93798. noiseTexture: Nullable<BaseTexture>;
  93799. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  93800. noiseStrength: Vector3;
  93801. /**
  93802. * Gets or sets the billboard mode to use when isBillboardBased = true.
  93803. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  93804. */
  93805. billboardMode: number;
  93806. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  93807. limitVelocityDamping: number;
  93808. /**
  93809. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  93810. */
  93811. beginAnimationOnStart: boolean;
  93812. /**
  93813. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  93814. */
  93815. beginAnimationFrom: number;
  93816. /**
  93817. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  93818. */
  93819. beginAnimationTo: number;
  93820. /**
  93821. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  93822. */
  93823. beginAnimationLoop: boolean;
  93824. /**
  93825. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  93826. */
  93827. disposeOnStop: boolean;
  93828. /**
  93829. * Specifies if the particles are updated in emitter local space or world space
  93830. */
  93831. isLocal: boolean;
  93832. /** Snippet ID if the particle system was created from the snippet server */
  93833. snippetId: string;
  93834. /** Gets or sets a matrix to use to compute projection */
  93835. defaultProjectionMatrix: Matrix;
  93836. /**
  93837. * Gets the maximum number of particles active at the same time.
  93838. * @returns The max number of active particles.
  93839. */
  93840. getCapacity(): number;
  93841. /**
  93842. * Gets the number of particles active at the same time.
  93843. * @returns The number of active particles.
  93844. */
  93845. getActiveCount(): number;
  93846. /**
  93847. * Gets if the system has been started. (Note: this will still be true after stop is called)
  93848. * @returns True if it has been started, otherwise false.
  93849. */
  93850. isStarted(): boolean;
  93851. /**
  93852. * Animates the particle system for this frame.
  93853. */
  93854. animate(): void;
  93855. /**
  93856. * Renders the particle system in its current state.
  93857. * @returns the current number of particles
  93858. */
  93859. render(): number;
  93860. /**
  93861. * Dispose the particle system and frees its associated resources.
  93862. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  93863. */
  93864. dispose(disposeTexture?: boolean): void;
  93865. /**
  93866. * An event triggered when the system is disposed
  93867. */
  93868. onDisposeObservable: Observable<IParticleSystem>;
  93869. /**
  93870. * Clones the particle system.
  93871. * @param name The name of the cloned object
  93872. * @param newEmitter The new emitter to use
  93873. * @returns the cloned particle system
  93874. */
  93875. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  93876. /**
  93877. * Serializes the particle system to a JSON object
  93878. * @param serializeTexture defines if the texture must be serialized as well
  93879. * @returns the JSON object
  93880. */
  93881. serialize(serializeTexture: boolean): any;
  93882. /**
  93883. * Rebuild the particle system
  93884. */
  93885. rebuild(): void;
  93886. /** Force the system to rebuild all gradients that need to be resync */
  93887. forceRefreshGradients(): void;
  93888. /**
  93889. * Starts the particle system and begins to emit
  93890. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  93891. */
  93892. start(delay?: number): void;
  93893. /**
  93894. * Stops the particle system.
  93895. */
  93896. stop(): void;
  93897. /**
  93898. * Remove all active particles
  93899. */
  93900. reset(): void;
  93901. /**
  93902. * Gets a boolean indicating that the system is stopping
  93903. * @returns true if the system is currently stopping
  93904. */
  93905. isStopping(): boolean;
  93906. /**
  93907. * Is this system ready to be used/rendered
  93908. * @return true if the system is ready
  93909. */
  93910. isReady(): boolean;
  93911. /**
  93912. * Returns the string "ParticleSystem"
  93913. * @returns a string containing the class name
  93914. */
  93915. getClassName(): string;
  93916. /**
  93917. * Gets the custom effect used to render the particles
  93918. * @param blendMode Blend mode for which the effect should be retrieved
  93919. * @returns The effect
  93920. */
  93921. getCustomEffect(blendMode: number): Nullable<Effect>;
  93922. /**
  93923. * Sets the custom effect used to render the particles
  93924. * @param effect The effect to set
  93925. * @param blendMode Blend mode for which the effect should be set
  93926. */
  93927. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  93928. /**
  93929. * Fill the defines array according to the current settings of the particle system
  93930. * @param defines Array to be updated
  93931. * @param blendMode blend mode to take into account when updating the array
  93932. */
  93933. fillDefines(defines: Array<string>, blendMode: number): void;
  93934. /**
  93935. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  93936. * @param uniforms Uniforms array to fill
  93937. * @param attributes Attributes array to fill
  93938. * @param samplers Samplers array to fill
  93939. */
  93940. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  93941. /**
  93942. * Observable that will be called just before the particles are drawn
  93943. */
  93944. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  93945. /**
  93946. * Gets the name of the particle vertex shader
  93947. */
  93948. vertexShaderName: string;
  93949. /**
  93950. * Adds a new color gradient
  93951. * @param gradient defines the gradient to use (between 0 and 1)
  93952. * @param color1 defines the color to affect to the specified gradient
  93953. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  93954. * @returns the current particle system
  93955. */
  93956. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  93957. /**
  93958. * Remove a specific color gradient
  93959. * @param gradient defines the gradient to remove
  93960. * @returns the current particle system
  93961. */
  93962. removeColorGradient(gradient: number): IParticleSystem;
  93963. /**
  93964. * Adds a new size gradient
  93965. * @param gradient defines the gradient to use (between 0 and 1)
  93966. * @param factor defines the size factor to affect to the specified gradient
  93967. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93968. * @returns the current particle system
  93969. */
  93970. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93971. /**
  93972. * Remove a specific size gradient
  93973. * @param gradient defines the gradient to remove
  93974. * @returns the current particle system
  93975. */
  93976. removeSizeGradient(gradient: number): IParticleSystem;
  93977. /**
  93978. * Gets the current list of color gradients.
  93979. * You must use addColorGradient and removeColorGradient to udpate this list
  93980. * @returns the list of color gradients
  93981. */
  93982. getColorGradients(): Nullable<Array<ColorGradient>>;
  93983. /**
  93984. * Gets the current list of size gradients.
  93985. * You must use addSizeGradient and removeSizeGradient to udpate this list
  93986. * @returns the list of size gradients
  93987. */
  93988. getSizeGradients(): Nullable<Array<FactorGradient>>;
  93989. /**
  93990. * Gets the current list of angular speed gradients.
  93991. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  93992. * @returns the list of angular speed gradients
  93993. */
  93994. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  93995. /**
  93996. * Adds a new angular speed gradient
  93997. * @param gradient defines the gradient to use (between 0 and 1)
  93998. * @param factor defines the angular speed to affect to the specified gradient
  93999. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94000. * @returns the current particle system
  94001. */
  94002. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94003. /**
  94004. * Remove a specific angular speed gradient
  94005. * @param gradient defines the gradient to remove
  94006. * @returns the current particle system
  94007. */
  94008. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  94009. /**
  94010. * Gets the current list of velocity gradients.
  94011. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  94012. * @returns the list of velocity gradients
  94013. */
  94014. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  94015. /**
  94016. * Adds a new velocity gradient
  94017. * @param gradient defines the gradient to use (between 0 and 1)
  94018. * @param factor defines the velocity to affect to the specified gradient
  94019. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94020. * @returns the current particle system
  94021. */
  94022. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94023. /**
  94024. * Remove a specific velocity gradient
  94025. * @param gradient defines the gradient to remove
  94026. * @returns the current particle system
  94027. */
  94028. removeVelocityGradient(gradient: number): IParticleSystem;
  94029. /**
  94030. * Gets the current list of limit velocity gradients.
  94031. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  94032. * @returns the list of limit velocity gradients
  94033. */
  94034. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  94035. /**
  94036. * Adds a new limit velocity gradient
  94037. * @param gradient defines the gradient to use (between 0 and 1)
  94038. * @param factor defines the limit velocity to affect to the specified gradient
  94039. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94040. * @returns the current particle system
  94041. */
  94042. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94043. /**
  94044. * Remove a specific limit velocity gradient
  94045. * @param gradient defines the gradient to remove
  94046. * @returns the current particle system
  94047. */
  94048. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  94049. /**
  94050. * Adds a new drag gradient
  94051. * @param gradient defines the gradient to use (between 0 and 1)
  94052. * @param factor defines the drag to affect to the specified gradient
  94053. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94054. * @returns the current particle system
  94055. */
  94056. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94057. /**
  94058. * Remove a specific drag gradient
  94059. * @param gradient defines the gradient to remove
  94060. * @returns the current particle system
  94061. */
  94062. removeDragGradient(gradient: number): IParticleSystem;
  94063. /**
  94064. * Gets the current list of drag gradients.
  94065. * You must use addDragGradient and removeDragGradient to udpate this list
  94066. * @returns the list of drag gradients
  94067. */
  94068. getDragGradients(): Nullable<Array<FactorGradient>>;
  94069. /**
  94070. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  94071. * @param gradient defines the gradient to use (between 0 and 1)
  94072. * @param factor defines the emit rate to affect to the specified gradient
  94073. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94074. * @returns the current particle system
  94075. */
  94076. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94077. /**
  94078. * Remove a specific emit rate gradient
  94079. * @param gradient defines the gradient to remove
  94080. * @returns the current particle system
  94081. */
  94082. removeEmitRateGradient(gradient: number): IParticleSystem;
  94083. /**
  94084. * Gets the current list of emit rate gradients.
  94085. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  94086. * @returns the list of emit rate gradients
  94087. */
  94088. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  94089. /**
  94090. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  94091. * @param gradient defines the gradient to use (between 0 and 1)
  94092. * @param factor defines the start size to affect to the specified gradient
  94093. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94094. * @returns the current particle system
  94095. */
  94096. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94097. /**
  94098. * Remove a specific start size gradient
  94099. * @param gradient defines the gradient to remove
  94100. * @returns the current particle system
  94101. */
  94102. removeStartSizeGradient(gradient: number): IParticleSystem;
  94103. /**
  94104. * Gets the current list of start size gradients.
  94105. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  94106. * @returns the list of start size gradients
  94107. */
  94108. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  94109. /**
  94110. * Adds a new life time gradient
  94111. * @param gradient defines the gradient to use (between 0 and 1)
  94112. * @param factor defines the life time factor to affect to the specified gradient
  94113. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94114. * @returns the current particle system
  94115. */
  94116. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94117. /**
  94118. * Remove a specific life time gradient
  94119. * @param gradient defines the gradient to remove
  94120. * @returns the current particle system
  94121. */
  94122. removeLifeTimeGradient(gradient: number): IParticleSystem;
  94123. /**
  94124. * Gets the current list of life time gradients.
  94125. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  94126. * @returns the list of life time gradients
  94127. */
  94128. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  94129. /**
  94130. * Gets the current list of color gradients.
  94131. * You must use addColorGradient and removeColorGradient to udpate this list
  94132. * @returns the list of color gradients
  94133. */
  94134. getColorGradients(): Nullable<Array<ColorGradient>>;
  94135. /**
  94136. * Adds a new ramp gradient used to remap particle colors
  94137. * @param gradient defines the gradient to use (between 0 and 1)
  94138. * @param color defines the color to affect to the specified gradient
  94139. * @returns the current particle system
  94140. */
  94141. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  94142. /**
  94143. * Gets the current list of ramp gradients.
  94144. * You must use addRampGradient and removeRampGradient to udpate this list
  94145. * @returns the list of ramp gradients
  94146. */
  94147. getRampGradients(): Nullable<Array<Color3Gradient>>;
  94148. /** Gets or sets a boolean indicating that ramp gradients must be used
  94149. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  94150. */
  94151. useRampGradients: boolean;
  94152. /**
  94153. * Adds a new color remap gradient
  94154. * @param gradient defines the gradient to use (between 0 and 1)
  94155. * @param min defines the color remap minimal range
  94156. * @param max defines the color remap maximal range
  94157. * @returns the current particle system
  94158. */
  94159. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94160. /**
  94161. * Gets the current list of color remap gradients.
  94162. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  94163. * @returns the list of color remap gradients
  94164. */
  94165. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  94166. /**
  94167. * Adds a new alpha remap gradient
  94168. * @param gradient defines the gradient to use (between 0 and 1)
  94169. * @param min defines the alpha remap minimal range
  94170. * @param max defines the alpha remap maximal range
  94171. * @returns the current particle system
  94172. */
  94173. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94174. /**
  94175. * Gets the current list of alpha remap gradients.
  94176. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  94177. * @returns the list of alpha remap gradients
  94178. */
  94179. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  94180. /**
  94181. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  94182. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94183. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94184. * @returns the emitter
  94185. */
  94186. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  94187. /**
  94188. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  94189. * @param radius The radius of the hemisphere to emit from
  94190. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94191. * @returns the emitter
  94192. */
  94193. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  94194. /**
  94195. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  94196. * @param radius The radius of the sphere to emit from
  94197. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94198. * @returns the emitter
  94199. */
  94200. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  94201. /**
  94202. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  94203. * @param radius The radius of the sphere to emit from
  94204. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  94205. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  94206. * @returns the emitter
  94207. */
  94208. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94209. /**
  94210. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  94211. * @param radius The radius of the emission cylinder
  94212. * @param height The height of the emission cylinder
  94213. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  94214. * @param directionRandomizer How much to randomize the particle direction [0-1]
  94215. * @returns the emitter
  94216. */
  94217. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  94218. /**
  94219. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  94220. * @param radius The radius of the cylinder to emit from
  94221. * @param height The height of the emission cylinder
  94222. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94223. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  94224. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  94225. * @returns the emitter
  94226. */
  94227. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94228. /**
  94229. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  94230. * @param radius The radius of the cone to emit from
  94231. * @param angle The base angle of the cone
  94232. * @returns the emitter
  94233. */
  94234. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  94235. /**
  94236. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  94237. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94238. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94239. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94240. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94241. * @returns the emitter
  94242. */
  94243. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  94244. /**
  94245. * Get hosting scene
  94246. * @returns the scene
  94247. */
  94248. getScene(): Nullable<Scene>;
  94249. }
  94250. }
  94251. declare module BABYLON {
  94252. /**
  94253. * 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.
  94254. * @see https://doc.babylonjs.com/how_to/transformnode
  94255. */
  94256. export class TransformNode extends Node {
  94257. /**
  94258. * Object will not rotate to face the camera
  94259. */
  94260. static BILLBOARDMODE_NONE: number;
  94261. /**
  94262. * Object will rotate to face the camera but only on the x axis
  94263. */
  94264. static BILLBOARDMODE_X: number;
  94265. /**
  94266. * Object will rotate to face the camera but only on the y axis
  94267. */
  94268. static BILLBOARDMODE_Y: number;
  94269. /**
  94270. * Object will rotate to face the camera but only on the z axis
  94271. */
  94272. static BILLBOARDMODE_Z: number;
  94273. /**
  94274. * Object will rotate to face the camera
  94275. */
  94276. static BILLBOARDMODE_ALL: number;
  94277. /**
  94278. * Object will rotate to face the camera's position instead of orientation
  94279. */
  94280. static BILLBOARDMODE_USE_POSITION: number;
  94281. private static _TmpRotation;
  94282. private static _TmpScaling;
  94283. private static _TmpTranslation;
  94284. private _forward;
  94285. private _forwardInverted;
  94286. private _up;
  94287. private _right;
  94288. private _rightInverted;
  94289. private _position;
  94290. private _rotation;
  94291. private _rotationQuaternion;
  94292. protected _scaling: Vector3;
  94293. protected _isDirty: boolean;
  94294. private _transformToBoneReferal;
  94295. private _isAbsoluteSynced;
  94296. private _billboardMode;
  94297. /**
  94298. * Gets or sets the billboard mode. Default is 0.
  94299. *
  94300. * | Value | Type | Description |
  94301. * | --- | --- | --- |
  94302. * | 0 | BILLBOARDMODE_NONE | |
  94303. * | 1 | BILLBOARDMODE_X | |
  94304. * | 2 | BILLBOARDMODE_Y | |
  94305. * | 4 | BILLBOARDMODE_Z | |
  94306. * | 7 | BILLBOARDMODE_ALL | |
  94307. *
  94308. */
  94309. get billboardMode(): number;
  94310. set billboardMode(value: number);
  94311. private _preserveParentRotationForBillboard;
  94312. /**
  94313. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  94314. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  94315. */
  94316. get preserveParentRotationForBillboard(): boolean;
  94317. set preserveParentRotationForBillboard(value: boolean);
  94318. /**
  94319. * 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
  94320. */
  94321. scalingDeterminant: number;
  94322. private _infiniteDistance;
  94323. /**
  94324. * Gets or sets the distance of the object to max, often used by skybox
  94325. */
  94326. get infiniteDistance(): boolean;
  94327. set infiniteDistance(value: boolean);
  94328. /**
  94329. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  94330. * By default the system will update normals to compensate
  94331. */
  94332. ignoreNonUniformScaling: boolean;
  94333. /**
  94334. * 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
  94335. */
  94336. reIntegrateRotationIntoRotationQuaternion: boolean;
  94337. /** @hidden */
  94338. _poseMatrix: Nullable<Matrix>;
  94339. /** @hidden */
  94340. _localMatrix: Matrix;
  94341. private _usePivotMatrix;
  94342. private _absolutePosition;
  94343. private _absoluteScaling;
  94344. private _absoluteRotationQuaternion;
  94345. private _pivotMatrix;
  94346. private _pivotMatrixInverse;
  94347. protected _postMultiplyPivotMatrix: boolean;
  94348. protected _isWorldMatrixFrozen: boolean;
  94349. /** @hidden */
  94350. _indexInSceneTransformNodesArray: number;
  94351. /**
  94352. * An event triggered after the world matrix is updated
  94353. */
  94354. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  94355. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  94356. /**
  94357. * Gets a string identifying the name of the class
  94358. * @returns "TransformNode" string
  94359. */
  94360. getClassName(): string;
  94361. /**
  94362. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  94363. */
  94364. get position(): Vector3;
  94365. set position(newPosition: Vector3);
  94366. /**
  94367. * 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)).
  94368. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  94369. */
  94370. get rotation(): Vector3;
  94371. set rotation(newRotation: Vector3);
  94372. /**
  94373. * 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)).
  94374. */
  94375. get scaling(): Vector3;
  94376. set scaling(newScaling: Vector3);
  94377. /**
  94378. * 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).
  94379. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  94380. */
  94381. get rotationQuaternion(): Nullable<Quaternion>;
  94382. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  94383. /**
  94384. * The forward direction of that transform in world space.
  94385. */
  94386. get forward(): Vector3;
  94387. /**
  94388. * The up direction of that transform in world space.
  94389. */
  94390. get up(): Vector3;
  94391. /**
  94392. * The right direction of that transform in world space.
  94393. */
  94394. get right(): Vector3;
  94395. /**
  94396. * Copies the parameter passed Matrix into the mesh Pose matrix.
  94397. * @param matrix the matrix to copy the pose from
  94398. * @returns this TransformNode.
  94399. */
  94400. updatePoseMatrix(matrix: Matrix): TransformNode;
  94401. /**
  94402. * Returns the mesh Pose matrix.
  94403. * @returns the pose matrix
  94404. */
  94405. getPoseMatrix(): Matrix;
  94406. /** @hidden */
  94407. _isSynchronized(): boolean;
  94408. /** @hidden */
  94409. _initCache(): void;
  94410. /**
  94411. * Flag the transform node as dirty (Forcing it to update everything)
  94412. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  94413. * @returns this transform node
  94414. */
  94415. markAsDirty(property: string): TransformNode;
  94416. /**
  94417. * Returns the current mesh absolute position.
  94418. * Returns a Vector3.
  94419. */
  94420. get absolutePosition(): Vector3;
  94421. /**
  94422. * Returns the current mesh absolute scaling.
  94423. * Returns a Vector3.
  94424. */
  94425. get absoluteScaling(): Vector3;
  94426. /**
  94427. * Returns the current mesh absolute rotation.
  94428. * Returns a Quaternion.
  94429. */
  94430. get absoluteRotationQuaternion(): Quaternion;
  94431. /**
  94432. * Sets a new matrix to apply before all other transformation
  94433. * @param matrix defines the transform matrix
  94434. * @returns the current TransformNode
  94435. */
  94436. setPreTransformMatrix(matrix: Matrix): TransformNode;
  94437. /**
  94438. * Sets a new pivot matrix to the current node
  94439. * @param matrix defines the new pivot matrix to use
  94440. * @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
  94441. * @returns the current TransformNode
  94442. */
  94443. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  94444. /**
  94445. * Returns the mesh pivot matrix.
  94446. * Default : Identity.
  94447. * @returns the matrix
  94448. */
  94449. getPivotMatrix(): Matrix;
  94450. /**
  94451. * Instantiate (when possible) or clone that node with its hierarchy
  94452. * @param newParent defines the new parent to use for the instance (or clone)
  94453. * @param options defines options to configure how copy is done
  94454. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  94455. * @returns an instance (or a clone) of the current node with its hiearchy
  94456. */
  94457. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  94458. doNotInstantiate: boolean;
  94459. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  94460. /**
  94461. * Prevents the World matrix to be computed any longer
  94462. * @param newWorldMatrix defines an optional matrix to use as world matrix
  94463. * @returns the TransformNode.
  94464. */
  94465. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  94466. /**
  94467. * Allows back the World matrix computation.
  94468. * @returns the TransformNode.
  94469. */
  94470. unfreezeWorldMatrix(): this;
  94471. /**
  94472. * True if the World matrix has been frozen.
  94473. */
  94474. get isWorldMatrixFrozen(): boolean;
  94475. /**
  94476. * Retuns the mesh absolute position in the World.
  94477. * @returns a Vector3.
  94478. */
  94479. getAbsolutePosition(): Vector3;
  94480. /**
  94481. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  94482. * @param absolutePosition the absolute position to set
  94483. * @returns the TransformNode.
  94484. */
  94485. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  94486. /**
  94487. * Sets the mesh position in its local space.
  94488. * @param vector3 the position to set in localspace
  94489. * @returns the TransformNode.
  94490. */
  94491. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  94492. /**
  94493. * Returns the mesh position in the local space from the current World matrix values.
  94494. * @returns a new Vector3.
  94495. */
  94496. getPositionExpressedInLocalSpace(): Vector3;
  94497. /**
  94498. * Translates the mesh along the passed Vector3 in its local space.
  94499. * @param vector3 the distance to translate in localspace
  94500. * @returns the TransformNode.
  94501. */
  94502. locallyTranslate(vector3: Vector3): TransformNode;
  94503. private static _lookAtVectorCache;
  94504. /**
  94505. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  94506. * @param targetPoint the position (must be in same space as current mesh) to look at
  94507. * @param yawCor optional yaw (y-axis) correction in radians
  94508. * @param pitchCor optional pitch (x-axis) correction in radians
  94509. * @param rollCor optional roll (z-axis) correction in radians
  94510. * @param space the choosen space of the target
  94511. * @returns the TransformNode.
  94512. */
  94513. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  94514. /**
  94515. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94516. * This Vector3 is expressed in the World space.
  94517. * @param localAxis axis to rotate
  94518. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94519. */
  94520. getDirection(localAxis: Vector3): Vector3;
  94521. /**
  94522. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  94523. * localAxis is expressed in the mesh local space.
  94524. * result is computed in the Wordl space from the mesh World matrix.
  94525. * @param localAxis axis to rotate
  94526. * @param result the resulting transformnode
  94527. * @returns this TransformNode.
  94528. */
  94529. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  94530. /**
  94531. * Sets this transform node rotation to the given local axis.
  94532. * @param localAxis the axis in local space
  94533. * @param yawCor optional yaw (y-axis) correction in radians
  94534. * @param pitchCor optional pitch (x-axis) correction in radians
  94535. * @param rollCor optional roll (z-axis) correction in radians
  94536. * @returns this TransformNode
  94537. */
  94538. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  94539. /**
  94540. * Sets a new pivot point to the current node
  94541. * @param point defines the new pivot point to use
  94542. * @param space defines if the point is in world or local space (local by default)
  94543. * @returns the current TransformNode
  94544. */
  94545. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  94546. /**
  94547. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  94548. * @returns the pivot point
  94549. */
  94550. getPivotPoint(): Vector3;
  94551. /**
  94552. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  94553. * @param result the vector3 to store the result
  94554. * @returns this TransformNode.
  94555. */
  94556. getPivotPointToRef(result: Vector3): TransformNode;
  94557. /**
  94558. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  94559. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  94560. */
  94561. getAbsolutePivotPoint(): Vector3;
  94562. /**
  94563. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  94564. * @param result vector3 to store the result
  94565. * @returns this TransformNode.
  94566. */
  94567. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  94568. /**
  94569. * Defines the passed node as the parent of the current node.
  94570. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  94571. * @see https://doc.babylonjs.com/how_to/parenting
  94572. * @param node the node ot set as the parent
  94573. * @returns this TransformNode.
  94574. */
  94575. setParent(node: Nullable<Node>): TransformNode;
  94576. private _nonUniformScaling;
  94577. /**
  94578. * True if the scaling property of this object is non uniform eg. (1,2,1)
  94579. */
  94580. get nonUniformScaling(): boolean;
  94581. /** @hidden */
  94582. _updateNonUniformScalingState(value: boolean): boolean;
  94583. /**
  94584. * Attach the current TransformNode to another TransformNode associated with a bone
  94585. * @param bone Bone affecting the TransformNode
  94586. * @param affectedTransformNode TransformNode associated with the bone
  94587. * @returns this object
  94588. */
  94589. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  94590. /**
  94591. * Detach the transform node if its associated with a bone
  94592. * @returns this object
  94593. */
  94594. detachFromBone(): TransformNode;
  94595. private static _rotationAxisCache;
  94596. /**
  94597. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  94598. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94599. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94600. * The passed axis is also normalized.
  94601. * @param axis the axis to rotate around
  94602. * @param amount the amount to rotate in radians
  94603. * @param space Space to rotate in (Default: local)
  94604. * @returns the TransformNode.
  94605. */
  94606. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  94607. /**
  94608. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  94609. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94610. * The passed axis is also normalized. .
  94611. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  94612. * @param point the point to rotate around
  94613. * @param axis the axis to rotate around
  94614. * @param amount the amount to rotate in radians
  94615. * @returns the TransformNode
  94616. */
  94617. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  94618. /**
  94619. * Translates the mesh along the axis vector for the passed distance in the given space.
  94620. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94621. * @param axis the axis to translate in
  94622. * @param distance the distance to translate
  94623. * @param space Space to rotate in (Default: local)
  94624. * @returns the TransformNode.
  94625. */
  94626. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  94627. /**
  94628. * Adds a rotation step to the mesh current rotation.
  94629. * x, y, z are Euler angles expressed in radians.
  94630. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  94631. * This means this rotation is made in the mesh local space only.
  94632. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  94633. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  94634. * ```javascript
  94635. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  94636. * ```
  94637. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  94638. * 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.
  94639. * @param x Rotation to add
  94640. * @param y Rotation to add
  94641. * @param z Rotation to add
  94642. * @returns the TransformNode.
  94643. */
  94644. addRotation(x: number, y: number, z: number): TransformNode;
  94645. /**
  94646. * @hidden
  94647. */
  94648. protected _getEffectiveParent(): Nullable<Node>;
  94649. /**
  94650. * Computes the world matrix of the node
  94651. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  94652. * @returns the world matrix
  94653. */
  94654. computeWorldMatrix(force?: boolean): Matrix;
  94655. /**
  94656. * Resets this nodeTransform's local matrix to Matrix.Identity().
  94657. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  94658. */
  94659. resetLocalMatrix(independentOfChildren?: boolean): void;
  94660. protected _afterComputeWorldMatrix(): void;
  94661. /**
  94662. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  94663. * @param func callback function to add
  94664. *
  94665. * @returns the TransformNode.
  94666. */
  94667. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94668. /**
  94669. * Removes a registered callback function.
  94670. * @param func callback function to remove
  94671. * @returns the TransformNode.
  94672. */
  94673. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94674. /**
  94675. * Gets the position of the current mesh in camera space
  94676. * @param camera defines the camera to use
  94677. * @returns a position
  94678. */
  94679. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  94680. /**
  94681. * Returns the distance from the mesh to the active camera
  94682. * @param camera defines the camera to use
  94683. * @returns the distance
  94684. */
  94685. getDistanceToCamera(camera?: Nullable<Camera>): number;
  94686. /**
  94687. * Clone the current transform node
  94688. * @param name Name of the new clone
  94689. * @param newParent New parent for the clone
  94690. * @param doNotCloneChildren Do not clone children hierarchy
  94691. * @returns the new transform node
  94692. */
  94693. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  94694. /**
  94695. * Serializes the objects information.
  94696. * @param currentSerializationObject defines the object to serialize in
  94697. * @returns the serialized object
  94698. */
  94699. serialize(currentSerializationObject?: any): any;
  94700. /**
  94701. * Returns a new TransformNode object parsed from the source provided.
  94702. * @param parsedTransformNode is the source.
  94703. * @param scene the scne the object belongs to
  94704. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  94705. * @returns a new TransformNode object parsed from the source provided.
  94706. */
  94707. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  94708. /**
  94709. * Get all child-transformNodes of this node
  94710. * @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
  94711. * @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
  94712. * @returns an array of TransformNode
  94713. */
  94714. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  94715. /**
  94716. * Releases resources associated with this transform node.
  94717. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  94718. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  94719. */
  94720. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94721. /**
  94722. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  94723. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  94724. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  94725. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  94726. * @returns the current mesh
  94727. */
  94728. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  94729. private _syncAbsoluteScalingAndRotation;
  94730. }
  94731. }
  94732. declare module BABYLON {
  94733. /**
  94734. * Class used to override all child animations of a given target
  94735. */
  94736. export class AnimationPropertiesOverride {
  94737. /**
  94738. * Gets or sets a value indicating if animation blending must be used
  94739. */
  94740. enableBlending: boolean;
  94741. /**
  94742. * Gets or sets the blending speed to use when enableBlending is true
  94743. */
  94744. blendingSpeed: number;
  94745. /**
  94746. * Gets or sets the default loop mode to use
  94747. */
  94748. loopMode: number;
  94749. }
  94750. }
  94751. declare module BABYLON {
  94752. /**
  94753. * Class used to store bone information
  94754. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94755. */
  94756. export class Bone extends Node {
  94757. /**
  94758. * defines the bone name
  94759. */
  94760. name: string;
  94761. private static _tmpVecs;
  94762. private static _tmpQuat;
  94763. private static _tmpMats;
  94764. /**
  94765. * Gets the list of child bones
  94766. */
  94767. children: Bone[];
  94768. /** Gets the animations associated with this bone */
  94769. animations: Animation[];
  94770. /**
  94771. * Gets or sets bone length
  94772. */
  94773. length: number;
  94774. /**
  94775. * @hidden Internal only
  94776. * Set this value to map this bone to a different index in the transform matrices
  94777. * Set this value to -1 to exclude the bone from the transform matrices
  94778. */
  94779. _index: Nullable<number>;
  94780. private _skeleton;
  94781. private _localMatrix;
  94782. private _restPose;
  94783. private _bindPose;
  94784. private _baseMatrix;
  94785. private _absoluteTransform;
  94786. private _invertedAbsoluteTransform;
  94787. private _parent;
  94788. private _scalingDeterminant;
  94789. private _worldTransform;
  94790. private _localScaling;
  94791. private _localRotation;
  94792. private _localPosition;
  94793. private _needToDecompose;
  94794. private _needToCompose;
  94795. /** @hidden */
  94796. _linkedTransformNode: Nullable<TransformNode>;
  94797. /** @hidden */
  94798. _waitingTransformNodeId: Nullable<string>;
  94799. /** @hidden */
  94800. get _matrix(): Matrix;
  94801. /** @hidden */
  94802. set _matrix(value: Matrix);
  94803. /**
  94804. * Create a new bone
  94805. * @param name defines the bone name
  94806. * @param skeleton defines the parent skeleton
  94807. * @param parentBone defines the parent (can be null if the bone is the root)
  94808. * @param localMatrix defines the local matrix
  94809. * @param restPose defines the rest pose matrix
  94810. * @param baseMatrix defines the base matrix
  94811. * @param index defines index of the bone in the hiearchy
  94812. */
  94813. constructor(
  94814. /**
  94815. * defines the bone name
  94816. */
  94817. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  94818. /**
  94819. * Gets the current object class name.
  94820. * @return the class name
  94821. */
  94822. getClassName(): string;
  94823. /**
  94824. * Gets the parent skeleton
  94825. * @returns a skeleton
  94826. */
  94827. getSkeleton(): Skeleton;
  94828. /**
  94829. * Gets parent bone
  94830. * @returns a bone or null if the bone is the root of the bone hierarchy
  94831. */
  94832. getParent(): Nullable<Bone>;
  94833. /**
  94834. * Returns an array containing the root bones
  94835. * @returns an array containing the root bones
  94836. */
  94837. getChildren(): Array<Bone>;
  94838. /**
  94839. * Gets the node index in matrix array generated for rendering
  94840. * @returns the node index
  94841. */
  94842. getIndex(): number;
  94843. /**
  94844. * Sets the parent bone
  94845. * @param parent defines the parent (can be null if the bone is the root)
  94846. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94847. */
  94848. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  94849. /**
  94850. * Gets the local matrix
  94851. * @returns a matrix
  94852. */
  94853. getLocalMatrix(): Matrix;
  94854. /**
  94855. * Gets the base matrix (initial matrix which remains unchanged)
  94856. * @returns a matrix
  94857. */
  94858. getBaseMatrix(): Matrix;
  94859. /**
  94860. * Gets the rest pose matrix
  94861. * @returns a matrix
  94862. */
  94863. getRestPose(): Matrix;
  94864. /**
  94865. * Sets the rest pose matrix
  94866. * @param matrix the local-space rest pose to set for this bone
  94867. */
  94868. setRestPose(matrix: Matrix): void;
  94869. /**
  94870. * Gets the bind pose matrix
  94871. * @returns the bind pose matrix
  94872. */
  94873. getBindPose(): Matrix;
  94874. /**
  94875. * Sets the bind pose matrix
  94876. * @param matrix the local-space bind pose to set for this bone
  94877. */
  94878. setBindPose(matrix: Matrix): void;
  94879. /**
  94880. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  94881. */
  94882. getWorldMatrix(): Matrix;
  94883. /**
  94884. * Sets the local matrix to rest pose matrix
  94885. */
  94886. returnToRest(): void;
  94887. /**
  94888. * Gets the inverse of the absolute transform matrix.
  94889. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  94890. * @returns a matrix
  94891. */
  94892. getInvertedAbsoluteTransform(): Matrix;
  94893. /**
  94894. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  94895. * @returns a matrix
  94896. */
  94897. getAbsoluteTransform(): Matrix;
  94898. /**
  94899. * Links with the given transform node.
  94900. * The local matrix of this bone is copied from the transform node every frame.
  94901. * @param transformNode defines the transform node to link to
  94902. */
  94903. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  94904. /**
  94905. * Gets the node used to drive the bone's transformation
  94906. * @returns a transform node or null
  94907. */
  94908. getTransformNode(): Nullable<TransformNode>;
  94909. /** Gets or sets current position (in local space) */
  94910. get position(): Vector3;
  94911. set position(newPosition: Vector3);
  94912. /** Gets or sets current rotation (in local space) */
  94913. get rotation(): Vector3;
  94914. set rotation(newRotation: Vector3);
  94915. /** Gets or sets current rotation quaternion (in local space) */
  94916. get rotationQuaternion(): Quaternion;
  94917. set rotationQuaternion(newRotation: Quaternion);
  94918. /** Gets or sets current scaling (in local space) */
  94919. get scaling(): Vector3;
  94920. set scaling(newScaling: Vector3);
  94921. /**
  94922. * Gets the animation properties override
  94923. */
  94924. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  94925. private _decompose;
  94926. private _compose;
  94927. /**
  94928. * Update the base and local matrices
  94929. * @param matrix defines the new base or local matrix
  94930. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94931. * @param updateLocalMatrix defines if the local matrix should be updated
  94932. */
  94933. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  94934. /** @hidden */
  94935. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  94936. /**
  94937. * Flag the bone as dirty (Forcing it to update everything)
  94938. */
  94939. markAsDirty(): void;
  94940. /** @hidden */
  94941. _markAsDirtyAndCompose(): void;
  94942. private _markAsDirtyAndDecompose;
  94943. /**
  94944. * Translate the bone in local or world space
  94945. * @param vec The amount to translate the bone
  94946. * @param space The space that the translation is in
  94947. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94948. */
  94949. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94950. /**
  94951. * Set the postion of the bone in local or world space
  94952. * @param position The position to set the bone
  94953. * @param space The space that the position is in
  94954. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94955. */
  94956. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94957. /**
  94958. * Set the absolute position of the bone (world space)
  94959. * @param position The position to set the bone
  94960. * @param mesh The mesh that this bone is attached to
  94961. */
  94962. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  94963. /**
  94964. * Scale the bone on the x, y and z axes (in local space)
  94965. * @param x The amount to scale the bone on the x axis
  94966. * @param y The amount to scale the bone on the y axis
  94967. * @param z The amount to scale the bone on the z axis
  94968. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  94969. */
  94970. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  94971. /**
  94972. * Set the bone scaling in local space
  94973. * @param scale defines the scaling vector
  94974. */
  94975. setScale(scale: Vector3): void;
  94976. /**
  94977. * Gets the current scaling in local space
  94978. * @returns the current scaling vector
  94979. */
  94980. getScale(): Vector3;
  94981. /**
  94982. * Gets the current scaling in local space and stores it in a target vector
  94983. * @param result defines the target vector
  94984. */
  94985. getScaleToRef(result: Vector3): void;
  94986. /**
  94987. * Set the yaw, pitch, and roll of the bone in local or world space
  94988. * @param yaw The rotation of the bone on the y axis
  94989. * @param pitch The rotation of the bone on the x axis
  94990. * @param roll The rotation of the bone on the z axis
  94991. * @param space The space that the axes of rotation are in
  94992. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94993. */
  94994. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  94995. /**
  94996. * Add a rotation to the bone on an axis in local or world space
  94997. * @param axis The axis to rotate the bone on
  94998. * @param amount The amount to rotate the bone
  94999. * @param space The space that the axis is in
  95000. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95001. */
  95002. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  95003. /**
  95004. * Set the rotation of the bone to a particular axis angle in local or world space
  95005. * @param axis The axis to rotate the bone on
  95006. * @param angle The angle that the bone should be rotated to
  95007. * @param space The space that the axis is in
  95008. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95009. */
  95010. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  95011. /**
  95012. * Set the euler rotation of the bone in local of world space
  95013. * @param rotation The euler rotation that the bone should be set to
  95014. * @param space The space that the rotation is in
  95015. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95016. */
  95017. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95018. /**
  95019. * Set the quaternion rotation of the bone in local of world space
  95020. * @param quat The quaternion rotation that the bone should be set to
  95021. * @param space The space that the rotation is in
  95022. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95023. */
  95024. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  95025. /**
  95026. * Set the rotation matrix of the bone in local of world space
  95027. * @param rotMat The rotation matrix that the bone should be set to
  95028. * @param space The space that the rotation is in
  95029. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95030. */
  95031. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  95032. private _rotateWithMatrix;
  95033. private _getNegativeRotationToRef;
  95034. /**
  95035. * Get the position of the bone in local or world space
  95036. * @param space The space that the returned position is in
  95037. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95038. * @returns The position of the bone
  95039. */
  95040. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95041. /**
  95042. * Copy the position of the bone to a vector3 in local or world space
  95043. * @param space The space that the returned position is in
  95044. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95045. * @param result The vector3 to copy the position to
  95046. */
  95047. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  95048. /**
  95049. * Get the absolute position of the bone (world space)
  95050. * @param mesh The mesh that this bone is attached to
  95051. * @returns The absolute position of the bone
  95052. */
  95053. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  95054. /**
  95055. * Copy the absolute position of the bone (world space) to the result param
  95056. * @param mesh The mesh that this bone is attached to
  95057. * @param result The vector3 to copy the absolute position to
  95058. */
  95059. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  95060. /**
  95061. * Compute the absolute transforms of this bone and its children
  95062. */
  95063. computeAbsoluteTransforms(): void;
  95064. /**
  95065. * Get the world direction from an axis that is in the local space of the bone
  95066. * @param localAxis The local direction that is used to compute the world direction
  95067. * @param mesh The mesh that this bone is attached to
  95068. * @returns The world direction
  95069. */
  95070. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95071. /**
  95072. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  95073. * @param localAxis The local direction that is used to compute the world direction
  95074. * @param mesh The mesh that this bone is attached to
  95075. * @param result The vector3 that the world direction will be copied to
  95076. */
  95077. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95078. /**
  95079. * Get the euler rotation of the bone in local or world space
  95080. * @param space The space that the rotation should be in
  95081. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95082. * @returns The euler rotation
  95083. */
  95084. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95085. /**
  95086. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  95087. * @param space The space that the rotation should be in
  95088. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95089. * @param result The vector3 that the rotation should be copied to
  95090. */
  95091. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95092. /**
  95093. * Get the quaternion rotation of the bone in either local or world space
  95094. * @param space The space that the rotation should be in
  95095. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95096. * @returns The quaternion rotation
  95097. */
  95098. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  95099. /**
  95100. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  95101. * @param space The space that the rotation should be in
  95102. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95103. * @param result The quaternion that the rotation should be copied to
  95104. */
  95105. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  95106. /**
  95107. * Get the rotation matrix of the bone in local or world space
  95108. * @param space The space that the rotation should be in
  95109. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95110. * @returns The rotation matrix
  95111. */
  95112. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  95113. /**
  95114. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  95115. * @param space The space that the rotation should be in
  95116. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95117. * @param result The quaternion that the rotation should be copied to
  95118. */
  95119. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  95120. /**
  95121. * Get the world position of a point that is in the local space of the bone
  95122. * @param position The local position
  95123. * @param mesh The mesh that this bone is attached to
  95124. * @returns The world position
  95125. */
  95126. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95127. /**
  95128. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  95129. * @param position The local position
  95130. * @param mesh The mesh that this bone is attached to
  95131. * @param result The vector3 that the world position should be copied to
  95132. */
  95133. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95134. /**
  95135. * Get the local position of a point that is in world space
  95136. * @param position The world position
  95137. * @param mesh The mesh that this bone is attached to
  95138. * @returns The local position
  95139. */
  95140. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95141. /**
  95142. * Get the local position of a point that is in world space and copy it to the result param
  95143. * @param position The world position
  95144. * @param mesh The mesh that this bone is attached to
  95145. * @param result The vector3 that the local position should be copied to
  95146. */
  95147. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95148. }
  95149. }
  95150. declare module BABYLON {
  95151. /**
  95152. * Defines a runtime animation
  95153. */
  95154. export class RuntimeAnimation {
  95155. private _events;
  95156. /**
  95157. * The current frame of the runtime animation
  95158. */
  95159. private _currentFrame;
  95160. /**
  95161. * The animation used by the runtime animation
  95162. */
  95163. private _animation;
  95164. /**
  95165. * The target of the runtime animation
  95166. */
  95167. private _target;
  95168. /**
  95169. * The initiating animatable
  95170. */
  95171. private _host;
  95172. /**
  95173. * The original value of the runtime animation
  95174. */
  95175. private _originalValue;
  95176. /**
  95177. * The original blend value of the runtime animation
  95178. */
  95179. private _originalBlendValue;
  95180. /**
  95181. * The offsets cache of the runtime animation
  95182. */
  95183. private _offsetsCache;
  95184. /**
  95185. * The high limits cache of the runtime animation
  95186. */
  95187. private _highLimitsCache;
  95188. /**
  95189. * Specifies if the runtime animation has been stopped
  95190. */
  95191. private _stopped;
  95192. /**
  95193. * The blending factor of the runtime animation
  95194. */
  95195. private _blendingFactor;
  95196. /**
  95197. * The BabylonJS scene
  95198. */
  95199. private _scene;
  95200. /**
  95201. * The current value of the runtime animation
  95202. */
  95203. private _currentValue;
  95204. /** @hidden */
  95205. _animationState: _IAnimationState;
  95206. /**
  95207. * The active target of the runtime animation
  95208. */
  95209. private _activeTargets;
  95210. private _currentActiveTarget;
  95211. private _directTarget;
  95212. /**
  95213. * The target path of the runtime animation
  95214. */
  95215. private _targetPath;
  95216. /**
  95217. * The weight of the runtime animation
  95218. */
  95219. private _weight;
  95220. /**
  95221. * The ratio offset of the runtime animation
  95222. */
  95223. private _ratioOffset;
  95224. /**
  95225. * The previous delay of the runtime animation
  95226. */
  95227. private _previousDelay;
  95228. /**
  95229. * The previous ratio of the runtime animation
  95230. */
  95231. private _previousRatio;
  95232. private _enableBlending;
  95233. private _keys;
  95234. private _minFrame;
  95235. private _maxFrame;
  95236. private _minValue;
  95237. private _maxValue;
  95238. private _targetIsArray;
  95239. /**
  95240. * Gets the current frame of the runtime animation
  95241. */
  95242. get currentFrame(): number;
  95243. /**
  95244. * Gets the weight of the runtime animation
  95245. */
  95246. get weight(): number;
  95247. /**
  95248. * Gets the current value of the runtime animation
  95249. */
  95250. get currentValue(): any;
  95251. /**
  95252. * Gets the target path of the runtime animation
  95253. */
  95254. get targetPath(): string;
  95255. /**
  95256. * Gets the actual target of the runtime animation
  95257. */
  95258. get target(): any;
  95259. /**
  95260. * Gets the additive state of the runtime animation
  95261. */
  95262. get isAdditive(): boolean;
  95263. /** @hidden */
  95264. _onLoop: () => void;
  95265. /**
  95266. * Create a new RuntimeAnimation object
  95267. * @param target defines the target of the animation
  95268. * @param animation defines the source animation object
  95269. * @param scene defines the hosting scene
  95270. * @param host defines the initiating Animatable
  95271. */
  95272. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  95273. private _preparePath;
  95274. /**
  95275. * Gets the animation from the runtime animation
  95276. */
  95277. get animation(): Animation;
  95278. /**
  95279. * Resets the runtime animation to the beginning
  95280. * @param restoreOriginal defines whether to restore the target property to the original value
  95281. */
  95282. reset(restoreOriginal?: boolean): void;
  95283. /**
  95284. * Specifies if the runtime animation is stopped
  95285. * @returns Boolean specifying if the runtime animation is stopped
  95286. */
  95287. isStopped(): boolean;
  95288. /**
  95289. * Disposes of the runtime animation
  95290. */
  95291. dispose(): void;
  95292. /**
  95293. * Apply the interpolated value to the target
  95294. * @param currentValue defines the value computed by the animation
  95295. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  95296. */
  95297. setValue(currentValue: any, weight: number): void;
  95298. private _getOriginalValues;
  95299. private _setValue;
  95300. /**
  95301. * Gets the loop pmode of the runtime animation
  95302. * @returns Loop Mode
  95303. */
  95304. private _getCorrectLoopMode;
  95305. /**
  95306. * Move the current animation to a given frame
  95307. * @param frame defines the frame to move to
  95308. */
  95309. goToFrame(frame: number): void;
  95310. /**
  95311. * @hidden Internal use only
  95312. */
  95313. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  95314. /**
  95315. * Execute the current animation
  95316. * @param delay defines the delay to add to the current frame
  95317. * @param from defines the lower bound of the animation range
  95318. * @param to defines the upper bound of the animation range
  95319. * @param loop defines if the current animation must loop
  95320. * @param speedRatio defines the current speed ratio
  95321. * @param weight defines the weight of the animation (default is -1 so no weight)
  95322. * @param onLoop optional callback called when animation loops
  95323. * @returns a boolean indicating if the animation is running
  95324. */
  95325. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  95326. }
  95327. }
  95328. declare module BABYLON {
  95329. /**
  95330. * Class used to store an actual running animation
  95331. */
  95332. export class Animatable {
  95333. /** defines the target object */
  95334. target: any;
  95335. /** defines the starting frame number (default is 0) */
  95336. fromFrame: number;
  95337. /** defines the ending frame number (default is 100) */
  95338. toFrame: number;
  95339. /** defines if the animation must loop (default is false) */
  95340. loopAnimation: boolean;
  95341. /** defines a callback to call when animation ends if it is not looping */
  95342. onAnimationEnd?: (() => void) | null | undefined;
  95343. /** defines a callback to call when animation loops */
  95344. onAnimationLoop?: (() => void) | null | undefined;
  95345. /** defines whether the animation should be evaluated additively */
  95346. isAdditive: boolean;
  95347. private _localDelayOffset;
  95348. private _pausedDelay;
  95349. private _runtimeAnimations;
  95350. private _paused;
  95351. private _scene;
  95352. private _speedRatio;
  95353. private _weight;
  95354. private _syncRoot;
  95355. /**
  95356. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  95357. * This will only apply for non looping animation (default is true)
  95358. */
  95359. disposeOnEnd: boolean;
  95360. /**
  95361. * Gets a boolean indicating if the animation has started
  95362. */
  95363. animationStarted: boolean;
  95364. /**
  95365. * Observer raised when the animation ends
  95366. */
  95367. onAnimationEndObservable: Observable<Animatable>;
  95368. /**
  95369. * Observer raised when the animation loops
  95370. */
  95371. onAnimationLoopObservable: Observable<Animatable>;
  95372. /**
  95373. * Gets the root Animatable used to synchronize and normalize animations
  95374. */
  95375. get syncRoot(): Nullable<Animatable>;
  95376. /**
  95377. * Gets the current frame of the first RuntimeAnimation
  95378. * Used to synchronize Animatables
  95379. */
  95380. get masterFrame(): number;
  95381. /**
  95382. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  95383. */
  95384. get weight(): number;
  95385. set weight(value: number);
  95386. /**
  95387. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  95388. */
  95389. get speedRatio(): number;
  95390. set speedRatio(value: number);
  95391. /**
  95392. * Creates a new Animatable
  95393. * @param scene defines the hosting scene
  95394. * @param target defines the target object
  95395. * @param fromFrame defines the starting frame number (default is 0)
  95396. * @param toFrame defines the ending frame number (default is 100)
  95397. * @param loopAnimation defines if the animation must loop (default is false)
  95398. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  95399. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  95400. * @param animations defines a group of animation to add to the new Animatable
  95401. * @param onAnimationLoop defines a callback to call when animation loops
  95402. * @param isAdditive defines whether the animation should be evaluated additively
  95403. */
  95404. constructor(scene: Scene,
  95405. /** defines the target object */
  95406. target: any,
  95407. /** defines the starting frame number (default is 0) */
  95408. fromFrame?: number,
  95409. /** defines the ending frame number (default is 100) */
  95410. toFrame?: number,
  95411. /** defines if the animation must loop (default is false) */
  95412. loopAnimation?: boolean, speedRatio?: number,
  95413. /** defines a callback to call when animation ends if it is not looping */
  95414. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  95415. /** defines a callback to call when animation loops */
  95416. onAnimationLoop?: (() => void) | null | undefined,
  95417. /** defines whether the animation should be evaluated additively */
  95418. isAdditive?: boolean);
  95419. /**
  95420. * Synchronize and normalize current Animatable with a source Animatable
  95421. * This is useful when using animation weights and when animations are not of the same length
  95422. * @param root defines the root Animatable to synchronize with
  95423. * @returns the current Animatable
  95424. */
  95425. syncWith(root: Animatable): Animatable;
  95426. /**
  95427. * Gets the list of runtime animations
  95428. * @returns an array of RuntimeAnimation
  95429. */
  95430. getAnimations(): RuntimeAnimation[];
  95431. /**
  95432. * Adds more animations to the current animatable
  95433. * @param target defines the target of the animations
  95434. * @param animations defines the new animations to add
  95435. */
  95436. appendAnimations(target: any, animations: Animation[]): void;
  95437. /**
  95438. * Gets the source animation for a specific property
  95439. * @param property defines the propertyu to look for
  95440. * @returns null or the source animation for the given property
  95441. */
  95442. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  95443. /**
  95444. * Gets the runtime animation for a specific property
  95445. * @param property defines the propertyu to look for
  95446. * @returns null or the runtime animation for the given property
  95447. */
  95448. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  95449. /**
  95450. * Resets the animatable to its original state
  95451. */
  95452. reset(): void;
  95453. /**
  95454. * Allows the animatable to blend with current running animations
  95455. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95456. * @param blendingSpeed defines the blending speed to use
  95457. */
  95458. enableBlending(blendingSpeed: number): void;
  95459. /**
  95460. * Disable animation blending
  95461. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95462. */
  95463. disableBlending(): void;
  95464. /**
  95465. * Jump directly to a given frame
  95466. * @param frame defines the frame to jump to
  95467. */
  95468. goToFrame(frame: number): void;
  95469. /**
  95470. * Pause the animation
  95471. */
  95472. pause(): void;
  95473. /**
  95474. * Restart the animation
  95475. */
  95476. restart(): void;
  95477. private _raiseOnAnimationEnd;
  95478. /**
  95479. * Stop and delete the current animation
  95480. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  95481. * @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)
  95482. */
  95483. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  95484. /**
  95485. * Wait asynchronously for the animation to end
  95486. * @returns a promise which will be fullfilled when the animation ends
  95487. */
  95488. waitAsync(): Promise<Animatable>;
  95489. /** @hidden */
  95490. _animate(delay: number): boolean;
  95491. }
  95492. interface Scene {
  95493. /** @hidden */
  95494. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  95495. /** @hidden */
  95496. _processLateAnimationBindingsForMatrices(holder: {
  95497. totalWeight: number;
  95498. totalAdditiveWeight: number;
  95499. animations: RuntimeAnimation[];
  95500. additiveAnimations: RuntimeAnimation[];
  95501. originalValue: Matrix;
  95502. }): any;
  95503. /** @hidden */
  95504. _processLateAnimationBindingsForQuaternions(holder: {
  95505. totalWeight: number;
  95506. totalAdditiveWeight: number;
  95507. animations: RuntimeAnimation[];
  95508. additiveAnimations: RuntimeAnimation[];
  95509. originalValue: Quaternion;
  95510. }, refQuaternion: Quaternion): Quaternion;
  95511. /** @hidden */
  95512. _processLateAnimationBindings(): void;
  95513. /**
  95514. * Will start the animation sequence of a given target
  95515. * @param target defines the target
  95516. * @param from defines from which frame should animation start
  95517. * @param to defines until which frame should animation run.
  95518. * @param weight defines the weight to apply to the animation (1.0 by default)
  95519. * @param loop defines if the animation loops
  95520. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95521. * @param onAnimationEnd defines the function to be executed when the animation ends
  95522. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95523. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95524. * @param onAnimationLoop defines the callback to call when an animation loops
  95525. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95526. * @returns the animatable object created for this animation
  95527. */
  95528. 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;
  95529. /**
  95530. * Will start the animation sequence of a given target
  95531. * @param target defines the target
  95532. * @param from defines from which frame should animation start
  95533. * @param to defines until which frame should animation run.
  95534. * @param loop defines if the animation loops
  95535. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95536. * @param onAnimationEnd defines the function to be executed when the animation ends
  95537. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95538. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95539. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  95540. * @param onAnimationLoop defines the callback to call when an animation loops
  95541. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95542. * @returns the animatable object created for this animation
  95543. */
  95544. 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;
  95545. /**
  95546. * Will start the animation sequence of a given target and its hierarchy
  95547. * @param target defines the target
  95548. * @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.
  95549. * @param from defines from which frame should animation start
  95550. * @param to defines until which frame should animation run.
  95551. * @param loop defines if the animation loops
  95552. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95553. * @param onAnimationEnd defines the function to be executed when the animation ends
  95554. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95555. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95556. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95557. * @param onAnimationLoop defines the callback to call when an animation loops
  95558. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95559. * @returns the list of created animatables
  95560. */
  95561. 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[];
  95562. /**
  95563. * Begin a new animation on a given node
  95564. * @param target defines the target where the animation will take place
  95565. * @param animations defines the list of animations to start
  95566. * @param from defines the initial value
  95567. * @param to defines the final value
  95568. * @param loop defines if you want animation to loop (off by default)
  95569. * @param speedRatio defines the speed ratio to apply to all animations
  95570. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95571. * @param onAnimationLoop defines the callback to call when an animation loops
  95572. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95573. * @returns the list of created animatables
  95574. */
  95575. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  95576. /**
  95577. * Begin a new animation on a given node and its hierarchy
  95578. * @param target defines the root node where the animation will take place
  95579. * @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.
  95580. * @param animations defines the list of animations to start
  95581. * @param from defines the initial value
  95582. * @param to defines the final value
  95583. * @param loop defines if you want animation to loop (off by default)
  95584. * @param speedRatio defines the speed ratio to apply to all animations
  95585. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95586. * @param onAnimationLoop defines the callback to call when an animation loops
  95587. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95588. * @returns the list of animatables created for all nodes
  95589. */
  95590. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  95591. /**
  95592. * Gets the animatable associated with a specific target
  95593. * @param target defines the target of the animatable
  95594. * @returns the required animatable if found
  95595. */
  95596. getAnimatableByTarget(target: any): Nullable<Animatable>;
  95597. /**
  95598. * Gets all animatables associated with a given target
  95599. * @param target defines the target to look animatables for
  95600. * @returns an array of Animatables
  95601. */
  95602. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  95603. /**
  95604. * Stops and removes all animations that have been applied to the scene
  95605. */
  95606. stopAllAnimations(): void;
  95607. /**
  95608. * Gets the current delta time used by animation engine
  95609. */
  95610. deltaTime: number;
  95611. }
  95612. interface Bone {
  95613. /**
  95614. * Copy an animation range from another bone
  95615. * @param source defines the source bone
  95616. * @param rangeName defines the range name to copy
  95617. * @param frameOffset defines the frame offset
  95618. * @param rescaleAsRequired defines if rescaling must be applied if required
  95619. * @param skelDimensionsRatio defines the scaling ratio
  95620. * @returns true if operation was successful
  95621. */
  95622. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  95623. }
  95624. }
  95625. declare module BABYLON {
  95626. /**
  95627. * Class used to handle skinning animations
  95628. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  95629. */
  95630. export class Skeleton implements IAnimatable {
  95631. /** defines the skeleton name */
  95632. name: string;
  95633. /** defines the skeleton Id */
  95634. id: string;
  95635. /**
  95636. * Defines the list of child bones
  95637. */
  95638. bones: Bone[];
  95639. /**
  95640. * Defines an estimate of the dimension of the skeleton at rest
  95641. */
  95642. dimensionsAtRest: Vector3;
  95643. /**
  95644. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  95645. */
  95646. needInitialSkinMatrix: boolean;
  95647. /**
  95648. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  95649. */
  95650. overrideMesh: Nullable<AbstractMesh>;
  95651. /**
  95652. * Gets the list of animations attached to this skeleton
  95653. */
  95654. animations: Array<Animation>;
  95655. private _scene;
  95656. private _isDirty;
  95657. private _transformMatrices;
  95658. private _transformMatrixTexture;
  95659. private _meshesWithPoseMatrix;
  95660. private _animatables;
  95661. private _identity;
  95662. private _synchronizedWithMesh;
  95663. private _ranges;
  95664. private _lastAbsoluteTransformsUpdateId;
  95665. private _canUseTextureForBones;
  95666. private _uniqueId;
  95667. /** @hidden */
  95668. _numBonesWithLinkedTransformNode: number;
  95669. /** @hidden */
  95670. _hasWaitingData: Nullable<boolean>;
  95671. /** @hidden */
  95672. _waitingOverrideMeshId: Nullable<string>;
  95673. /**
  95674. * Specifies if the skeleton should be serialized
  95675. */
  95676. doNotSerialize: boolean;
  95677. private _useTextureToStoreBoneMatrices;
  95678. /**
  95679. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  95680. * Please note that this option is not available if the hardware does not support it
  95681. */
  95682. get useTextureToStoreBoneMatrices(): boolean;
  95683. set useTextureToStoreBoneMatrices(value: boolean);
  95684. private _animationPropertiesOverride;
  95685. /**
  95686. * Gets or sets the animation properties override
  95687. */
  95688. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  95689. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  95690. /**
  95691. * List of inspectable custom properties (used by the Inspector)
  95692. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  95693. */
  95694. inspectableCustomProperties: IInspectable[];
  95695. /**
  95696. * An observable triggered before computing the skeleton's matrices
  95697. */
  95698. onBeforeComputeObservable: Observable<Skeleton>;
  95699. /**
  95700. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  95701. */
  95702. get isUsingTextureForMatrices(): boolean;
  95703. /**
  95704. * Gets the unique ID of this skeleton
  95705. */
  95706. get uniqueId(): number;
  95707. /**
  95708. * Creates a new skeleton
  95709. * @param name defines the skeleton name
  95710. * @param id defines the skeleton Id
  95711. * @param scene defines the hosting scene
  95712. */
  95713. constructor(
  95714. /** defines the skeleton name */
  95715. name: string,
  95716. /** defines the skeleton Id */
  95717. id: string, scene: Scene);
  95718. /**
  95719. * Gets the current object class name.
  95720. * @return the class name
  95721. */
  95722. getClassName(): string;
  95723. /**
  95724. * Returns an array containing the root bones
  95725. * @returns an array containing the root bones
  95726. */
  95727. getChildren(): Array<Bone>;
  95728. /**
  95729. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  95730. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95731. * @returns a Float32Array containing matrices data
  95732. */
  95733. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  95734. /**
  95735. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  95736. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95737. * @returns a raw texture containing the data
  95738. */
  95739. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  95740. /**
  95741. * Gets the current hosting scene
  95742. * @returns a scene object
  95743. */
  95744. getScene(): Scene;
  95745. /**
  95746. * Gets a string representing the current skeleton data
  95747. * @param fullDetails defines a boolean indicating if we want a verbose version
  95748. * @returns a string representing the current skeleton data
  95749. */
  95750. toString(fullDetails?: boolean): string;
  95751. /**
  95752. * Get bone's index searching by name
  95753. * @param name defines bone's name to search for
  95754. * @return the indice of the bone. Returns -1 if not found
  95755. */
  95756. getBoneIndexByName(name: string): number;
  95757. /**
  95758. * Creater a new animation range
  95759. * @param name defines the name of the range
  95760. * @param from defines the start key
  95761. * @param to defines the end key
  95762. */
  95763. createAnimationRange(name: string, from: number, to: number): void;
  95764. /**
  95765. * Delete a specific animation range
  95766. * @param name defines the name of the range
  95767. * @param deleteFrames defines if frames must be removed as well
  95768. */
  95769. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  95770. /**
  95771. * Gets a specific animation range
  95772. * @param name defines the name of the range to look for
  95773. * @returns the requested animation range or null if not found
  95774. */
  95775. getAnimationRange(name: string): Nullable<AnimationRange>;
  95776. /**
  95777. * Gets the list of all animation ranges defined on this skeleton
  95778. * @returns an array
  95779. */
  95780. getAnimationRanges(): Nullable<AnimationRange>[];
  95781. /**
  95782. * Copy animation range from a source skeleton.
  95783. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  95784. * @param source defines the source skeleton
  95785. * @param name defines the name of the range to copy
  95786. * @param rescaleAsRequired defines if rescaling must be applied if required
  95787. * @returns true if operation was successful
  95788. */
  95789. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  95790. /**
  95791. * Forces the skeleton to go to rest pose
  95792. */
  95793. returnToRest(): void;
  95794. private _getHighestAnimationFrame;
  95795. /**
  95796. * Begin a specific animation range
  95797. * @param name defines the name of the range to start
  95798. * @param loop defines if looping must be turned on (false by default)
  95799. * @param speedRatio defines the speed ratio to apply (1 by default)
  95800. * @param onAnimationEnd defines a callback which will be called when animation will end
  95801. * @returns a new animatable
  95802. */
  95803. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  95804. /**
  95805. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  95806. * @param skeleton defines the Skeleton containing the animation range to convert
  95807. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  95808. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  95809. * @returns the original skeleton
  95810. */
  95811. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  95812. /** @hidden */
  95813. _markAsDirty(): void;
  95814. /** @hidden */
  95815. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95816. /** @hidden */
  95817. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95818. private _computeTransformMatrices;
  95819. /**
  95820. * Build all resources required to render a skeleton
  95821. */
  95822. prepare(): void;
  95823. /**
  95824. * Gets the list of animatables currently running for this skeleton
  95825. * @returns an array of animatables
  95826. */
  95827. getAnimatables(): IAnimatable[];
  95828. /**
  95829. * Clone the current skeleton
  95830. * @param name defines the name of the new skeleton
  95831. * @param id defines the id of the new skeleton
  95832. * @returns the new skeleton
  95833. */
  95834. clone(name: string, id?: string): Skeleton;
  95835. /**
  95836. * Enable animation blending for this skeleton
  95837. * @param blendingSpeed defines the blending speed to apply
  95838. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95839. */
  95840. enableBlending(blendingSpeed?: number): void;
  95841. /**
  95842. * Releases all resources associated with the current skeleton
  95843. */
  95844. dispose(): void;
  95845. /**
  95846. * Serialize the skeleton in a JSON object
  95847. * @returns a JSON object
  95848. */
  95849. serialize(): any;
  95850. /**
  95851. * Creates a new skeleton from serialized data
  95852. * @param parsedSkeleton defines the serialized data
  95853. * @param scene defines the hosting scene
  95854. * @returns a new skeleton
  95855. */
  95856. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  95857. /**
  95858. * Compute all node absolute transforms
  95859. * @param forceUpdate defines if computation must be done even if cache is up to date
  95860. */
  95861. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  95862. /**
  95863. * Gets the root pose matrix
  95864. * @returns a matrix
  95865. */
  95866. getPoseMatrix(): Nullable<Matrix>;
  95867. /**
  95868. * Sorts bones per internal index
  95869. */
  95870. sortBones(): void;
  95871. private _sortBones;
  95872. }
  95873. }
  95874. declare module BABYLON {
  95875. /**
  95876. * Creates an instance based on a source mesh.
  95877. */
  95878. export class InstancedMesh extends AbstractMesh {
  95879. private _sourceMesh;
  95880. private _currentLOD;
  95881. /** @hidden */
  95882. _indexInSourceMeshInstanceArray: number;
  95883. constructor(name: string, source: Mesh);
  95884. /**
  95885. * Returns the string "InstancedMesh".
  95886. */
  95887. getClassName(): string;
  95888. /** Gets the list of lights affecting that mesh */
  95889. get lightSources(): Light[];
  95890. _resyncLightSources(): void;
  95891. _resyncLightSource(light: Light): void;
  95892. _removeLightSource(light: Light, dispose: boolean): void;
  95893. /**
  95894. * If the source mesh receives shadows
  95895. */
  95896. get receiveShadows(): boolean;
  95897. /**
  95898. * The material of the source mesh
  95899. */
  95900. get material(): Nullable<Material>;
  95901. /**
  95902. * Visibility of the source mesh
  95903. */
  95904. get visibility(): number;
  95905. /**
  95906. * Skeleton of the source mesh
  95907. */
  95908. get skeleton(): Nullable<Skeleton>;
  95909. /**
  95910. * Rendering ground id of the source mesh
  95911. */
  95912. get renderingGroupId(): number;
  95913. set renderingGroupId(value: number);
  95914. /**
  95915. * Returns the total number of vertices (integer).
  95916. */
  95917. getTotalVertices(): number;
  95918. /**
  95919. * Returns a positive integer : the total number of indices in this mesh geometry.
  95920. * @returns the numner of indices or zero if the mesh has no geometry.
  95921. */
  95922. getTotalIndices(): number;
  95923. /**
  95924. * The source mesh of the instance
  95925. */
  95926. get sourceMesh(): Mesh;
  95927. /**
  95928. * Creates a new InstancedMesh object from the mesh model.
  95929. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  95930. * @param name defines the name of the new instance
  95931. * @returns a new InstancedMesh
  95932. */
  95933. createInstance(name: string): InstancedMesh;
  95934. /**
  95935. * Is this node ready to be used/rendered
  95936. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  95937. * @return {boolean} is it ready
  95938. */
  95939. isReady(completeCheck?: boolean): boolean;
  95940. /**
  95941. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  95942. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  95943. * @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.
  95944. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  95945. */
  95946. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  95947. /**
  95948. * Sets the vertex data of the mesh geometry for the requested `kind`.
  95949. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  95950. * The `data` are either a numeric array either a Float32Array.
  95951. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  95952. * 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).
  95953. * Note that a new underlying VertexBuffer object is created each call.
  95954. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  95955. *
  95956. * Possible `kind` values :
  95957. * - VertexBuffer.PositionKind
  95958. * - VertexBuffer.UVKind
  95959. * - VertexBuffer.UV2Kind
  95960. * - VertexBuffer.UV3Kind
  95961. * - VertexBuffer.UV4Kind
  95962. * - VertexBuffer.UV5Kind
  95963. * - VertexBuffer.UV6Kind
  95964. * - VertexBuffer.ColorKind
  95965. * - VertexBuffer.MatricesIndicesKind
  95966. * - VertexBuffer.MatricesIndicesExtraKind
  95967. * - VertexBuffer.MatricesWeightsKind
  95968. * - VertexBuffer.MatricesWeightsExtraKind
  95969. *
  95970. * Returns the Mesh.
  95971. */
  95972. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  95973. /**
  95974. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  95975. * If the mesh has no geometry, it is simply returned as it is.
  95976. * The `data` are either a numeric array either a Float32Array.
  95977. * No new underlying VertexBuffer object is created.
  95978. * 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.
  95979. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  95980. *
  95981. * Possible `kind` values :
  95982. * - VertexBuffer.PositionKind
  95983. * - VertexBuffer.UVKind
  95984. * - VertexBuffer.UV2Kind
  95985. * - VertexBuffer.UV3Kind
  95986. * - VertexBuffer.UV4Kind
  95987. * - VertexBuffer.UV5Kind
  95988. * - VertexBuffer.UV6Kind
  95989. * - VertexBuffer.ColorKind
  95990. * - VertexBuffer.MatricesIndicesKind
  95991. * - VertexBuffer.MatricesIndicesExtraKind
  95992. * - VertexBuffer.MatricesWeightsKind
  95993. * - VertexBuffer.MatricesWeightsExtraKind
  95994. *
  95995. * Returns the Mesh.
  95996. */
  95997. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  95998. /**
  95999. * Sets the mesh indices.
  96000. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  96001. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  96002. * This method creates a new index buffer each call.
  96003. * Returns the Mesh.
  96004. */
  96005. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  96006. /**
  96007. * Boolean : True if the mesh owns the requested kind of data.
  96008. */
  96009. isVerticesDataPresent(kind: string): boolean;
  96010. /**
  96011. * Returns an array of indices (IndicesArray).
  96012. */
  96013. getIndices(): Nullable<IndicesArray>;
  96014. get _positions(): Nullable<Vector3[]>;
  96015. /**
  96016. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  96017. * This means the mesh underlying bounding box and sphere are recomputed.
  96018. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  96019. * @returns the current mesh
  96020. */
  96021. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  96022. /** @hidden */
  96023. _preActivate(): InstancedMesh;
  96024. /** @hidden */
  96025. _activate(renderId: number, intermediateRendering: boolean): boolean;
  96026. /** @hidden */
  96027. _postActivate(): void;
  96028. getWorldMatrix(): Matrix;
  96029. get isAnInstance(): boolean;
  96030. /**
  96031. * Returns the current associated LOD AbstractMesh.
  96032. */
  96033. getLOD(camera: Camera): AbstractMesh;
  96034. /** @hidden */
  96035. _preActivateForIntermediateRendering(renderId: number): Mesh;
  96036. /** @hidden */
  96037. _syncSubMeshes(): InstancedMesh;
  96038. /** @hidden */
  96039. _generatePointsArray(): boolean;
  96040. /** @hidden */
  96041. _updateBoundingInfo(): AbstractMesh;
  96042. /**
  96043. * Creates a new InstancedMesh from the current mesh.
  96044. * - name (string) : the cloned mesh name
  96045. * - newParent (optional Node) : the optional Node to parent the clone to.
  96046. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  96047. *
  96048. * Returns the clone.
  96049. */
  96050. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  96051. /**
  96052. * Disposes the InstancedMesh.
  96053. * Returns nothing.
  96054. */
  96055. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  96056. }
  96057. interface Mesh {
  96058. /**
  96059. * Register a custom buffer that will be instanced
  96060. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96061. * @param kind defines the buffer kind
  96062. * @param stride defines the stride in floats
  96063. */
  96064. registerInstancedBuffer(kind: string, stride: number): void;
  96065. /**
  96066. * true to use the edge renderer for all instances of this mesh
  96067. */
  96068. edgesShareWithInstances: boolean;
  96069. /** @hidden */
  96070. _userInstancedBuffersStorage: {
  96071. data: {
  96072. [key: string]: Float32Array;
  96073. };
  96074. sizes: {
  96075. [key: string]: number;
  96076. };
  96077. vertexBuffers: {
  96078. [key: string]: Nullable<VertexBuffer>;
  96079. };
  96080. strides: {
  96081. [key: string]: number;
  96082. };
  96083. };
  96084. }
  96085. interface AbstractMesh {
  96086. /**
  96087. * Object used to store instanced buffers defined by user
  96088. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96089. */
  96090. instancedBuffers: {
  96091. [key: string]: any;
  96092. };
  96093. }
  96094. }
  96095. declare module BABYLON {
  96096. /**
  96097. * Defines the options associated with the creation of a shader material.
  96098. */
  96099. export interface IShaderMaterialOptions {
  96100. /**
  96101. * Does the material work in alpha blend mode
  96102. */
  96103. needAlphaBlending: boolean;
  96104. /**
  96105. * Does the material work in alpha test mode
  96106. */
  96107. needAlphaTesting: boolean;
  96108. /**
  96109. * The list of attribute names used in the shader
  96110. */
  96111. attributes: string[];
  96112. /**
  96113. * The list of unifrom names used in the shader
  96114. */
  96115. uniforms: string[];
  96116. /**
  96117. * The list of UBO names used in the shader
  96118. */
  96119. uniformBuffers: string[];
  96120. /**
  96121. * The list of sampler names used in the shader
  96122. */
  96123. samplers: string[];
  96124. /**
  96125. * The list of defines used in the shader
  96126. */
  96127. defines: string[];
  96128. }
  96129. /**
  96130. * 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.
  96131. *
  96132. * This returned material effects how the mesh will look based on the code in the shaders.
  96133. *
  96134. * @see https://doc.babylonjs.com/how_to/shader_material
  96135. */
  96136. export class ShaderMaterial extends Material {
  96137. private _shaderPath;
  96138. private _options;
  96139. private _textures;
  96140. private _textureArrays;
  96141. private _floats;
  96142. private _ints;
  96143. private _floatsArrays;
  96144. private _colors3;
  96145. private _colors3Arrays;
  96146. private _colors4;
  96147. private _colors4Arrays;
  96148. private _vectors2;
  96149. private _vectors3;
  96150. private _vectors4;
  96151. private _matrices;
  96152. private _matrixArrays;
  96153. private _matrices3x3;
  96154. private _matrices2x2;
  96155. private _vectors2Arrays;
  96156. private _vectors3Arrays;
  96157. private _vectors4Arrays;
  96158. private _cachedWorldViewMatrix;
  96159. private _cachedWorldViewProjectionMatrix;
  96160. private _renderId;
  96161. private _multiview;
  96162. private _cachedDefines;
  96163. /** Define the Url to load snippets */
  96164. static SnippetUrl: string;
  96165. /** Snippet ID if the material was created from the snippet server */
  96166. snippetId: string;
  96167. /**
  96168. * Instantiate a new shader material.
  96169. * 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.
  96170. * This returned material effects how the mesh will look based on the code in the shaders.
  96171. * @see https://doc.babylonjs.com/how_to/shader_material
  96172. * @param name Define the name of the material in the scene
  96173. * @param scene Define the scene the material belongs to
  96174. * @param shaderPath Defines the route to the shader code in one of three ways:
  96175. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  96176. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  96177. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  96178. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  96179. * @param options Define the options used to create the shader
  96180. */
  96181. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  96182. /**
  96183. * Gets the shader path used to define the shader code
  96184. * It can be modified to trigger a new compilation
  96185. */
  96186. get shaderPath(): any;
  96187. /**
  96188. * Sets the shader path used to define the shader code
  96189. * It can be modified to trigger a new compilation
  96190. */
  96191. set shaderPath(shaderPath: any);
  96192. /**
  96193. * Gets the options used to compile the shader.
  96194. * They can be modified to trigger a new compilation
  96195. */
  96196. get options(): IShaderMaterialOptions;
  96197. /**
  96198. * Gets the current class name of the material e.g. "ShaderMaterial"
  96199. * Mainly use in serialization.
  96200. * @returns the class name
  96201. */
  96202. getClassName(): string;
  96203. /**
  96204. * Specifies if the material will require alpha blending
  96205. * @returns a boolean specifying if alpha blending is needed
  96206. */
  96207. needAlphaBlending(): boolean;
  96208. /**
  96209. * Specifies if this material should be rendered in alpha test mode
  96210. * @returns a boolean specifying if an alpha test is needed.
  96211. */
  96212. needAlphaTesting(): boolean;
  96213. private _checkUniform;
  96214. /**
  96215. * Set a texture in the shader.
  96216. * @param name Define the name of the uniform samplers as defined in the shader
  96217. * @param texture Define the texture to bind to this sampler
  96218. * @return the material itself allowing "fluent" like uniform updates
  96219. */
  96220. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  96221. /**
  96222. * Set a texture array in the shader.
  96223. * @param name Define the name of the uniform sampler array as defined in the shader
  96224. * @param textures Define the list of textures to bind to this sampler
  96225. * @return the material itself allowing "fluent" like uniform updates
  96226. */
  96227. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  96228. /**
  96229. * Set a float in the shader.
  96230. * @param name Define the name of the uniform as defined in the shader
  96231. * @param value Define the value to give to the uniform
  96232. * @return the material itself allowing "fluent" like uniform updates
  96233. */
  96234. setFloat(name: string, value: number): ShaderMaterial;
  96235. /**
  96236. * Set a int in the shader.
  96237. * @param name Define the name of the uniform as defined in the shader
  96238. * @param value Define the value to give to the uniform
  96239. * @return the material itself allowing "fluent" like uniform updates
  96240. */
  96241. setInt(name: string, value: number): ShaderMaterial;
  96242. /**
  96243. * Set an array of floats in the shader.
  96244. * @param name Define the name of the uniform as defined in the shader
  96245. * @param value Define the value to give to the uniform
  96246. * @return the material itself allowing "fluent" like uniform updates
  96247. */
  96248. setFloats(name: string, value: number[]): ShaderMaterial;
  96249. /**
  96250. * Set a vec3 in the shader from a Color3.
  96251. * @param name Define the name of the uniform as defined in the shader
  96252. * @param value Define the value to give to the uniform
  96253. * @return the material itself allowing "fluent" like uniform updates
  96254. */
  96255. setColor3(name: string, value: Color3): ShaderMaterial;
  96256. /**
  96257. * Set a vec3 array in the shader from a Color3 array.
  96258. * @param name Define the name of the uniform as defined in the shader
  96259. * @param value Define the value to give to the uniform
  96260. * @return the material itself allowing "fluent" like uniform updates
  96261. */
  96262. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  96263. /**
  96264. * Set a vec4 in the shader from a Color4.
  96265. * @param name Define the name of the uniform as defined in the shader
  96266. * @param value Define the value to give to the uniform
  96267. * @return the material itself allowing "fluent" like uniform updates
  96268. */
  96269. setColor4(name: string, value: Color4): ShaderMaterial;
  96270. /**
  96271. * Set a vec4 array in the shader from a Color4 array.
  96272. * @param name Define the name of the uniform as defined in the shader
  96273. * @param value Define the value to give to the uniform
  96274. * @return the material itself allowing "fluent" like uniform updates
  96275. */
  96276. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  96277. /**
  96278. * Set a vec2 in the shader from a Vector2.
  96279. * @param name Define the name of the uniform as defined in the shader
  96280. * @param value Define the value to give to the uniform
  96281. * @return the material itself allowing "fluent" like uniform updates
  96282. */
  96283. setVector2(name: string, value: Vector2): ShaderMaterial;
  96284. /**
  96285. * Set a vec3 in the shader from a Vector3.
  96286. * @param name Define the name of the uniform as defined in the shader
  96287. * @param value Define the value to give to the uniform
  96288. * @return the material itself allowing "fluent" like uniform updates
  96289. */
  96290. setVector3(name: string, value: Vector3): ShaderMaterial;
  96291. /**
  96292. * Set a vec4 in the shader from a Vector4.
  96293. * @param name Define the name of the uniform as defined in the shader
  96294. * @param value Define the value to give to the uniform
  96295. * @return the material itself allowing "fluent" like uniform updates
  96296. */
  96297. setVector4(name: string, value: Vector4): ShaderMaterial;
  96298. /**
  96299. * Set a mat4 in the shader from a Matrix.
  96300. * @param name Define the name of the uniform as defined in the shader
  96301. * @param value Define the value to give to the uniform
  96302. * @return the material itself allowing "fluent" like uniform updates
  96303. */
  96304. setMatrix(name: string, value: Matrix): ShaderMaterial;
  96305. /**
  96306. * Set a float32Array in the shader from a matrix array.
  96307. * @param name Define the name of the uniform as defined in the shader
  96308. * @param value Define the value to give to the uniform
  96309. * @return the material itself allowing "fluent" like uniform updates
  96310. */
  96311. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  96312. /**
  96313. * Set a mat3 in the shader from a Float32Array.
  96314. * @param name Define the name of the uniform as defined in the shader
  96315. * @param value Define the value to give to the uniform
  96316. * @return the material itself allowing "fluent" like uniform updates
  96317. */
  96318. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96319. /**
  96320. * Set a mat2 in the shader from a Float32Array.
  96321. * @param name Define the name of the uniform as defined in the shader
  96322. * @param value Define the value to give to the uniform
  96323. * @return the material itself allowing "fluent" like uniform updates
  96324. */
  96325. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96326. /**
  96327. * Set a vec2 array in the shader from a number array.
  96328. * @param name Define the name of the uniform as defined in the shader
  96329. * @param value Define the value to give to the uniform
  96330. * @return the material itself allowing "fluent" like uniform updates
  96331. */
  96332. setArray2(name: string, value: number[]): ShaderMaterial;
  96333. /**
  96334. * Set a vec3 array in the shader from a number array.
  96335. * @param name Define the name of the uniform as defined in the shader
  96336. * @param value Define the value to give to the uniform
  96337. * @return the material itself allowing "fluent" like uniform updates
  96338. */
  96339. setArray3(name: string, value: number[]): ShaderMaterial;
  96340. /**
  96341. * Set a vec4 array in the shader from a number array.
  96342. * @param name Define the name of the uniform as defined in the shader
  96343. * @param value Define the value to give to the uniform
  96344. * @return the material itself allowing "fluent" like uniform updates
  96345. */
  96346. setArray4(name: string, value: number[]): ShaderMaterial;
  96347. private _checkCache;
  96348. /**
  96349. * Specifies that the submesh is ready to be used
  96350. * @param mesh defines the mesh to check
  96351. * @param subMesh defines which submesh to check
  96352. * @param useInstances specifies that instances should be used
  96353. * @returns a boolean indicating that the submesh is ready or not
  96354. */
  96355. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  96356. /**
  96357. * Checks if the material is ready to render the requested mesh
  96358. * @param mesh Define the mesh to render
  96359. * @param useInstances Define whether or not the material is used with instances
  96360. * @returns true if ready, otherwise false
  96361. */
  96362. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  96363. /**
  96364. * Binds the world matrix to the material
  96365. * @param world defines the world transformation matrix
  96366. * @param effectOverride - If provided, use this effect instead of internal effect
  96367. */
  96368. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  96369. /**
  96370. * Binds the submesh to this material by preparing the effect and shader to draw
  96371. * @param world defines the world transformation matrix
  96372. * @param mesh defines the mesh containing the submesh
  96373. * @param subMesh defines the submesh to bind the material to
  96374. */
  96375. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  96376. /**
  96377. * Binds the material to the mesh
  96378. * @param world defines the world transformation matrix
  96379. * @param mesh defines the mesh to bind the material to
  96380. * @param effectOverride - If provided, use this effect instead of internal effect
  96381. */
  96382. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  96383. protected _afterBind(mesh?: Mesh): void;
  96384. /**
  96385. * Gets the active textures from the material
  96386. * @returns an array of textures
  96387. */
  96388. getActiveTextures(): BaseTexture[];
  96389. /**
  96390. * Specifies if the material uses a texture
  96391. * @param texture defines the texture to check against the material
  96392. * @returns a boolean specifying if the material uses the texture
  96393. */
  96394. hasTexture(texture: BaseTexture): boolean;
  96395. /**
  96396. * Makes a duplicate of the material, and gives it a new name
  96397. * @param name defines the new name for the duplicated material
  96398. * @returns the cloned material
  96399. */
  96400. clone(name: string): ShaderMaterial;
  96401. /**
  96402. * Disposes the material
  96403. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  96404. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  96405. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  96406. */
  96407. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  96408. /**
  96409. * Serializes this material in a JSON representation
  96410. * @returns the serialized material object
  96411. */
  96412. serialize(): any;
  96413. /**
  96414. * Creates a shader material from parsed shader material data
  96415. * @param source defines the JSON represnetation of the material
  96416. * @param scene defines the hosting scene
  96417. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96418. * @returns a new material
  96419. */
  96420. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  96421. /**
  96422. * Creates a new ShaderMaterial from a snippet saved in a remote file
  96423. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  96424. * @param url defines the url to load from
  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 promise that will resolve to the new ShaderMaterial
  96428. */
  96429. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96430. /**
  96431. * Creates a ShaderMaterial from a snippet saved by the Inspector
  96432. * @param snippetId defines the snippet to load
  96433. * @param scene defines the hosting scene
  96434. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96435. * @returns a promise that will resolve to the new ShaderMaterial
  96436. */
  96437. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96438. }
  96439. }
  96440. declare module BABYLON {
  96441. /** @hidden */
  96442. export var colorPixelShader: {
  96443. name: string;
  96444. shader: string;
  96445. };
  96446. }
  96447. declare module BABYLON {
  96448. /** @hidden */
  96449. export var colorVertexShader: {
  96450. name: string;
  96451. shader: string;
  96452. };
  96453. }
  96454. declare module BABYLON {
  96455. /**
  96456. * Line mesh
  96457. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  96458. */
  96459. export class LinesMesh extends Mesh {
  96460. /**
  96461. * If vertex color should be applied to the mesh
  96462. */
  96463. readonly useVertexColor?: boolean | undefined;
  96464. /**
  96465. * If vertex alpha should be applied to the mesh
  96466. */
  96467. readonly useVertexAlpha?: boolean | undefined;
  96468. /**
  96469. * Color of the line (Default: White)
  96470. */
  96471. color: Color3;
  96472. /**
  96473. * Alpha of the line (Default: 1)
  96474. */
  96475. alpha: number;
  96476. /**
  96477. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96478. * This margin is expressed in world space coordinates, so its value may vary.
  96479. * Default value is 0.1
  96480. */
  96481. intersectionThreshold: number;
  96482. private _colorShader;
  96483. private color4;
  96484. /**
  96485. * Creates a new LinesMesh
  96486. * @param name defines the name
  96487. * @param scene defines the hosting scene
  96488. * @param parent defines the parent mesh if any
  96489. * @param source defines the optional source LinesMesh used to clone data from
  96490. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  96491. * When false, achieved by calling a clone(), also passing False.
  96492. * This will make creation of children, recursive.
  96493. * @param useVertexColor defines if this LinesMesh supports vertex color
  96494. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  96495. */
  96496. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  96497. /**
  96498. * If vertex color should be applied to the mesh
  96499. */
  96500. useVertexColor?: boolean | undefined,
  96501. /**
  96502. * If vertex alpha should be applied to the mesh
  96503. */
  96504. useVertexAlpha?: boolean | undefined);
  96505. private _addClipPlaneDefine;
  96506. private _removeClipPlaneDefine;
  96507. isReady(): boolean;
  96508. /**
  96509. * Returns the string "LineMesh"
  96510. */
  96511. getClassName(): string;
  96512. /**
  96513. * @hidden
  96514. */
  96515. get material(): Material;
  96516. /**
  96517. * @hidden
  96518. */
  96519. set material(value: Material);
  96520. /**
  96521. * @hidden
  96522. */
  96523. get checkCollisions(): boolean;
  96524. /** @hidden */
  96525. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  96526. /** @hidden */
  96527. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  96528. /**
  96529. * Disposes of the line mesh
  96530. * @param doNotRecurse If children should be disposed
  96531. */
  96532. dispose(doNotRecurse?: boolean): void;
  96533. /**
  96534. * Returns a new LineMesh object cloned from the current one.
  96535. */
  96536. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  96537. /**
  96538. * Creates a new InstancedLinesMesh object from the mesh model.
  96539. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  96540. * @param name defines the name of the new instance
  96541. * @returns a new InstancedLinesMesh
  96542. */
  96543. createInstance(name: string): InstancedLinesMesh;
  96544. }
  96545. /**
  96546. * Creates an instance based on a source LinesMesh
  96547. */
  96548. export class InstancedLinesMesh extends InstancedMesh {
  96549. /**
  96550. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96551. * This margin is expressed in world space coordinates, so its value may vary.
  96552. * Initilized with the intersectionThreshold value of the source LinesMesh
  96553. */
  96554. intersectionThreshold: number;
  96555. constructor(name: string, source: LinesMesh);
  96556. /**
  96557. * Returns the string "InstancedLinesMesh".
  96558. */
  96559. getClassName(): string;
  96560. }
  96561. }
  96562. declare module BABYLON {
  96563. /** @hidden */
  96564. export var linePixelShader: {
  96565. name: string;
  96566. shader: string;
  96567. };
  96568. }
  96569. declare module BABYLON {
  96570. /** @hidden */
  96571. export var lineVertexShader: {
  96572. name: string;
  96573. shader: string;
  96574. };
  96575. }
  96576. declare module BABYLON {
  96577. interface Scene {
  96578. /** @hidden */
  96579. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  96580. }
  96581. interface AbstractMesh {
  96582. /**
  96583. * Gets the edgesRenderer associated with the mesh
  96584. */
  96585. edgesRenderer: Nullable<EdgesRenderer>;
  96586. }
  96587. interface LinesMesh {
  96588. /**
  96589. * Enables the edge rendering mode on the mesh.
  96590. * This mode makes the mesh edges visible
  96591. * @param epsilon defines the maximal distance between two angles to detect a face
  96592. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96593. * @returns the currentAbstractMesh
  96594. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96595. */
  96596. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  96597. }
  96598. interface InstancedLinesMesh {
  96599. /**
  96600. * Enables the edge rendering mode on the mesh.
  96601. * This mode makes the mesh edges visible
  96602. * @param epsilon defines the maximal distance between two angles to detect a face
  96603. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96604. * @returns the current InstancedLinesMesh
  96605. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96606. */
  96607. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  96608. }
  96609. /**
  96610. * Defines the minimum contract an Edges renderer should follow.
  96611. */
  96612. export interface IEdgesRenderer extends IDisposable {
  96613. /**
  96614. * Gets or sets a boolean indicating if the edgesRenderer is active
  96615. */
  96616. isEnabled: boolean;
  96617. /**
  96618. * Renders the edges of the attached mesh,
  96619. */
  96620. render(): void;
  96621. /**
  96622. * Checks wether or not the edges renderer is ready to render.
  96623. * @return true if ready, otherwise false.
  96624. */
  96625. isReady(): boolean;
  96626. /**
  96627. * List of instances to render in case the source mesh has instances
  96628. */
  96629. customInstances: SmartArray<Matrix>;
  96630. }
  96631. /**
  96632. * Defines the additional options of the edges renderer
  96633. */
  96634. export interface IEdgesRendererOptions {
  96635. /**
  96636. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  96637. * If not defined, the default value is true
  96638. */
  96639. useAlternateEdgeFinder?: boolean;
  96640. /**
  96641. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  96642. * If not defined, the default value is true.
  96643. * 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)
  96644. * This option is used only if useAlternateEdgeFinder = true
  96645. */
  96646. useFastVertexMerger?: boolean;
  96647. /**
  96648. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  96649. * The default value is 1e-6
  96650. * This option is used only if useAlternateEdgeFinder = true
  96651. */
  96652. epsilonVertexMerge?: number;
  96653. /**
  96654. * 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
  96655. * 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.
  96656. * This option is used only if useAlternateEdgeFinder = true
  96657. */
  96658. applyTessellation?: boolean;
  96659. /**
  96660. * 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
  96661. * The default value is 1e-6
  96662. * This option is used only if useAlternateEdgeFinder = true
  96663. */
  96664. epsilonVertexAligned?: number;
  96665. }
  96666. /**
  96667. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  96668. */
  96669. export class EdgesRenderer implements IEdgesRenderer {
  96670. /**
  96671. * Define the size of the edges with an orthographic camera
  96672. */
  96673. edgesWidthScalerForOrthographic: number;
  96674. /**
  96675. * Define the size of the edges with a perspective camera
  96676. */
  96677. edgesWidthScalerForPerspective: number;
  96678. protected _source: AbstractMesh;
  96679. protected _linesPositions: number[];
  96680. protected _linesNormals: number[];
  96681. protected _linesIndices: number[];
  96682. protected _epsilon: number;
  96683. protected _indicesCount: number;
  96684. protected _lineShader: ShaderMaterial;
  96685. protected _ib: DataBuffer;
  96686. protected _buffers: {
  96687. [key: string]: Nullable<VertexBuffer>;
  96688. };
  96689. protected _buffersForInstances: {
  96690. [key: string]: Nullable<VertexBuffer>;
  96691. };
  96692. protected _checkVerticesInsteadOfIndices: boolean;
  96693. protected _options: Nullable<IEdgesRendererOptions>;
  96694. private _meshRebuildObserver;
  96695. private _meshDisposeObserver;
  96696. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  96697. isEnabled: boolean;
  96698. /**
  96699. * List of instances to render in case the source mesh has instances
  96700. */
  96701. customInstances: SmartArray<Matrix>;
  96702. private static GetShader;
  96703. /**
  96704. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  96705. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  96706. * @param source Mesh used to create edges
  96707. * @param epsilon sum of angles in adjacency to check for edge
  96708. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  96709. * @param generateEdgesLines - should generate Lines or only prepare resources.
  96710. * @param options The options to apply when generating the edges
  96711. */
  96712. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  96713. protected _prepareRessources(): void;
  96714. /** @hidden */
  96715. _rebuild(): void;
  96716. /**
  96717. * Releases the required resources for the edges renderer
  96718. */
  96719. dispose(): void;
  96720. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  96721. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  96722. /**
  96723. * Checks if the pair of p0 and p1 is en edge
  96724. * @param faceIndex
  96725. * @param edge
  96726. * @param faceNormals
  96727. * @param p0
  96728. * @param p1
  96729. * @private
  96730. */
  96731. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  96732. /**
  96733. * push line into the position, normal and index buffer
  96734. * @protected
  96735. */
  96736. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  96737. /**
  96738. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  96739. */
  96740. private _tessellateTriangle;
  96741. private _generateEdgesLinesAlternate;
  96742. /**
  96743. * Generates lines edges from adjacencjes
  96744. * @private
  96745. */
  96746. _generateEdgesLines(): void;
  96747. /**
  96748. * Checks wether or not the edges renderer is ready to render.
  96749. * @return true if ready, otherwise false.
  96750. */
  96751. isReady(): boolean;
  96752. /**
  96753. * Renders the edges of the attached mesh,
  96754. */
  96755. render(): void;
  96756. }
  96757. /**
  96758. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  96759. */
  96760. export class LineEdgesRenderer extends EdgesRenderer {
  96761. /**
  96762. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  96763. * @param source LineMesh used to generate edges
  96764. * @param epsilon not important (specified angle for edge detection)
  96765. * @param checkVerticesInsteadOfIndices not important for LineMesh
  96766. */
  96767. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  96768. /**
  96769. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  96770. */
  96771. _generateEdgesLines(): void;
  96772. }
  96773. }
  96774. declare module BABYLON {
  96775. /**
  96776. * This represents the object necessary to create a rendering group.
  96777. * This is exclusively used and created by the rendering manager.
  96778. * To modify the behavior, you use the available helpers in your scene or meshes.
  96779. * @hidden
  96780. */
  96781. export class RenderingGroup {
  96782. index: number;
  96783. private static _zeroVector;
  96784. private _scene;
  96785. private _opaqueSubMeshes;
  96786. private _transparentSubMeshes;
  96787. private _alphaTestSubMeshes;
  96788. private _depthOnlySubMeshes;
  96789. private _particleSystems;
  96790. private _spriteManagers;
  96791. private _opaqueSortCompareFn;
  96792. private _alphaTestSortCompareFn;
  96793. private _transparentSortCompareFn;
  96794. private _renderOpaque;
  96795. private _renderAlphaTest;
  96796. private _renderTransparent;
  96797. /** @hidden */
  96798. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  96799. onBeforeTransparentRendering: () => void;
  96800. /**
  96801. * Set the opaque sort comparison function.
  96802. * If null the sub meshes will be render in the order they were created
  96803. */
  96804. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96805. /**
  96806. * Set the alpha test sort comparison function.
  96807. * If null the sub meshes will be render in the order they were created
  96808. */
  96809. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96810. /**
  96811. * Set the transparent sort comparison function.
  96812. * If null the sub meshes will be render in the order they were created
  96813. */
  96814. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96815. /**
  96816. * Creates a new rendering group.
  96817. * @param index The rendering group index
  96818. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  96819. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  96820. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  96821. */
  96822. 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>);
  96823. /**
  96824. * Render all the sub meshes contained in the group.
  96825. * @param customRenderFunction Used to override the default render behaviour of the group.
  96826. * @returns true if rendered some submeshes.
  96827. */
  96828. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  96829. /**
  96830. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  96831. * @param subMeshes The submeshes to render
  96832. */
  96833. private renderOpaqueSorted;
  96834. /**
  96835. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  96836. * @param subMeshes The submeshes to render
  96837. */
  96838. private renderAlphaTestSorted;
  96839. /**
  96840. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  96841. * @param subMeshes The submeshes to render
  96842. */
  96843. private renderTransparentSorted;
  96844. /**
  96845. * Renders the submeshes in a specified order.
  96846. * @param subMeshes The submeshes to sort before render
  96847. * @param sortCompareFn The comparison function use to sort
  96848. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  96849. * @param transparent Specifies to activate blending if true
  96850. */
  96851. private static renderSorted;
  96852. /**
  96853. * Renders the submeshes in the order they were dispatched (no sort applied).
  96854. * @param subMeshes The submeshes to render
  96855. */
  96856. private static renderUnsorted;
  96857. /**
  96858. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96859. * are rendered back to front if in the same alpha index.
  96860. *
  96861. * @param a The first submesh
  96862. * @param b The second submesh
  96863. * @returns The result of the comparison
  96864. */
  96865. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  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.
  96869. *
  96870. * @param a The first submesh
  96871. * @param b The second submesh
  96872. * @returns The result of the comparison
  96873. */
  96874. static backToFrontSortCompare(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 front to back (prevent overdraw).
  96878. *
  96879. * @param a The first submesh
  96880. * @param b The second submesh
  96881. * @returns The result of the comparison
  96882. */
  96883. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  96884. /**
  96885. * Resets the different lists of submeshes to prepare a new frame.
  96886. */
  96887. prepare(): void;
  96888. dispose(): void;
  96889. /**
  96890. * Inserts the submesh in its correct queue depending on its material.
  96891. * @param subMesh The submesh to dispatch
  96892. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  96893. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  96894. */
  96895. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  96896. dispatchSprites(spriteManager: ISpriteManager): void;
  96897. dispatchParticles(particleSystem: IParticleSystem): void;
  96898. private _renderParticles;
  96899. private _renderSprites;
  96900. }
  96901. }
  96902. declare module BABYLON {
  96903. /**
  96904. * Interface describing the different options available in the rendering manager
  96905. * regarding Auto Clear between groups.
  96906. */
  96907. export interface IRenderingManagerAutoClearSetup {
  96908. /**
  96909. * Defines whether or not autoclear is enable.
  96910. */
  96911. autoClear: boolean;
  96912. /**
  96913. * Defines whether or not to autoclear the depth buffer.
  96914. */
  96915. depth: boolean;
  96916. /**
  96917. * Defines whether or not to autoclear the stencil buffer.
  96918. */
  96919. stencil: boolean;
  96920. }
  96921. /**
  96922. * This class is used by the onRenderingGroupObservable
  96923. */
  96924. export class RenderingGroupInfo {
  96925. /**
  96926. * The Scene that being rendered
  96927. */
  96928. scene: Scene;
  96929. /**
  96930. * The camera currently used for the rendering pass
  96931. */
  96932. camera: Nullable<Camera>;
  96933. /**
  96934. * The ID of the renderingGroup being processed
  96935. */
  96936. renderingGroupId: number;
  96937. }
  96938. /**
  96939. * This is the manager responsible of all the rendering for meshes sprites and particles.
  96940. * It is enable to manage the different groups as well as the different necessary sort functions.
  96941. * This should not be used directly aside of the few static configurations
  96942. */
  96943. export class RenderingManager {
  96944. /**
  96945. * The max id used for rendering groups (not included)
  96946. */
  96947. static MAX_RENDERINGGROUPS: number;
  96948. /**
  96949. * The min id used for rendering groups (included)
  96950. */
  96951. static MIN_RENDERINGGROUPS: number;
  96952. /**
  96953. * Used to globally prevent autoclearing scenes.
  96954. */
  96955. static AUTOCLEAR: boolean;
  96956. /**
  96957. * @hidden
  96958. */
  96959. _useSceneAutoClearSetup: boolean;
  96960. private _scene;
  96961. private _renderingGroups;
  96962. private _depthStencilBufferAlreadyCleaned;
  96963. private _autoClearDepthStencil;
  96964. private _customOpaqueSortCompareFn;
  96965. private _customAlphaTestSortCompareFn;
  96966. private _customTransparentSortCompareFn;
  96967. private _renderingGroupInfo;
  96968. /**
  96969. * Instantiates a new rendering group for a particular scene
  96970. * @param scene Defines the scene the groups belongs to
  96971. */
  96972. constructor(scene: Scene);
  96973. private _clearDepthStencilBuffer;
  96974. /**
  96975. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  96976. * @hidden
  96977. */
  96978. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  96979. /**
  96980. * Resets the different information of the group to prepare a new frame
  96981. * @hidden
  96982. */
  96983. reset(): void;
  96984. /**
  96985. * Dispose and release the group and its associated resources.
  96986. * @hidden
  96987. */
  96988. dispose(): void;
  96989. /**
  96990. * Clear the info related to rendering groups preventing retention points during dispose.
  96991. */
  96992. freeRenderingGroups(): void;
  96993. private _prepareRenderingGroup;
  96994. /**
  96995. * Add a sprite manager to the rendering manager in order to render it this frame.
  96996. * @param spriteManager Define the sprite manager to render
  96997. */
  96998. dispatchSprites(spriteManager: ISpriteManager): void;
  96999. /**
  97000. * Add a particle system to the rendering manager in order to render it this frame.
  97001. * @param particleSystem Define the particle system to render
  97002. */
  97003. dispatchParticles(particleSystem: IParticleSystem): void;
  97004. /**
  97005. * Add a submesh to the manager in order to render it this frame
  97006. * @param subMesh The submesh to dispatch
  97007. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  97008. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  97009. */
  97010. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  97011. /**
  97012. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  97013. * This allowed control for front to back rendering or reversly depending of the special needs.
  97014. *
  97015. * @param renderingGroupId The rendering group id corresponding to its index
  97016. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  97017. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  97018. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  97019. */
  97020. 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;
  97021. /**
  97022. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  97023. *
  97024. * @param renderingGroupId The rendering group id corresponding to its index
  97025. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  97026. * @param depth Automatically clears depth between groups if true and autoClear is true.
  97027. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  97028. */
  97029. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  97030. /**
  97031. * Gets the current auto clear configuration for one rendering group of the rendering
  97032. * manager.
  97033. * @param index the rendering group index to get the information for
  97034. * @returns The auto clear setup for the requested rendering group
  97035. */
  97036. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  97037. }
  97038. }
  97039. declare module BABYLON {
  97040. /**
  97041. * Defines the options associated with the creation of a custom shader for a shadow generator.
  97042. */
  97043. export interface ICustomShaderOptions {
  97044. /**
  97045. * Gets or sets the custom shader name to use
  97046. */
  97047. shaderName: string;
  97048. /**
  97049. * The list of attribute names used in the shader
  97050. */
  97051. attributes?: string[];
  97052. /**
  97053. * The list of unifrom names used in the shader
  97054. */
  97055. uniforms?: string[];
  97056. /**
  97057. * The list of sampler names used in the shader
  97058. */
  97059. samplers?: string[];
  97060. /**
  97061. * The list of defines used in the shader
  97062. */
  97063. defines?: string[];
  97064. }
  97065. /**
  97066. * Interface to implement to create a shadow generator compatible with BJS.
  97067. */
  97068. export interface IShadowGenerator {
  97069. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97070. id: string;
  97071. /**
  97072. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97073. * @returns The render target texture if present otherwise, null
  97074. */
  97075. getShadowMap(): Nullable<RenderTargetTexture>;
  97076. /**
  97077. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97078. * @param subMesh The submesh we want to render in the shadow map
  97079. * @param useInstances Defines wether will draw in the map using instances
  97080. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97081. * @returns true if ready otherwise, false
  97082. */
  97083. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97084. /**
  97085. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97086. * @param defines Defines of the material we want to update
  97087. * @param lightIndex Index of the light in the enabled light list of the material
  97088. */
  97089. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  97090. /**
  97091. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97092. * defined in the generator but impacting the effect).
  97093. * It implies the unifroms available on the materials are the standard BJS ones.
  97094. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97095. * @param effect The effect we are binfing the information for
  97096. */
  97097. bindShadowLight(lightIndex: string, effect: Effect): void;
  97098. /**
  97099. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97100. * (eq to shadow prjection matrix * light transform matrix)
  97101. * @returns The transform matrix used to create the shadow map
  97102. */
  97103. getTransformMatrix(): Matrix;
  97104. /**
  97105. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97106. * Cube and 2D textures for instance.
  97107. */
  97108. recreateShadowMap(): void;
  97109. /**
  97110. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97111. * @param onCompiled Callback triggered at the and of the effects compilation
  97112. * @param options Sets of optional options forcing the compilation with different modes
  97113. */
  97114. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97115. useInstances: boolean;
  97116. }>): void;
  97117. /**
  97118. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97119. * @param options Sets of optional options forcing the compilation with different modes
  97120. * @returns A promise that resolves when the compilation completes
  97121. */
  97122. forceCompilationAsync(options?: Partial<{
  97123. useInstances: boolean;
  97124. }>): Promise<void>;
  97125. /**
  97126. * Serializes the shadow generator setup to a json object.
  97127. * @returns The serialized JSON object
  97128. */
  97129. serialize(): any;
  97130. /**
  97131. * Disposes the Shadow map and related Textures and effects.
  97132. */
  97133. dispose(): void;
  97134. }
  97135. /**
  97136. * Default implementation IShadowGenerator.
  97137. * This is the main object responsible of generating shadows in the framework.
  97138. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  97139. */
  97140. export class ShadowGenerator implements IShadowGenerator {
  97141. /**
  97142. * Name of the shadow generator class
  97143. */
  97144. static CLASSNAME: string;
  97145. /**
  97146. * Shadow generator mode None: no filtering applied.
  97147. */
  97148. static readonly FILTER_NONE: number;
  97149. /**
  97150. * Shadow generator mode ESM: Exponential Shadow Mapping.
  97151. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97152. */
  97153. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  97154. /**
  97155. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  97156. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  97157. */
  97158. static readonly FILTER_POISSONSAMPLING: number;
  97159. /**
  97160. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  97161. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97162. */
  97163. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  97164. /**
  97165. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  97166. * edge artifacts on steep falloff.
  97167. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97168. */
  97169. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  97170. /**
  97171. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  97172. * edge artifacts on steep falloff.
  97173. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97174. */
  97175. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  97176. /**
  97177. * Shadow generator mode PCF: Percentage Closer Filtering
  97178. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97179. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  97180. */
  97181. static readonly FILTER_PCF: number;
  97182. /**
  97183. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  97184. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97185. * Contact Hardening
  97186. */
  97187. static readonly FILTER_PCSS: number;
  97188. /**
  97189. * Reserved for PCF and PCSS
  97190. * Highest Quality.
  97191. *
  97192. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  97193. *
  97194. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  97195. */
  97196. static readonly QUALITY_HIGH: number;
  97197. /**
  97198. * Reserved for PCF and PCSS
  97199. * Good tradeoff for quality/perf cross devices
  97200. *
  97201. * Execute PCF on a 3*3 kernel.
  97202. *
  97203. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  97204. */
  97205. static readonly QUALITY_MEDIUM: number;
  97206. /**
  97207. * Reserved for PCF and PCSS
  97208. * The lowest quality but the fastest.
  97209. *
  97210. * Execute PCF on a 1*1 kernel.
  97211. *
  97212. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  97213. */
  97214. static readonly QUALITY_LOW: number;
  97215. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97216. id: string;
  97217. /** Gets or sets the custom shader name to use */
  97218. customShaderOptions: ICustomShaderOptions;
  97219. /**
  97220. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  97221. */
  97222. onBeforeShadowMapRenderObservable: Observable<Effect>;
  97223. /**
  97224. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  97225. */
  97226. onAfterShadowMapRenderObservable: Observable<Effect>;
  97227. /**
  97228. * Observable triggered before a mesh is rendered in the shadow map.
  97229. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  97230. */
  97231. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  97232. /**
  97233. * Observable triggered after a mesh is rendered in the shadow map.
  97234. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  97235. */
  97236. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  97237. protected _bias: number;
  97238. /**
  97239. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  97240. */
  97241. get bias(): number;
  97242. /**
  97243. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  97244. */
  97245. set bias(bias: number);
  97246. protected _normalBias: number;
  97247. /**
  97248. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97249. */
  97250. get normalBias(): number;
  97251. /**
  97252. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97253. */
  97254. set normalBias(normalBias: number);
  97255. protected _blurBoxOffset: number;
  97256. /**
  97257. * Gets the blur box offset: offset applied during the blur pass.
  97258. * Only useful if useKernelBlur = false
  97259. */
  97260. get blurBoxOffset(): number;
  97261. /**
  97262. * Sets the blur box offset: offset applied during the blur pass.
  97263. * Only useful if useKernelBlur = false
  97264. */
  97265. set blurBoxOffset(value: number);
  97266. protected _blurScale: number;
  97267. /**
  97268. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  97269. * 2 means half of the size.
  97270. */
  97271. get blurScale(): number;
  97272. /**
  97273. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  97274. * 2 means half of the size.
  97275. */
  97276. set blurScale(value: number);
  97277. protected _blurKernel: number;
  97278. /**
  97279. * Gets the blur kernel: kernel size of the blur pass.
  97280. * Only useful if useKernelBlur = true
  97281. */
  97282. get blurKernel(): number;
  97283. /**
  97284. * Sets the blur kernel: kernel size of the blur pass.
  97285. * Only useful if useKernelBlur = true
  97286. */
  97287. set blurKernel(value: number);
  97288. protected _useKernelBlur: boolean;
  97289. /**
  97290. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  97291. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97292. */
  97293. get useKernelBlur(): boolean;
  97294. /**
  97295. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  97296. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97297. */
  97298. set useKernelBlur(value: boolean);
  97299. protected _depthScale: number;
  97300. /**
  97301. * Gets the depth scale used in ESM mode.
  97302. */
  97303. get depthScale(): number;
  97304. /**
  97305. * Sets the depth scale used in ESM mode.
  97306. * This can override the scale stored on the light.
  97307. */
  97308. set depthScale(value: number);
  97309. protected _validateFilter(filter: number): number;
  97310. protected _filter: number;
  97311. /**
  97312. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  97313. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97314. */
  97315. get filter(): number;
  97316. /**
  97317. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  97318. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97319. */
  97320. set filter(value: number);
  97321. /**
  97322. * Gets if the current filter is set to Poisson Sampling.
  97323. */
  97324. get usePoissonSampling(): boolean;
  97325. /**
  97326. * Sets the current filter to Poisson Sampling.
  97327. */
  97328. set usePoissonSampling(value: boolean);
  97329. /**
  97330. * Gets if the current filter is set to ESM.
  97331. */
  97332. get useExponentialShadowMap(): boolean;
  97333. /**
  97334. * Sets the current filter is to ESM.
  97335. */
  97336. set useExponentialShadowMap(value: boolean);
  97337. /**
  97338. * Gets if the current filter is set to filtered ESM.
  97339. */
  97340. get useBlurExponentialShadowMap(): boolean;
  97341. /**
  97342. * Gets if the current filter is set to filtered ESM.
  97343. */
  97344. set useBlurExponentialShadowMap(value: boolean);
  97345. /**
  97346. * Gets if the current filter is set to "close ESM" (using the inverse of the
  97347. * exponential to prevent steep falloff artifacts).
  97348. */
  97349. get useCloseExponentialShadowMap(): boolean;
  97350. /**
  97351. * Sets the current filter to "close ESM" (using the inverse of the
  97352. * exponential to prevent steep falloff artifacts).
  97353. */
  97354. set useCloseExponentialShadowMap(value: boolean);
  97355. /**
  97356. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  97357. * exponential to prevent steep falloff artifacts).
  97358. */
  97359. get useBlurCloseExponentialShadowMap(): boolean;
  97360. /**
  97361. * Sets the current filter to filtered "close ESM" (using the inverse of the
  97362. * exponential to prevent steep falloff artifacts).
  97363. */
  97364. set useBlurCloseExponentialShadowMap(value: boolean);
  97365. /**
  97366. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  97367. */
  97368. get usePercentageCloserFiltering(): boolean;
  97369. /**
  97370. * Sets the current filter to "PCF" (percentage closer filtering).
  97371. */
  97372. set usePercentageCloserFiltering(value: boolean);
  97373. protected _filteringQuality: number;
  97374. /**
  97375. * Gets the PCF or PCSS Quality.
  97376. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97377. */
  97378. get filteringQuality(): number;
  97379. /**
  97380. * Sets the PCF or PCSS Quality.
  97381. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97382. */
  97383. set filteringQuality(filteringQuality: number);
  97384. /**
  97385. * Gets if the current filter is set to "PCSS" (contact hardening).
  97386. */
  97387. get useContactHardeningShadow(): boolean;
  97388. /**
  97389. * Sets the current filter to "PCSS" (contact hardening).
  97390. */
  97391. set useContactHardeningShadow(value: boolean);
  97392. protected _contactHardeningLightSizeUVRatio: number;
  97393. /**
  97394. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97395. * Using a ratio helps keeping shape stability independently of the map size.
  97396. *
  97397. * It does not account for the light projection as it was having too much
  97398. * instability during the light setup or during light position changes.
  97399. *
  97400. * Only valid if useContactHardeningShadow is true.
  97401. */
  97402. get contactHardeningLightSizeUVRatio(): number;
  97403. /**
  97404. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97405. * Using a ratio helps keeping shape stability independently of the map size.
  97406. *
  97407. * It does not account for the light projection as it was having too much
  97408. * instability during the light setup or during light position changes.
  97409. *
  97410. * Only valid if useContactHardeningShadow is true.
  97411. */
  97412. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  97413. protected _darkness: number;
  97414. /** Gets or sets the actual darkness of a shadow */
  97415. get darkness(): number;
  97416. set darkness(value: number);
  97417. /**
  97418. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  97419. * 0 means strongest and 1 would means no shadow.
  97420. * @returns the darkness.
  97421. */
  97422. getDarkness(): number;
  97423. /**
  97424. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  97425. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  97426. * @returns the shadow generator allowing fluent coding.
  97427. */
  97428. setDarkness(darkness: number): ShadowGenerator;
  97429. protected _transparencyShadow: boolean;
  97430. /** Gets or sets the ability to have transparent shadow */
  97431. get transparencyShadow(): boolean;
  97432. set transparencyShadow(value: boolean);
  97433. /**
  97434. * Sets the ability to have transparent shadow (boolean).
  97435. * @param transparent True if transparent else False
  97436. * @returns the shadow generator allowing fluent coding
  97437. */
  97438. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  97439. /**
  97440. * Enables or disables shadows with varying strength based on the transparency
  97441. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  97442. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  97443. * mesh.visibility * alphaTexture.a
  97444. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  97445. */
  97446. enableSoftTransparentShadow: boolean;
  97447. protected _shadowMap: Nullable<RenderTargetTexture>;
  97448. protected _shadowMap2: Nullable<RenderTargetTexture>;
  97449. /**
  97450. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97451. * @returns The render target texture if present otherwise, null
  97452. */
  97453. getShadowMap(): Nullable<RenderTargetTexture>;
  97454. /**
  97455. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  97456. * @returns The render target texture if the shadow map is present otherwise, null
  97457. */
  97458. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  97459. /**
  97460. * Gets the class name of that object
  97461. * @returns "ShadowGenerator"
  97462. */
  97463. getClassName(): string;
  97464. /**
  97465. * Helper function to add a mesh and its descendants to the list of shadow casters.
  97466. * @param mesh Mesh to add
  97467. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  97468. * @returns the Shadow Generator itself
  97469. */
  97470. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97471. /**
  97472. * Helper function to remove a mesh and its descendants from the list of shadow casters
  97473. * @param mesh Mesh to remove
  97474. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  97475. * @returns the Shadow Generator itself
  97476. */
  97477. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97478. /**
  97479. * Controls the extent to which the shadows fade out at the edge of the frustum
  97480. */
  97481. frustumEdgeFalloff: number;
  97482. protected _light: IShadowLight;
  97483. /**
  97484. * Returns the associated light object.
  97485. * @returns the light generating the shadow
  97486. */
  97487. getLight(): IShadowLight;
  97488. /**
  97489. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  97490. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  97491. * It might on the other hand introduce peter panning.
  97492. */
  97493. forceBackFacesOnly: boolean;
  97494. protected _scene: Scene;
  97495. protected _lightDirection: Vector3;
  97496. protected _effect: Effect;
  97497. protected _viewMatrix: Matrix;
  97498. protected _projectionMatrix: Matrix;
  97499. protected _transformMatrix: Matrix;
  97500. protected _cachedPosition: Vector3;
  97501. protected _cachedDirection: Vector3;
  97502. protected _cachedDefines: string;
  97503. protected _currentRenderID: number;
  97504. protected _boxBlurPostprocess: Nullable<PostProcess>;
  97505. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  97506. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  97507. protected _blurPostProcesses: PostProcess[];
  97508. protected _mapSize: number;
  97509. protected _currentFaceIndex: number;
  97510. protected _currentFaceIndexCache: number;
  97511. protected _textureType: number;
  97512. protected _defaultTextureMatrix: Matrix;
  97513. protected _storedUniqueId: Nullable<number>;
  97514. /** @hidden */
  97515. static _SceneComponentInitialization: (scene: Scene) => void;
  97516. /**
  97517. * Creates a ShadowGenerator object.
  97518. * A ShadowGenerator is the required tool to use the shadows.
  97519. * Each light casting shadows needs to use its own ShadowGenerator.
  97520. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  97521. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  97522. * @param light The light object generating the shadows.
  97523. * @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.
  97524. */
  97525. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  97526. protected _initializeGenerator(): void;
  97527. protected _createTargetRenderTexture(): void;
  97528. protected _initializeShadowMap(): void;
  97529. protected _initializeBlurRTTAndPostProcesses(): void;
  97530. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  97531. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  97532. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  97533. protected _applyFilterValues(): void;
  97534. /**
  97535. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97536. * @param onCompiled Callback triggered at the and of the effects compilation
  97537. * @param options Sets of optional options forcing the compilation with different modes
  97538. */
  97539. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97540. useInstances: boolean;
  97541. }>): void;
  97542. /**
  97543. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97544. * @param options Sets of optional options forcing the compilation with different modes
  97545. * @returns A promise that resolves when the compilation completes
  97546. */
  97547. forceCompilationAsync(options?: Partial<{
  97548. useInstances: boolean;
  97549. }>): Promise<void>;
  97550. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  97551. private _prepareShadowDefines;
  97552. /**
  97553. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97554. * @param subMesh The submesh we want to render in the shadow map
  97555. * @param useInstances Defines wether will draw in the map using instances
  97556. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97557. * @returns true if ready otherwise, false
  97558. */
  97559. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97560. /**
  97561. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97562. * @param defines Defines of the material we want to update
  97563. * @param lightIndex Index of the light in the enabled light list of the material
  97564. */
  97565. prepareDefines(defines: any, lightIndex: number): void;
  97566. /**
  97567. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97568. * defined in the generator but impacting the effect).
  97569. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97570. * @param effect The effect we are binfing the information for
  97571. */
  97572. bindShadowLight(lightIndex: string, effect: Effect): void;
  97573. /**
  97574. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97575. * (eq to shadow prjection matrix * light transform matrix)
  97576. * @returns The transform matrix used to create the shadow map
  97577. */
  97578. getTransformMatrix(): Matrix;
  97579. /**
  97580. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97581. * Cube and 2D textures for instance.
  97582. */
  97583. recreateShadowMap(): void;
  97584. protected _disposeBlurPostProcesses(): void;
  97585. protected _disposeRTTandPostProcesses(): void;
  97586. /**
  97587. * Disposes the ShadowGenerator.
  97588. * Returns nothing.
  97589. */
  97590. dispose(): void;
  97591. /**
  97592. * Serializes the shadow generator setup to a json object.
  97593. * @returns The serialized JSON object
  97594. */
  97595. serialize(): any;
  97596. /**
  97597. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  97598. * @param parsedShadowGenerator The JSON object to parse
  97599. * @param scene The scene to create the shadow map for
  97600. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  97601. * @returns The parsed shadow generator
  97602. */
  97603. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  97604. }
  97605. }
  97606. declare module BABYLON {
  97607. /**
  97608. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  97609. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  97610. * 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.
  97611. */
  97612. export abstract class Light extends Node {
  97613. /**
  97614. * Falloff Default: light is falling off following the material specification:
  97615. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  97616. */
  97617. static readonly FALLOFF_DEFAULT: number;
  97618. /**
  97619. * Falloff Physical: light is falling off following the inverse squared distance law.
  97620. */
  97621. static readonly FALLOFF_PHYSICAL: number;
  97622. /**
  97623. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  97624. * to enhance interoperability with other engines.
  97625. */
  97626. static readonly FALLOFF_GLTF: number;
  97627. /**
  97628. * Falloff Standard: light is falling off like in the standard material
  97629. * to enhance interoperability with other materials.
  97630. */
  97631. static readonly FALLOFF_STANDARD: number;
  97632. /**
  97633. * If every light affecting the material is in this lightmapMode,
  97634. * material.lightmapTexture adds or multiplies
  97635. * (depends on material.useLightmapAsShadowmap)
  97636. * after every other light calculations.
  97637. */
  97638. static readonly LIGHTMAP_DEFAULT: number;
  97639. /**
  97640. * material.lightmapTexture as only diffuse lighting from this light
  97641. * adds only specular lighting from this light
  97642. * adds dynamic shadows
  97643. */
  97644. static readonly LIGHTMAP_SPECULAR: number;
  97645. /**
  97646. * material.lightmapTexture as only lighting
  97647. * no light calculation from this light
  97648. * only adds dynamic shadows from this light
  97649. */
  97650. static readonly LIGHTMAP_SHADOWSONLY: number;
  97651. /**
  97652. * Each light type uses the default quantity according to its type:
  97653. * point/spot lights use luminous intensity
  97654. * directional lights use illuminance
  97655. */
  97656. static readonly INTENSITYMODE_AUTOMATIC: number;
  97657. /**
  97658. * lumen (lm)
  97659. */
  97660. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  97661. /**
  97662. * candela (lm/sr)
  97663. */
  97664. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  97665. /**
  97666. * lux (lm/m^2)
  97667. */
  97668. static readonly INTENSITYMODE_ILLUMINANCE: number;
  97669. /**
  97670. * nit (cd/m^2)
  97671. */
  97672. static readonly INTENSITYMODE_LUMINANCE: number;
  97673. /**
  97674. * Light type const id of the point light.
  97675. */
  97676. static readonly LIGHTTYPEID_POINTLIGHT: number;
  97677. /**
  97678. * Light type const id of the directional light.
  97679. */
  97680. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  97681. /**
  97682. * Light type const id of the spot light.
  97683. */
  97684. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  97685. /**
  97686. * Light type const id of the hemispheric light.
  97687. */
  97688. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  97689. /**
  97690. * Diffuse gives the basic color to an object.
  97691. */
  97692. diffuse: Color3;
  97693. /**
  97694. * Specular produces a highlight color on an object.
  97695. * Note: This is note affecting PBR materials.
  97696. */
  97697. specular: Color3;
  97698. /**
  97699. * Defines the falloff type for this light. This lets overrriding how punctual light are
  97700. * falling off base on range or angle.
  97701. * This can be set to any values in Light.FALLOFF_x.
  97702. *
  97703. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  97704. * other types of materials.
  97705. */
  97706. falloffType: number;
  97707. /**
  97708. * Strength of the light.
  97709. * Note: By default it is define in the framework own unit.
  97710. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  97711. */
  97712. intensity: number;
  97713. private _range;
  97714. protected _inverseSquaredRange: number;
  97715. /**
  97716. * Defines how far from the source the light is impacting in scene units.
  97717. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97718. */
  97719. get range(): number;
  97720. /**
  97721. * Defines how far from the source the light is impacting in scene units.
  97722. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97723. */
  97724. set range(value: number);
  97725. /**
  97726. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  97727. * of light.
  97728. */
  97729. private _photometricScale;
  97730. private _intensityMode;
  97731. /**
  97732. * Gets the photometric scale used to interpret the intensity.
  97733. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97734. */
  97735. get intensityMode(): number;
  97736. /**
  97737. * Sets the photometric scale used to interpret the intensity.
  97738. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97739. */
  97740. set intensityMode(value: number);
  97741. private _radius;
  97742. /**
  97743. * Gets the light radius used by PBR Materials to simulate soft area lights.
  97744. */
  97745. get radius(): number;
  97746. /**
  97747. * sets the light radius used by PBR Materials to simulate soft area lights.
  97748. */
  97749. set radius(value: number);
  97750. private _renderPriority;
  97751. /**
  97752. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  97753. * exceeding the number allowed of the materials.
  97754. */
  97755. renderPriority: number;
  97756. private _shadowEnabled;
  97757. /**
  97758. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97759. * the current shadow generator.
  97760. */
  97761. get shadowEnabled(): boolean;
  97762. /**
  97763. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97764. * the current shadow generator.
  97765. */
  97766. set shadowEnabled(value: boolean);
  97767. private _includedOnlyMeshes;
  97768. /**
  97769. * Gets the only meshes impacted by this light.
  97770. */
  97771. get includedOnlyMeshes(): AbstractMesh[];
  97772. /**
  97773. * Sets the only meshes impacted by this light.
  97774. */
  97775. set includedOnlyMeshes(value: AbstractMesh[]);
  97776. private _excludedMeshes;
  97777. /**
  97778. * Gets the meshes not impacted by this light.
  97779. */
  97780. get excludedMeshes(): AbstractMesh[];
  97781. /**
  97782. * Sets the meshes not impacted by this light.
  97783. */
  97784. set excludedMeshes(value: AbstractMesh[]);
  97785. private _excludeWithLayerMask;
  97786. /**
  97787. * Gets the layer id use to find what meshes are not impacted by the light.
  97788. * Inactive if 0
  97789. */
  97790. get excludeWithLayerMask(): number;
  97791. /**
  97792. * Sets the layer id use to find what meshes are not impacted by the light.
  97793. * Inactive if 0
  97794. */
  97795. set excludeWithLayerMask(value: number);
  97796. private _includeOnlyWithLayerMask;
  97797. /**
  97798. * Gets the layer id use to find what meshes are impacted by the light.
  97799. * Inactive if 0
  97800. */
  97801. get includeOnlyWithLayerMask(): number;
  97802. /**
  97803. * Sets the layer id use to find what meshes are impacted by the light.
  97804. * Inactive if 0
  97805. */
  97806. set includeOnlyWithLayerMask(value: number);
  97807. private _lightmapMode;
  97808. /**
  97809. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97810. */
  97811. get lightmapMode(): number;
  97812. /**
  97813. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97814. */
  97815. set lightmapMode(value: number);
  97816. /**
  97817. * Shadow generator associted to the light.
  97818. * @hidden Internal use only.
  97819. */
  97820. _shadowGenerator: Nullable<IShadowGenerator>;
  97821. /**
  97822. * @hidden Internal use only.
  97823. */
  97824. _excludedMeshesIds: string[];
  97825. /**
  97826. * @hidden Internal use only.
  97827. */
  97828. _includedOnlyMeshesIds: string[];
  97829. /**
  97830. * The current light unifom buffer.
  97831. * @hidden Internal use only.
  97832. */
  97833. _uniformBuffer: UniformBuffer;
  97834. /** @hidden */
  97835. _renderId: number;
  97836. /**
  97837. * Creates a Light object in the scene.
  97838. * Documentation : https://doc.babylonjs.com/babylon101/lights
  97839. * @param name The firendly name of the light
  97840. * @param scene The scene the light belongs too
  97841. */
  97842. constructor(name: string, scene: Scene);
  97843. protected abstract _buildUniformLayout(): void;
  97844. /**
  97845. * Sets the passed Effect "effect" with the Light information.
  97846. * @param effect The effect to update
  97847. * @param lightIndex The index of the light in the effect to update
  97848. * @returns The light
  97849. */
  97850. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  97851. /**
  97852. * Sets the passed Effect "effect" with the Light textures.
  97853. * @param effect The effect to update
  97854. * @param lightIndex The index of the light in the effect to update
  97855. * @returns The light
  97856. */
  97857. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  97858. /**
  97859. * Binds the lights information from the scene to the effect for the given mesh.
  97860. * @param lightIndex Light index
  97861. * @param scene The scene where the light belongs to
  97862. * @param effect The effect we are binding the data to
  97863. * @param useSpecular Defines if specular is supported
  97864. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  97865. */
  97866. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  97867. /**
  97868. * Sets the passed Effect "effect" with the Light information.
  97869. * @param effect The effect to update
  97870. * @param lightDataUniformName The uniform used to store light data (position or direction)
  97871. * @returns The light
  97872. */
  97873. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  97874. /**
  97875. * Returns the string "Light".
  97876. * @returns the class name
  97877. */
  97878. getClassName(): string;
  97879. /** @hidden */
  97880. readonly _isLight: boolean;
  97881. /**
  97882. * Converts the light information to a readable string for debug purpose.
  97883. * @param fullDetails Supports for multiple levels of logging within scene loading
  97884. * @returns the human readable light info
  97885. */
  97886. toString(fullDetails?: boolean): string;
  97887. /** @hidden */
  97888. protected _syncParentEnabledState(): void;
  97889. /**
  97890. * Set the enabled state of this node.
  97891. * @param value - the new enabled state
  97892. */
  97893. setEnabled(value: boolean): void;
  97894. /**
  97895. * Returns the Light associated shadow generator if any.
  97896. * @return the associated shadow generator.
  97897. */
  97898. getShadowGenerator(): Nullable<IShadowGenerator>;
  97899. /**
  97900. * Returns a Vector3, the absolute light position in the World.
  97901. * @returns the world space position of the light
  97902. */
  97903. getAbsolutePosition(): Vector3;
  97904. /**
  97905. * Specifies if the light will affect the passed mesh.
  97906. * @param mesh The mesh to test against the light
  97907. * @return true the mesh is affected otherwise, false.
  97908. */
  97909. canAffectMesh(mesh: AbstractMesh): boolean;
  97910. /**
  97911. * Sort function to order lights for rendering.
  97912. * @param a First Light object to compare to second.
  97913. * @param b Second Light object to compare first.
  97914. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  97915. */
  97916. static CompareLightsPriority(a: Light, b: Light): number;
  97917. /**
  97918. * Releases resources associated with this node.
  97919. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  97920. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  97921. */
  97922. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  97923. /**
  97924. * Returns the light type ID (integer).
  97925. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  97926. */
  97927. getTypeID(): number;
  97928. /**
  97929. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  97930. * @returns the scaled intensity in intensity mode unit
  97931. */
  97932. getScaledIntensity(): number;
  97933. /**
  97934. * Returns a new Light object, named "name", from the current one.
  97935. * @param name The name of the cloned light
  97936. * @param newParent The parent of this light, if it has one
  97937. * @returns the new created light
  97938. */
  97939. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  97940. /**
  97941. * Serializes the current light into a Serialization object.
  97942. * @returns the serialized object.
  97943. */
  97944. serialize(): any;
  97945. /**
  97946. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  97947. * This new light is named "name" and added to the passed scene.
  97948. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  97949. * @param name The friendly name of the light
  97950. * @param scene The scene the new light will belong to
  97951. * @returns the constructor function
  97952. */
  97953. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  97954. /**
  97955. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  97956. * @param parsedLight The JSON representation of the light
  97957. * @param scene The scene to create the parsed light in
  97958. * @returns the created light after parsing
  97959. */
  97960. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  97961. private _hookArrayForExcluded;
  97962. private _hookArrayForIncludedOnly;
  97963. private _resyncMeshes;
  97964. /**
  97965. * Forces the meshes to update their light related information in their rendering used effects
  97966. * @hidden Internal Use Only
  97967. */
  97968. _markMeshesAsLightDirty(): void;
  97969. /**
  97970. * Recomputes the cached photometric scale if needed.
  97971. */
  97972. private _computePhotometricScale;
  97973. /**
  97974. * Returns the Photometric Scale according to the light type and intensity mode.
  97975. */
  97976. private _getPhotometricScale;
  97977. /**
  97978. * Reorder the light in the scene according to their defined priority.
  97979. * @hidden Internal Use Only
  97980. */
  97981. _reorderLightsInScene(): void;
  97982. /**
  97983. * Prepares the list of defines specific to the light type.
  97984. * @param defines the list of defines
  97985. * @param lightIndex defines the index of the light for the effect
  97986. */
  97987. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  97988. }
  97989. }
  97990. declare module BABYLON {
  97991. /**
  97992. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  97993. * This is the base of the follow, arc rotate cameras and Free camera
  97994. * @see https://doc.babylonjs.com/features/cameras
  97995. */
  97996. export class TargetCamera extends Camera {
  97997. private static _RigCamTransformMatrix;
  97998. private static _TargetTransformMatrix;
  97999. private static _TargetFocalPoint;
  98000. private _tmpUpVector;
  98001. private _tmpTargetVector;
  98002. /**
  98003. * Define the current direction the camera is moving to
  98004. */
  98005. cameraDirection: Vector3;
  98006. /**
  98007. * Define the current rotation the camera is rotating to
  98008. */
  98009. cameraRotation: Vector2;
  98010. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  98011. ignoreParentScaling: boolean;
  98012. /**
  98013. * When set, the up vector of the camera will be updated by the rotation of the camera
  98014. */
  98015. updateUpVectorFromRotation: boolean;
  98016. private _tmpQuaternion;
  98017. /**
  98018. * Define the current rotation of the camera
  98019. */
  98020. rotation: Vector3;
  98021. /**
  98022. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  98023. */
  98024. rotationQuaternion: Quaternion;
  98025. /**
  98026. * Define the current speed of the camera
  98027. */
  98028. speed: number;
  98029. /**
  98030. * Add constraint to the camera to prevent it to move freely in all directions and
  98031. * around all axis.
  98032. */
  98033. noRotationConstraint: boolean;
  98034. /**
  98035. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  98036. * panning
  98037. */
  98038. invertRotation: boolean;
  98039. /**
  98040. * Speed multiplier for inverse camera panning
  98041. */
  98042. inverseRotationSpeed: number;
  98043. /**
  98044. * Define the current target of the camera as an object or a position.
  98045. */
  98046. lockedTarget: any;
  98047. /** @hidden */
  98048. _currentTarget: Vector3;
  98049. /** @hidden */
  98050. _initialFocalDistance: number;
  98051. /** @hidden */
  98052. _viewMatrix: Matrix;
  98053. /** @hidden */
  98054. _camMatrix: Matrix;
  98055. /** @hidden */
  98056. _cameraTransformMatrix: Matrix;
  98057. /** @hidden */
  98058. _cameraRotationMatrix: Matrix;
  98059. /** @hidden */
  98060. _referencePoint: Vector3;
  98061. /** @hidden */
  98062. _transformedReferencePoint: Vector3;
  98063. /** @hidden */
  98064. _reset: () => void;
  98065. private _defaultUp;
  98066. /**
  98067. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  98068. * This is the base of the follow, arc rotate cameras and Free camera
  98069. * @see https://doc.babylonjs.com/features/cameras
  98070. * @param name Defines the name of the camera in the scene
  98071. * @param position Defines the start position of the camera in the scene
  98072. * @param scene Defines the scene the camera belongs to
  98073. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98074. */
  98075. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98076. /**
  98077. * Gets the position in front of the camera at a given distance.
  98078. * @param distance The distance from the camera we want the position to be
  98079. * @returns the position
  98080. */
  98081. getFrontPosition(distance: number): Vector3;
  98082. /** @hidden */
  98083. _getLockedTargetPosition(): Nullable<Vector3>;
  98084. private _storedPosition;
  98085. private _storedRotation;
  98086. private _storedRotationQuaternion;
  98087. /**
  98088. * Store current camera state of the camera (fov, position, rotation, etc..)
  98089. * @returns the camera
  98090. */
  98091. storeState(): Camera;
  98092. /**
  98093. * Restored camera state. You must call storeState() first
  98094. * @returns whether it was successful or not
  98095. * @hidden
  98096. */
  98097. _restoreStateValues(): boolean;
  98098. /** @hidden */
  98099. _initCache(): void;
  98100. /** @hidden */
  98101. _updateCache(ignoreParentClass?: boolean): void;
  98102. /** @hidden */
  98103. _isSynchronizedViewMatrix(): boolean;
  98104. /** @hidden */
  98105. _computeLocalCameraSpeed(): number;
  98106. /**
  98107. * Defines the target the camera should look at.
  98108. * @param target Defines the new target as a Vector or a mesh
  98109. */
  98110. setTarget(target: Vector3): void;
  98111. /**
  98112. * Defines the target point of the camera.
  98113. * The camera looks towards it form the radius distance.
  98114. */
  98115. get target(): Vector3;
  98116. set target(value: Vector3);
  98117. /**
  98118. * Return the current target position of the camera. This value is expressed in local space.
  98119. * @returns the target position
  98120. */
  98121. getTarget(): Vector3;
  98122. /** @hidden */
  98123. _decideIfNeedsToMove(): boolean;
  98124. /** @hidden */
  98125. _updatePosition(): void;
  98126. /** @hidden */
  98127. _checkInputs(): void;
  98128. protected _updateCameraRotationMatrix(): void;
  98129. /**
  98130. * 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)
  98131. * @returns the current camera
  98132. */
  98133. private _rotateUpVectorWithCameraRotationMatrix;
  98134. private _cachedRotationZ;
  98135. private _cachedQuaternionRotationZ;
  98136. /** @hidden */
  98137. _getViewMatrix(): Matrix;
  98138. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  98139. /**
  98140. * @hidden
  98141. */
  98142. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  98143. /**
  98144. * @hidden
  98145. */
  98146. _updateRigCameras(): void;
  98147. private _getRigCamPositionAndTarget;
  98148. /**
  98149. * Gets the current object class name.
  98150. * @return the class name
  98151. */
  98152. getClassName(): string;
  98153. }
  98154. }
  98155. declare module BABYLON {
  98156. /**
  98157. * Gather the list of keyboard event types as constants.
  98158. */
  98159. export class KeyboardEventTypes {
  98160. /**
  98161. * The keydown event is fired when a key becomes active (pressed).
  98162. */
  98163. static readonly KEYDOWN: number;
  98164. /**
  98165. * The keyup event is fired when a key has been released.
  98166. */
  98167. static readonly KEYUP: number;
  98168. }
  98169. /**
  98170. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98171. */
  98172. export class KeyboardInfo {
  98173. /**
  98174. * Defines the type of event (KeyboardEventTypes)
  98175. */
  98176. type: number;
  98177. /**
  98178. * Defines the related dom event
  98179. */
  98180. event: KeyboardEvent;
  98181. /**
  98182. * Instantiates a new keyboard info.
  98183. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98184. * @param type Defines the type of event (KeyboardEventTypes)
  98185. * @param event Defines the related dom event
  98186. */
  98187. constructor(
  98188. /**
  98189. * Defines the type of event (KeyboardEventTypes)
  98190. */
  98191. type: number,
  98192. /**
  98193. * Defines the related dom event
  98194. */
  98195. event: KeyboardEvent);
  98196. }
  98197. /**
  98198. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98199. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  98200. */
  98201. export class KeyboardInfoPre extends KeyboardInfo {
  98202. /**
  98203. * Defines the type of event (KeyboardEventTypes)
  98204. */
  98205. type: number;
  98206. /**
  98207. * Defines the related dom event
  98208. */
  98209. event: KeyboardEvent;
  98210. /**
  98211. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  98212. */
  98213. skipOnPointerObservable: boolean;
  98214. /**
  98215. * Instantiates a new keyboard pre info.
  98216. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98217. * @param type Defines the type of event (KeyboardEventTypes)
  98218. * @param event Defines the related dom event
  98219. */
  98220. constructor(
  98221. /**
  98222. * Defines the type of event (KeyboardEventTypes)
  98223. */
  98224. type: number,
  98225. /**
  98226. * Defines the related dom event
  98227. */
  98228. event: KeyboardEvent);
  98229. }
  98230. }
  98231. declare module BABYLON {
  98232. /**
  98233. * Manage the keyboard inputs to control the movement of a free camera.
  98234. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98235. */
  98236. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  98237. /**
  98238. * Defines the camera the input is attached to.
  98239. */
  98240. camera: FreeCamera;
  98241. /**
  98242. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98243. */
  98244. keysUp: number[];
  98245. /**
  98246. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98247. */
  98248. keysUpward: number[];
  98249. /**
  98250. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98251. */
  98252. keysDown: number[];
  98253. /**
  98254. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98255. */
  98256. keysDownward: number[];
  98257. /**
  98258. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98259. */
  98260. keysLeft: number[];
  98261. /**
  98262. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98263. */
  98264. keysRight: number[];
  98265. private _keys;
  98266. private _onCanvasBlurObserver;
  98267. private _onKeyboardObserver;
  98268. private _engine;
  98269. private _scene;
  98270. /**
  98271. * Attach the input controls to a specific dom element to get the input from.
  98272. * @param element Defines the element the controls should be listened from
  98273. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98274. */
  98275. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98276. /**
  98277. * Detach the current controls from the specified dom element.
  98278. * @param element Defines the element to stop listening the inputs from
  98279. */
  98280. detachControl(element: Nullable<HTMLElement>): void;
  98281. /**
  98282. * Update the current camera state depending on the inputs that have been used this frame.
  98283. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98284. */
  98285. checkInputs(): void;
  98286. /**
  98287. * Gets the class name of the current intput.
  98288. * @returns the class name
  98289. */
  98290. getClassName(): string;
  98291. /** @hidden */
  98292. _onLostFocus(): void;
  98293. /**
  98294. * Get the friendly name associated with the input class.
  98295. * @returns the input friendly name
  98296. */
  98297. getSimpleName(): string;
  98298. }
  98299. }
  98300. declare module BABYLON {
  98301. /**
  98302. * Gather the list of pointer event types as constants.
  98303. */
  98304. export class PointerEventTypes {
  98305. /**
  98306. * 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.
  98307. */
  98308. static readonly POINTERDOWN: number;
  98309. /**
  98310. * The pointerup event is fired when a pointer is no longer active.
  98311. */
  98312. static readonly POINTERUP: number;
  98313. /**
  98314. * The pointermove event is fired when a pointer changes coordinates.
  98315. */
  98316. static readonly POINTERMOVE: number;
  98317. /**
  98318. * The pointerwheel event is fired when a mouse wheel has been rotated.
  98319. */
  98320. static readonly POINTERWHEEL: number;
  98321. /**
  98322. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  98323. */
  98324. static readonly POINTERPICK: number;
  98325. /**
  98326. * The pointertap event is fired when a the object has been touched and released without drag.
  98327. */
  98328. static readonly POINTERTAP: number;
  98329. /**
  98330. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  98331. */
  98332. static readonly POINTERDOUBLETAP: number;
  98333. }
  98334. /**
  98335. * Base class of pointer info types.
  98336. */
  98337. export class PointerInfoBase {
  98338. /**
  98339. * Defines the type of event (PointerEventTypes)
  98340. */
  98341. type: number;
  98342. /**
  98343. * Defines the related dom event
  98344. */
  98345. event: PointerEvent | MouseWheelEvent;
  98346. /**
  98347. * Instantiates the base class of pointers info.
  98348. * @param type Defines the type of event (PointerEventTypes)
  98349. * @param event Defines the related dom event
  98350. */
  98351. constructor(
  98352. /**
  98353. * Defines the type of event (PointerEventTypes)
  98354. */
  98355. type: number,
  98356. /**
  98357. * Defines the related dom event
  98358. */
  98359. event: PointerEvent | MouseWheelEvent);
  98360. }
  98361. /**
  98362. * This class is used to store pointer related info for the onPrePointerObservable event.
  98363. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  98364. */
  98365. export class PointerInfoPre extends PointerInfoBase {
  98366. /**
  98367. * Ray from a pointer if availible (eg. 6dof controller)
  98368. */
  98369. ray: Nullable<Ray>;
  98370. /**
  98371. * Defines the local position of the pointer on the canvas.
  98372. */
  98373. localPosition: Vector2;
  98374. /**
  98375. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  98376. */
  98377. skipOnPointerObservable: boolean;
  98378. /**
  98379. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  98380. * @param type Defines the type of event (PointerEventTypes)
  98381. * @param event Defines the related dom event
  98382. * @param localX Defines the local x coordinates of the pointer when the event occured
  98383. * @param localY Defines the local y coordinates of the pointer when the event occured
  98384. */
  98385. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  98386. }
  98387. /**
  98388. * This type contains all the data related to a pointer event in Babylon.js.
  98389. * 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.
  98390. */
  98391. export class PointerInfo extends PointerInfoBase {
  98392. /**
  98393. * Defines the picking info associated to the info (if any)\
  98394. */
  98395. pickInfo: Nullable<PickingInfo>;
  98396. /**
  98397. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  98398. * @param type Defines the type of event (PointerEventTypes)
  98399. * @param event Defines the related dom event
  98400. * @param pickInfo Defines the picking info associated to the info (if any)\
  98401. */
  98402. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  98403. /**
  98404. * Defines the picking info associated to the info (if any)\
  98405. */
  98406. pickInfo: Nullable<PickingInfo>);
  98407. }
  98408. /**
  98409. * Data relating to a touch event on the screen.
  98410. */
  98411. export interface PointerTouch {
  98412. /**
  98413. * X coordinate of touch.
  98414. */
  98415. x: number;
  98416. /**
  98417. * Y coordinate of touch.
  98418. */
  98419. y: number;
  98420. /**
  98421. * Id of touch. Unique for each finger.
  98422. */
  98423. pointerId: number;
  98424. /**
  98425. * Event type passed from DOM.
  98426. */
  98427. type: any;
  98428. }
  98429. }
  98430. declare module BABYLON {
  98431. /**
  98432. * Manage the mouse inputs to control the movement of a free camera.
  98433. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98434. */
  98435. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  98436. /**
  98437. * Define if touch is enabled in the mouse input
  98438. */
  98439. touchEnabled: boolean;
  98440. /**
  98441. * Defines the camera the input is attached to.
  98442. */
  98443. camera: FreeCamera;
  98444. /**
  98445. * Defines the buttons associated with the input to handle camera move.
  98446. */
  98447. buttons: number[];
  98448. /**
  98449. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  98450. */
  98451. angularSensibility: number;
  98452. private _pointerInput;
  98453. private _onMouseMove;
  98454. private _observer;
  98455. private previousPosition;
  98456. /**
  98457. * Observable for when a pointer move event occurs containing the move offset
  98458. */
  98459. onPointerMovedObservable: Observable<{
  98460. offsetX: number;
  98461. offsetY: number;
  98462. }>;
  98463. /**
  98464. * @hidden
  98465. * If the camera should be rotated automatically based on pointer movement
  98466. */
  98467. _allowCameraRotation: boolean;
  98468. /**
  98469. * Manage the mouse inputs to control the movement of a free camera.
  98470. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98471. * @param touchEnabled Defines if touch is enabled or not
  98472. */
  98473. constructor(
  98474. /**
  98475. * Define if touch is enabled in the mouse input
  98476. */
  98477. touchEnabled?: boolean);
  98478. /**
  98479. * Attach the input controls to a specific dom element to get the input from.
  98480. * @param element Defines the element the controls should be listened from
  98481. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98482. */
  98483. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98484. /**
  98485. * Called on JS contextmenu event.
  98486. * Override this method to provide functionality.
  98487. */
  98488. protected onContextMenu(evt: PointerEvent): void;
  98489. /**
  98490. * Detach the current controls from the specified dom element.
  98491. * @param element Defines the element to stop listening the inputs from
  98492. */
  98493. detachControl(element: Nullable<HTMLElement>): void;
  98494. /**
  98495. * Gets the class name of the current intput.
  98496. * @returns the class name
  98497. */
  98498. getClassName(): string;
  98499. /**
  98500. * Get the friendly name associated with the input class.
  98501. * @returns the input friendly name
  98502. */
  98503. getSimpleName(): string;
  98504. }
  98505. }
  98506. declare module BABYLON {
  98507. /**
  98508. * Manage the touch inputs to control the movement of a free camera.
  98509. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98510. */
  98511. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  98512. /**
  98513. * Define if mouse events can be treated as touch events
  98514. */
  98515. allowMouse: boolean;
  98516. /**
  98517. * Defines the camera the input is attached to.
  98518. */
  98519. camera: FreeCamera;
  98520. /**
  98521. * Defines the touch sensibility for rotation.
  98522. * The higher the faster.
  98523. */
  98524. touchAngularSensibility: number;
  98525. /**
  98526. * Defines the touch sensibility for move.
  98527. * The higher the faster.
  98528. */
  98529. touchMoveSensibility: number;
  98530. private _offsetX;
  98531. private _offsetY;
  98532. private _pointerPressed;
  98533. private _pointerInput;
  98534. private _observer;
  98535. private _onLostFocus;
  98536. /**
  98537. * Manage the touch inputs to control the movement of a free camera.
  98538. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98539. * @param allowMouse Defines if mouse events can be treated as touch events
  98540. */
  98541. constructor(
  98542. /**
  98543. * Define if mouse events can be treated as touch events
  98544. */
  98545. allowMouse?: boolean);
  98546. /**
  98547. * Attach the input controls to a specific dom element to get the input from.
  98548. * @param element Defines the element the controls should be listened from
  98549. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98550. */
  98551. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98552. /**
  98553. * Detach the current controls from the specified dom element.
  98554. * @param element Defines the element to stop listening the inputs from
  98555. */
  98556. detachControl(element: Nullable<HTMLElement>): void;
  98557. /**
  98558. * Update the current camera state depending on the inputs that have been used this frame.
  98559. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98560. */
  98561. checkInputs(): void;
  98562. /**
  98563. * Gets the class name of the current intput.
  98564. * @returns the class name
  98565. */
  98566. getClassName(): string;
  98567. /**
  98568. * Get the friendly name associated with the input class.
  98569. * @returns the input friendly name
  98570. */
  98571. getSimpleName(): string;
  98572. }
  98573. }
  98574. declare module BABYLON {
  98575. /**
  98576. * Default Inputs manager for the FreeCamera.
  98577. * It groups all the default supported inputs for ease of use.
  98578. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98579. */
  98580. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  98581. /**
  98582. * @hidden
  98583. */
  98584. _mouseInput: Nullable<FreeCameraMouseInput>;
  98585. /**
  98586. * Instantiates a new FreeCameraInputsManager.
  98587. * @param camera Defines the camera the inputs belong to
  98588. */
  98589. constructor(camera: FreeCamera);
  98590. /**
  98591. * Add keyboard input support to the input manager.
  98592. * @returns the current input manager
  98593. */
  98594. addKeyboard(): FreeCameraInputsManager;
  98595. /**
  98596. * Add mouse input support to the input manager.
  98597. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  98598. * @returns the current input manager
  98599. */
  98600. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  98601. /**
  98602. * Removes the mouse input support from the manager
  98603. * @returns the current input manager
  98604. */
  98605. removeMouse(): FreeCameraInputsManager;
  98606. /**
  98607. * Add touch input support to the input manager.
  98608. * @returns the current input manager
  98609. */
  98610. addTouch(): FreeCameraInputsManager;
  98611. /**
  98612. * Remove all attached input methods from a camera
  98613. */
  98614. clear(): void;
  98615. }
  98616. }
  98617. declare module BABYLON {
  98618. /**
  98619. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98620. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  98621. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98622. */
  98623. export class FreeCamera extends TargetCamera {
  98624. /**
  98625. * Define the collision ellipsoid of the camera.
  98626. * This is helpful to simulate a camera body like the player body around the camera
  98627. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  98628. */
  98629. ellipsoid: Vector3;
  98630. /**
  98631. * Define an offset for the position of the ellipsoid around the camera.
  98632. * This can be helpful to determine the center of the body near the gravity center of the body
  98633. * instead of its head.
  98634. */
  98635. ellipsoidOffset: Vector3;
  98636. /**
  98637. * Enable or disable collisions of the camera with the rest of the scene objects.
  98638. */
  98639. checkCollisions: boolean;
  98640. /**
  98641. * Enable or disable gravity on the camera.
  98642. */
  98643. applyGravity: boolean;
  98644. /**
  98645. * Define the input manager associated to the camera.
  98646. */
  98647. inputs: FreeCameraInputsManager;
  98648. /**
  98649. * Gets the input sensibility for a mouse input. (default is 2000.0)
  98650. * Higher values reduce sensitivity.
  98651. */
  98652. get angularSensibility(): number;
  98653. /**
  98654. * Sets the input sensibility for a mouse input. (default is 2000.0)
  98655. * Higher values reduce sensitivity.
  98656. */
  98657. set angularSensibility(value: number);
  98658. /**
  98659. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98660. */
  98661. get keysUp(): number[];
  98662. set keysUp(value: number[]);
  98663. /**
  98664. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98665. */
  98666. get keysUpward(): number[];
  98667. set keysUpward(value: number[]);
  98668. /**
  98669. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98670. */
  98671. get keysDown(): number[];
  98672. set keysDown(value: number[]);
  98673. /**
  98674. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98675. */
  98676. get keysDownward(): number[];
  98677. set keysDownward(value: number[]);
  98678. /**
  98679. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98680. */
  98681. get keysLeft(): number[];
  98682. set keysLeft(value: number[]);
  98683. /**
  98684. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98685. */
  98686. get keysRight(): number[];
  98687. set keysRight(value: number[]);
  98688. /**
  98689. * Event raised when the camera collide with a mesh in the scene.
  98690. */
  98691. onCollide: (collidedMesh: AbstractMesh) => void;
  98692. private _collider;
  98693. private _needMoveForGravity;
  98694. private _oldPosition;
  98695. private _diffPosition;
  98696. private _newPosition;
  98697. /** @hidden */
  98698. _localDirection: Vector3;
  98699. /** @hidden */
  98700. _transformedDirection: Vector3;
  98701. /**
  98702. * Instantiates a Free Camera.
  98703. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98704. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  98705. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98706. * @param name Define the name of the camera in the scene
  98707. * @param position Define the start position of the camera in the scene
  98708. * @param scene Define the scene the camera belongs to
  98709. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98710. */
  98711. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98712. /**
  98713. * Attached controls to the current camera.
  98714. * @param element Defines the element the controls should be listened from
  98715. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98716. */
  98717. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98718. /**
  98719. * Detach the current controls from the camera.
  98720. * The camera will stop reacting to inputs.
  98721. * @param element Defines the element to stop listening the inputs from
  98722. */
  98723. detachControl(element: HTMLElement): void;
  98724. private _collisionMask;
  98725. /**
  98726. * Define a collision mask to limit the list of object the camera can collide with
  98727. */
  98728. get collisionMask(): number;
  98729. set collisionMask(mask: number);
  98730. /** @hidden */
  98731. _collideWithWorld(displacement: Vector3): void;
  98732. private _onCollisionPositionChange;
  98733. /** @hidden */
  98734. _checkInputs(): void;
  98735. /** @hidden */
  98736. _decideIfNeedsToMove(): boolean;
  98737. /** @hidden */
  98738. _updatePosition(): void;
  98739. /**
  98740. * Destroy the camera and release the current resources hold by it.
  98741. */
  98742. dispose(): void;
  98743. /**
  98744. * Gets the current object class name.
  98745. * @return the class name
  98746. */
  98747. getClassName(): string;
  98748. }
  98749. }
  98750. declare module BABYLON {
  98751. /**
  98752. * Represents a gamepad control stick position
  98753. */
  98754. export class StickValues {
  98755. /**
  98756. * The x component of the control stick
  98757. */
  98758. x: number;
  98759. /**
  98760. * The y component of the control stick
  98761. */
  98762. y: number;
  98763. /**
  98764. * Initializes the gamepad x and y control stick values
  98765. * @param x The x component of the gamepad control stick value
  98766. * @param y The y component of the gamepad control stick value
  98767. */
  98768. constructor(
  98769. /**
  98770. * The x component of the control stick
  98771. */
  98772. x: number,
  98773. /**
  98774. * The y component of the control stick
  98775. */
  98776. y: number);
  98777. }
  98778. /**
  98779. * An interface which manages callbacks for gamepad button changes
  98780. */
  98781. export interface GamepadButtonChanges {
  98782. /**
  98783. * Called when a gamepad has been changed
  98784. */
  98785. changed: boolean;
  98786. /**
  98787. * Called when a gamepad press event has been triggered
  98788. */
  98789. pressChanged: boolean;
  98790. /**
  98791. * Called when a touch event has been triggered
  98792. */
  98793. touchChanged: boolean;
  98794. /**
  98795. * Called when a value has changed
  98796. */
  98797. valueChanged: boolean;
  98798. }
  98799. /**
  98800. * Represents a gamepad
  98801. */
  98802. export class Gamepad {
  98803. /**
  98804. * The id of the gamepad
  98805. */
  98806. id: string;
  98807. /**
  98808. * The index of the gamepad
  98809. */
  98810. index: number;
  98811. /**
  98812. * The browser gamepad
  98813. */
  98814. browserGamepad: any;
  98815. /**
  98816. * Specifies what type of gamepad this represents
  98817. */
  98818. type: number;
  98819. private _leftStick;
  98820. private _rightStick;
  98821. /** @hidden */
  98822. _isConnected: boolean;
  98823. private _leftStickAxisX;
  98824. private _leftStickAxisY;
  98825. private _rightStickAxisX;
  98826. private _rightStickAxisY;
  98827. /**
  98828. * Triggered when the left control stick has been changed
  98829. */
  98830. private _onleftstickchanged;
  98831. /**
  98832. * Triggered when the right control stick has been changed
  98833. */
  98834. private _onrightstickchanged;
  98835. /**
  98836. * Represents a gamepad controller
  98837. */
  98838. static GAMEPAD: number;
  98839. /**
  98840. * Represents a generic controller
  98841. */
  98842. static GENERIC: number;
  98843. /**
  98844. * Represents an XBox controller
  98845. */
  98846. static XBOX: number;
  98847. /**
  98848. * Represents a pose-enabled controller
  98849. */
  98850. static POSE_ENABLED: number;
  98851. /**
  98852. * Represents an Dual Shock controller
  98853. */
  98854. static DUALSHOCK: number;
  98855. /**
  98856. * Specifies whether the left control stick should be Y-inverted
  98857. */
  98858. protected _invertLeftStickY: boolean;
  98859. /**
  98860. * Specifies if the gamepad has been connected
  98861. */
  98862. get isConnected(): boolean;
  98863. /**
  98864. * Initializes the gamepad
  98865. * @param id The id of the gamepad
  98866. * @param index The index of the gamepad
  98867. * @param browserGamepad The browser gamepad
  98868. * @param leftStickX The x component of the left joystick
  98869. * @param leftStickY The y component of the left joystick
  98870. * @param rightStickX The x component of the right joystick
  98871. * @param rightStickY The y component of the right joystick
  98872. */
  98873. constructor(
  98874. /**
  98875. * The id of the gamepad
  98876. */
  98877. id: string,
  98878. /**
  98879. * The index of the gamepad
  98880. */
  98881. index: number,
  98882. /**
  98883. * The browser gamepad
  98884. */
  98885. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  98886. /**
  98887. * Callback triggered when the left joystick has changed
  98888. * @param callback
  98889. */
  98890. onleftstickchanged(callback: (values: StickValues) => void): void;
  98891. /**
  98892. * Callback triggered when the right joystick has changed
  98893. * @param callback
  98894. */
  98895. onrightstickchanged(callback: (values: StickValues) => void): void;
  98896. /**
  98897. * Gets the left joystick
  98898. */
  98899. get leftStick(): StickValues;
  98900. /**
  98901. * Sets the left joystick values
  98902. */
  98903. set leftStick(newValues: StickValues);
  98904. /**
  98905. * Gets the right joystick
  98906. */
  98907. get rightStick(): StickValues;
  98908. /**
  98909. * Sets the right joystick value
  98910. */
  98911. set rightStick(newValues: StickValues);
  98912. /**
  98913. * Updates the gamepad joystick positions
  98914. */
  98915. update(): void;
  98916. /**
  98917. * Disposes the gamepad
  98918. */
  98919. dispose(): void;
  98920. }
  98921. /**
  98922. * Represents a generic gamepad
  98923. */
  98924. export class GenericPad extends Gamepad {
  98925. private _buttons;
  98926. private _onbuttondown;
  98927. private _onbuttonup;
  98928. /**
  98929. * Observable triggered when a button has been pressed
  98930. */
  98931. onButtonDownObservable: Observable<number>;
  98932. /**
  98933. * Observable triggered when a button has been released
  98934. */
  98935. onButtonUpObservable: Observable<number>;
  98936. /**
  98937. * Callback triggered when a button has been pressed
  98938. * @param callback Called when a button has been pressed
  98939. */
  98940. onbuttondown(callback: (buttonPressed: number) => void): void;
  98941. /**
  98942. * Callback triggered when a button has been released
  98943. * @param callback Called when a button has been released
  98944. */
  98945. onbuttonup(callback: (buttonReleased: number) => void): void;
  98946. /**
  98947. * Initializes the generic gamepad
  98948. * @param id The id of the generic gamepad
  98949. * @param index The index of the generic gamepad
  98950. * @param browserGamepad The browser gamepad
  98951. */
  98952. constructor(id: string, index: number, browserGamepad: any);
  98953. private _setButtonValue;
  98954. /**
  98955. * Updates the generic gamepad
  98956. */
  98957. update(): void;
  98958. /**
  98959. * Disposes the generic gamepad
  98960. */
  98961. dispose(): void;
  98962. }
  98963. }
  98964. declare module BABYLON {
  98965. /**
  98966. * Defines the types of pose enabled controllers that are supported
  98967. */
  98968. export enum PoseEnabledControllerType {
  98969. /**
  98970. * HTC Vive
  98971. */
  98972. VIVE = 0,
  98973. /**
  98974. * Oculus Rift
  98975. */
  98976. OCULUS = 1,
  98977. /**
  98978. * Windows mixed reality
  98979. */
  98980. WINDOWS = 2,
  98981. /**
  98982. * Samsung gear VR
  98983. */
  98984. GEAR_VR = 3,
  98985. /**
  98986. * Google Daydream
  98987. */
  98988. DAYDREAM = 4,
  98989. /**
  98990. * Generic
  98991. */
  98992. GENERIC = 5
  98993. }
  98994. /**
  98995. * Defines the MutableGamepadButton interface for the state of a gamepad button
  98996. */
  98997. export interface MutableGamepadButton {
  98998. /**
  98999. * Value of the button/trigger
  99000. */
  99001. value: number;
  99002. /**
  99003. * If the button/trigger is currently touched
  99004. */
  99005. touched: boolean;
  99006. /**
  99007. * If the button/trigger is currently pressed
  99008. */
  99009. pressed: boolean;
  99010. }
  99011. /**
  99012. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  99013. * @hidden
  99014. */
  99015. export interface ExtendedGamepadButton extends GamepadButton {
  99016. /**
  99017. * If the button/trigger is currently pressed
  99018. */
  99019. readonly pressed: boolean;
  99020. /**
  99021. * If the button/trigger is currently touched
  99022. */
  99023. readonly touched: boolean;
  99024. /**
  99025. * Value of the button/trigger
  99026. */
  99027. readonly value: number;
  99028. }
  99029. /** @hidden */
  99030. export interface _GamePadFactory {
  99031. /**
  99032. * Returns whether or not the current gamepad can be created for this type of controller.
  99033. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99034. * @returns true if it can be created, otherwise false
  99035. */
  99036. canCreate(gamepadInfo: any): boolean;
  99037. /**
  99038. * Creates a new instance of the Gamepad.
  99039. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99040. * @returns the new gamepad instance
  99041. */
  99042. create(gamepadInfo: any): Gamepad;
  99043. }
  99044. /**
  99045. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99046. */
  99047. export class PoseEnabledControllerHelper {
  99048. /** @hidden */
  99049. static _ControllerFactories: _GamePadFactory[];
  99050. /** @hidden */
  99051. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  99052. /**
  99053. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99054. * @param vrGamepad the gamepad to initialized
  99055. * @returns a vr controller of the type the gamepad identified as
  99056. */
  99057. static InitiateController(vrGamepad: any): Gamepad;
  99058. }
  99059. /**
  99060. * Defines the PoseEnabledController object that contains state of a vr capable controller
  99061. */
  99062. export class PoseEnabledController extends Gamepad implements PoseControlled {
  99063. /**
  99064. * If the controller is used in a webXR session
  99065. */
  99066. isXR: boolean;
  99067. private _deviceRoomPosition;
  99068. private _deviceRoomRotationQuaternion;
  99069. /**
  99070. * The device position in babylon space
  99071. */
  99072. devicePosition: Vector3;
  99073. /**
  99074. * The device rotation in babylon space
  99075. */
  99076. deviceRotationQuaternion: Quaternion;
  99077. /**
  99078. * The scale factor of the device in babylon space
  99079. */
  99080. deviceScaleFactor: number;
  99081. /**
  99082. * (Likely devicePosition should be used instead) The device position in its room space
  99083. */
  99084. position: Vector3;
  99085. /**
  99086. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  99087. */
  99088. rotationQuaternion: Quaternion;
  99089. /**
  99090. * The type of controller (Eg. Windows mixed reality)
  99091. */
  99092. controllerType: PoseEnabledControllerType;
  99093. protected _calculatedPosition: Vector3;
  99094. private _calculatedRotation;
  99095. /**
  99096. * The raw pose from the device
  99097. */
  99098. rawPose: DevicePose;
  99099. private _trackPosition;
  99100. private _maxRotationDistFromHeadset;
  99101. private _draggedRoomRotation;
  99102. /**
  99103. * @hidden
  99104. */
  99105. _disableTrackPosition(fixedPosition: Vector3): void;
  99106. /**
  99107. * Internal, the mesh attached to the controller
  99108. * @hidden
  99109. */
  99110. _mesh: Nullable<AbstractMesh>;
  99111. private _poseControlledCamera;
  99112. private _leftHandSystemQuaternion;
  99113. /**
  99114. * Internal, matrix used to convert room space to babylon space
  99115. * @hidden
  99116. */
  99117. _deviceToWorld: Matrix;
  99118. /**
  99119. * Node to be used when casting a ray from the controller
  99120. * @hidden
  99121. */
  99122. _pointingPoseNode: Nullable<TransformNode>;
  99123. /**
  99124. * Name of the child mesh that can be used to cast a ray from the controller
  99125. */
  99126. static readonly POINTING_POSE: string;
  99127. /**
  99128. * Creates a new PoseEnabledController from a gamepad
  99129. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  99130. */
  99131. constructor(browserGamepad: any);
  99132. private _workingMatrix;
  99133. /**
  99134. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  99135. */
  99136. update(): void;
  99137. /**
  99138. * Updates only the pose device and mesh without doing any button event checking
  99139. */
  99140. protected _updatePoseAndMesh(): void;
  99141. /**
  99142. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  99143. * @param poseData raw pose fromthe device
  99144. */
  99145. updateFromDevice(poseData: DevicePose): void;
  99146. /**
  99147. * @hidden
  99148. */
  99149. _meshAttachedObservable: Observable<AbstractMesh>;
  99150. /**
  99151. * Attaches a mesh to the controller
  99152. * @param mesh the mesh to be attached
  99153. */
  99154. attachToMesh(mesh: AbstractMesh): void;
  99155. /**
  99156. * Attaches the controllers mesh to a camera
  99157. * @param camera the camera the mesh should be attached to
  99158. */
  99159. attachToPoseControlledCamera(camera: TargetCamera): void;
  99160. /**
  99161. * Disposes of the controller
  99162. */
  99163. dispose(): void;
  99164. /**
  99165. * The mesh that is attached to the controller
  99166. */
  99167. get mesh(): Nullable<AbstractMesh>;
  99168. /**
  99169. * Gets the ray of the controller in the direction the controller is pointing
  99170. * @param length the length the resulting ray should be
  99171. * @returns a ray in the direction the controller is pointing
  99172. */
  99173. getForwardRay(length?: number): Ray;
  99174. }
  99175. }
  99176. declare module BABYLON {
  99177. /**
  99178. * Defines the WebVRController object that represents controllers tracked in 3D space
  99179. */
  99180. export abstract class WebVRController extends PoseEnabledController {
  99181. /**
  99182. * Internal, the default controller model for the controller
  99183. */
  99184. protected _defaultModel: Nullable<AbstractMesh>;
  99185. /**
  99186. * Fired when the trigger state has changed
  99187. */
  99188. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  99189. /**
  99190. * Fired when the main button state has changed
  99191. */
  99192. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99193. /**
  99194. * Fired when the secondary button state has changed
  99195. */
  99196. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99197. /**
  99198. * Fired when the pad state has changed
  99199. */
  99200. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  99201. /**
  99202. * Fired when controllers stick values have changed
  99203. */
  99204. onPadValuesChangedObservable: Observable<StickValues>;
  99205. /**
  99206. * Array of button availible on the controller
  99207. */
  99208. protected _buttons: Array<MutableGamepadButton>;
  99209. private _onButtonStateChange;
  99210. /**
  99211. * Fired when a controller button's state has changed
  99212. * @param callback the callback containing the button that was modified
  99213. */
  99214. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  99215. /**
  99216. * X and Y axis corresponding to the controllers joystick
  99217. */
  99218. pad: StickValues;
  99219. /**
  99220. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  99221. */
  99222. hand: string;
  99223. /**
  99224. * The default controller model for the controller
  99225. */
  99226. get defaultModel(): Nullable<AbstractMesh>;
  99227. /**
  99228. * Creates a new WebVRController from a gamepad
  99229. * @param vrGamepad the gamepad that the WebVRController should be created from
  99230. */
  99231. constructor(vrGamepad: any);
  99232. /**
  99233. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  99234. */
  99235. update(): void;
  99236. /**
  99237. * Function to be called when a button is modified
  99238. */
  99239. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  99240. /**
  99241. * Loads a mesh and attaches it to the controller
  99242. * @param scene the scene the mesh should be added to
  99243. * @param meshLoaded callback for when the mesh has been loaded
  99244. */
  99245. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  99246. private _setButtonValue;
  99247. private _changes;
  99248. private _checkChanges;
  99249. /**
  99250. * Disposes of th webVRCOntroller
  99251. */
  99252. dispose(): void;
  99253. }
  99254. }
  99255. declare module BABYLON {
  99256. /**
  99257. * The HemisphericLight simulates the ambient environment light,
  99258. * so the passed direction is the light reflection direction, not the incoming direction.
  99259. */
  99260. export class HemisphericLight extends Light {
  99261. /**
  99262. * The groundColor is the light in the opposite direction to the one specified during creation.
  99263. * 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.
  99264. */
  99265. groundColor: Color3;
  99266. /**
  99267. * The light reflection direction, not the incoming direction.
  99268. */
  99269. direction: Vector3;
  99270. /**
  99271. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  99272. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  99273. * The HemisphericLight can't cast shadows.
  99274. * Documentation : https://doc.babylonjs.com/babylon101/lights
  99275. * @param name The friendly name of the light
  99276. * @param direction The direction of the light reflection
  99277. * @param scene The scene the light belongs to
  99278. */
  99279. constructor(name: string, direction: Vector3, scene: Scene);
  99280. protected _buildUniformLayout(): void;
  99281. /**
  99282. * Returns the string "HemisphericLight".
  99283. * @return The class name
  99284. */
  99285. getClassName(): string;
  99286. /**
  99287. * Sets the HemisphericLight direction towards the passed target (Vector3).
  99288. * Returns the updated direction.
  99289. * @param target The target the direction should point to
  99290. * @return The computed direction
  99291. */
  99292. setDirectionToTarget(target: Vector3): Vector3;
  99293. /**
  99294. * Returns the shadow generator associated to the light.
  99295. * @returns Always null for hemispheric lights because it does not support shadows.
  99296. */
  99297. getShadowGenerator(): Nullable<IShadowGenerator>;
  99298. /**
  99299. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  99300. * @param effect The effect to update
  99301. * @param lightIndex The index of the light in the effect to update
  99302. * @returns The hemispheric light
  99303. */
  99304. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  99305. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  99306. /**
  99307. * Computes the world matrix of the node
  99308. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  99309. * @param useWasUpdatedFlag defines a reserved property
  99310. * @returns the world matrix
  99311. */
  99312. computeWorldMatrix(): Matrix;
  99313. /**
  99314. * Returns the integer 3.
  99315. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  99316. */
  99317. getTypeID(): number;
  99318. /**
  99319. * Prepares the list of defines specific to the light type.
  99320. * @param defines the list of defines
  99321. * @param lightIndex defines the index of the light for the effect
  99322. */
  99323. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  99324. }
  99325. }
  99326. declare module BABYLON {
  99327. /** @hidden */
  99328. export var vrMultiviewToSingleviewPixelShader: {
  99329. name: string;
  99330. shader: string;
  99331. };
  99332. }
  99333. declare module BABYLON {
  99334. /**
  99335. * Renders to multiple views with a single draw call
  99336. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  99337. */
  99338. export class MultiviewRenderTarget extends RenderTargetTexture {
  99339. /**
  99340. * Creates a multiview render target
  99341. * @param scene scene used with the render target
  99342. * @param size the size of the render target (used for each view)
  99343. */
  99344. constructor(scene: Scene, size?: number | {
  99345. width: number;
  99346. height: number;
  99347. } | {
  99348. ratio: number;
  99349. });
  99350. /**
  99351. * @hidden
  99352. * @param faceIndex the face index, if its a cube texture
  99353. */
  99354. _bindFrameBuffer(faceIndex?: number): void;
  99355. /**
  99356. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  99357. * @returns the view count
  99358. */
  99359. getViewCount(): number;
  99360. }
  99361. }
  99362. declare module BABYLON {
  99363. interface Engine {
  99364. /**
  99365. * Creates a new multiview render target
  99366. * @param width defines the width of the texture
  99367. * @param height defines the height of the texture
  99368. * @returns the created multiview texture
  99369. */
  99370. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  99371. /**
  99372. * Binds a multiview framebuffer to be drawn to
  99373. * @param multiviewTexture texture to bind
  99374. */
  99375. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  99376. }
  99377. interface Camera {
  99378. /**
  99379. * @hidden
  99380. * 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)
  99381. */
  99382. _useMultiviewToSingleView: boolean;
  99383. /**
  99384. * @hidden
  99385. * 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)
  99386. */
  99387. _multiviewTexture: Nullable<RenderTargetTexture>;
  99388. /**
  99389. * @hidden
  99390. * ensures the multiview texture of the camera exists and has the specified width/height
  99391. * @param width height to set on the multiview texture
  99392. * @param height width to set on the multiview texture
  99393. */
  99394. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  99395. }
  99396. interface Scene {
  99397. /** @hidden */
  99398. _transformMatrixR: Matrix;
  99399. /** @hidden */
  99400. _multiviewSceneUbo: Nullable<UniformBuffer>;
  99401. /** @hidden */
  99402. _createMultiviewUbo(): void;
  99403. /** @hidden */
  99404. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  99405. /** @hidden */
  99406. _renderMultiviewToSingleView(camera: Camera): void;
  99407. }
  99408. }
  99409. declare module BABYLON {
  99410. /**
  99411. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  99412. * This will not be used for webXR as it supports displaying texture arrays directly
  99413. */
  99414. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  99415. /**
  99416. * Gets a string identifying the name of the class
  99417. * @returns "VRMultiviewToSingleviewPostProcess" string
  99418. */
  99419. getClassName(): string;
  99420. /**
  99421. * Initializes a VRMultiviewToSingleview
  99422. * @param name name of the post process
  99423. * @param camera camera to be applied to
  99424. * @param scaleFactor scaling factor to the size of the output texture
  99425. */
  99426. constructor(name: string, camera: Camera, scaleFactor: number);
  99427. }
  99428. }
  99429. declare module BABYLON {
  99430. /**
  99431. * Interface used to define additional presentation attributes
  99432. */
  99433. export interface IVRPresentationAttributes {
  99434. /**
  99435. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  99436. */
  99437. highRefreshRate: boolean;
  99438. /**
  99439. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  99440. */
  99441. foveationLevel: number;
  99442. }
  99443. interface Engine {
  99444. /** @hidden */
  99445. _vrDisplay: any;
  99446. /** @hidden */
  99447. _vrSupported: boolean;
  99448. /** @hidden */
  99449. _oldSize: Size;
  99450. /** @hidden */
  99451. _oldHardwareScaleFactor: number;
  99452. /** @hidden */
  99453. _vrExclusivePointerMode: boolean;
  99454. /** @hidden */
  99455. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  99456. /** @hidden */
  99457. _onVRDisplayPointerRestricted: () => void;
  99458. /** @hidden */
  99459. _onVRDisplayPointerUnrestricted: () => void;
  99460. /** @hidden */
  99461. _onVrDisplayConnect: Nullable<(display: any) => void>;
  99462. /** @hidden */
  99463. _onVrDisplayDisconnect: Nullable<() => void>;
  99464. /** @hidden */
  99465. _onVrDisplayPresentChange: Nullable<() => void>;
  99466. /**
  99467. * Observable signaled when VR display mode changes
  99468. */
  99469. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  99470. /**
  99471. * Observable signaled when VR request present is complete
  99472. */
  99473. onVRRequestPresentComplete: Observable<boolean>;
  99474. /**
  99475. * Observable signaled when VR request present starts
  99476. */
  99477. onVRRequestPresentStart: Observable<Engine>;
  99478. /**
  99479. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  99480. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  99481. */
  99482. isInVRExclusivePointerMode: boolean;
  99483. /**
  99484. * Gets a boolean indicating if a webVR device was detected
  99485. * @returns true if a webVR device was detected
  99486. */
  99487. isVRDevicePresent(): boolean;
  99488. /**
  99489. * Gets the current webVR device
  99490. * @returns the current webVR device (or null)
  99491. */
  99492. getVRDevice(): any;
  99493. /**
  99494. * Initializes a webVR display and starts listening to display change events
  99495. * The onVRDisplayChangedObservable will be notified upon these changes
  99496. * @returns A promise containing a VRDisplay and if vr is supported
  99497. */
  99498. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  99499. /** @hidden */
  99500. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  99501. /**
  99502. * Gets or sets the presentation attributes used to configure VR rendering
  99503. */
  99504. vrPresentationAttributes?: IVRPresentationAttributes;
  99505. /**
  99506. * Call this function to switch to webVR mode
  99507. * Will do nothing if webVR is not supported or if there is no webVR device
  99508. * @param options the webvr options provided to the camera. mainly used for multiview
  99509. * @see https://doc.babylonjs.com/how_to/webvr_camera
  99510. */
  99511. enableVR(options: WebVROptions): void;
  99512. /** @hidden */
  99513. _onVRFullScreenTriggered(): void;
  99514. }
  99515. }
  99516. declare module BABYLON {
  99517. /**
  99518. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  99519. * IMPORTANT!! The data is right-hand data.
  99520. * @export
  99521. * @interface DevicePose
  99522. */
  99523. export interface DevicePose {
  99524. /**
  99525. * The position of the device, values in array are [x,y,z].
  99526. */
  99527. readonly position: Nullable<Float32Array>;
  99528. /**
  99529. * The linearVelocity of the device, values in array are [x,y,z].
  99530. */
  99531. readonly linearVelocity: Nullable<Float32Array>;
  99532. /**
  99533. * The linearAcceleration of the device, values in array are [x,y,z].
  99534. */
  99535. readonly linearAcceleration: Nullable<Float32Array>;
  99536. /**
  99537. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  99538. */
  99539. readonly orientation: Nullable<Float32Array>;
  99540. /**
  99541. * The angularVelocity of the device, values in array are [x,y,z].
  99542. */
  99543. readonly angularVelocity: Nullable<Float32Array>;
  99544. /**
  99545. * The angularAcceleration of the device, values in array are [x,y,z].
  99546. */
  99547. readonly angularAcceleration: Nullable<Float32Array>;
  99548. }
  99549. /**
  99550. * Interface representing a pose controlled object in Babylon.
  99551. * A pose controlled object has both regular pose values as well as pose values
  99552. * from an external device such as a VR head mounted display
  99553. */
  99554. export interface PoseControlled {
  99555. /**
  99556. * The position of the object in babylon space.
  99557. */
  99558. position: Vector3;
  99559. /**
  99560. * The rotation quaternion of the object in babylon space.
  99561. */
  99562. rotationQuaternion: Quaternion;
  99563. /**
  99564. * The position of the device in babylon space.
  99565. */
  99566. devicePosition?: Vector3;
  99567. /**
  99568. * The rotation quaternion of the device in babylon space.
  99569. */
  99570. deviceRotationQuaternion: Quaternion;
  99571. /**
  99572. * The raw pose coming from the device.
  99573. */
  99574. rawPose: Nullable<DevicePose>;
  99575. /**
  99576. * The scale of the device to be used when translating from device space to babylon space.
  99577. */
  99578. deviceScaleFactor: number;
  99579. /**
  99580. * Updates the poseControlled values based on the input device pose.
  99581. * @param poseData the pose data to update the object with
  99582. */
  99583. updateFromDevice(poseData: DevicePose): void;
  99584. }
  99585. /**
  99586. * Set of options to customize the webVRCamera
  99587. */
  99588. export interface WebVROptions {
  99589. /**
  99590. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  99591. */
  99592. trackPosition?: boolean;
  99593. /**
  99594. * Sets the scale of the vrDevice in babylon space. (default: 1)
  99595. */
  99596. positionScale?: number;
  99597. /**
  99598. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  99599. */
  99600. displayName?: string;
  99601. /**
  99602. * Should the native controller meshes be initialized. (default: true)
  99603. */
  99604. controllerMeshes?: boolean;
  99605. /**
  99606. * Creating a default HemiLight only on controllers. (default: true)
  99607. */
  99608. defaultLightingOnControllers?: boolean;
  99609. /**
  99610. * If you don't want to use the default VR button of the helper. (default: false)
  99611. */
  99612. useCustomVRButton?: boolean;
  99613. /**
  99614. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  99615. */
  99616. customVRButton?: HTMLButtonElement;
  99617. /**
  99618. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  99619. */
  99620. rayLength?: number;
  99621. /**
  99622. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  99623. */
  99624. defaultHeight?: number;
  99625. /**
  99626. * If multiview should be used if availible (default: false)
  99627. */
  99628. useMultiview?: boolean;
  99629. }
  99630. /**
  99631. * This represents a WebVR camera.
  99632. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  99633. * @example https://doc.babylonjs.com/how_to/webvr_camera
  99634. */
  99635. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  99636. private webVROptions;
  99637. /**
  99638. * @hidden
  99639. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  99640. */
  99641. _vrDevice: any;
  99642. /**
  99643. * The rawPose of the vrDevice.
  99644. */
  99645. rawPose: Nullable<DevicePose>;
  99646. private _onVREnabled;
  99647. private _specsVersion;
  99648. private _attached;
  99649. private _frameData;
  99650. protected _descendants: Array<Node>;
  99651. private _deviceRoomPosition;
  99652. /** @hidden */
  99653. _deviceRoomRotationQuaternion: Quaternion;
  99654. private _standingMatrix;
  99655. /**
  99656. * Represents device position in babylon space.
  99657. */
  99658. devicePosition: Vector3;
  99659. /**
  99660. * Represents device rotation in babylon space.
  99661. */
  99662. deviceRotationQuaternion: Quaternion;
  99663. /**
  99664. * The scale of the device to be used when translating from device space to babylon space.
  99665. */
  99666. deviceScaleFactor: number;
  99667. private _deviceToWorld;
  99668. private _worldToDevice;
  99669. /**
  99670. * References to the webVR controllers for the vrDevice.
  99671. */
  99672. controllers: Array<WebVRController>;
  99673. /**
  99674. * Emits an event when a controller is attached.
  99675. */
  99676. onControllersAttachedObservable: Observable<WebVRController[]>;
  99677. /**
  99678. * Emits an event when a controller's mesh has been loaded;
  99679. */
  99680. onControllerMeshLoadedObservable: Observable<WebVRController>;
  99681. /**
  99682. * Emits an event when the HMD's pose has been updated.
  99683. */
  99684. onPoseUpdatedFromDeviceObservable: Observable<any>;
  99685. private _poseSet;
  99686. /**
  99687. * If the rig cameras be used as parent instead of this camera.
  99688. */
  99689. rigParenting: boolean;
  99690. private _lightOnControllers;
  99691. private _defaultHeight?;
  99692. /**
  99693. * Instantiates a WebVRFreeCamera.
  99694. * @param name The name of the WebVRFreeCamera
  99695. * @param position The starting anchor position for the camera
  99696. * @param scene The scene the camera belongs to
  99697. * @param webVROptions a set of customizable options for the webVRCamera
  99698. */
  99699. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  99700. /**
  99701. * Gets the device distance from the ground in meters.
  99702. * @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.
  99703. */
  99704. deviceDistanceToRoomGround(): number;
  99705. /**
  99706. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99707. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  99708. */
  99709. useStandingMatrix(callback?: (bool: boolean) => void): void;
  99710. /**
  99711. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99712. * @returns A promise with a boolean set to if the standing matrix is supported.
  99713. */
  99714. useStandingMatrixAsync(): Promise<boolean>;
  99715. /**
  99716. * Disposes the camera
  99717. */
  99718. dispose(): void;
  99719. /**
  99720. * Gets a vrController by name.
  99721. * @param name The name of the controller to retreive
  99722. * @returns the controller matching the name specified or null if not found
  99723. */
  99724. getControllerByName(name: string): Nullable<WebVRController>;
  99725. private _leftController;
  99726. /**
  99727. * The controller corresponding to the users left hand.
  99728. */
  99729. get leftController(): Nullable<WebVRController>;
  99730. private _rightController;
  99731. /**
  99732. * The controller corresponding to the users right hand.
  99733. */
  99734. get rightController(): Nullable<WebVRController>;
  99735. /**
  99736. * Casts a ray forward from the vrCamera's gaze.
  99737. * @param length Length of the ray (default: 100)
  99738. * @returns the ray corresponding to the gaze
  99739. */
  99740. getForwardRay(length?: number): Ray;
  99741. /**
  99742. * @hidden
  99743. * Updates the camera based on device's frame data
  99744. */
  99745. _checkInputs(): void;
  99746. /**
  99747. * Updates the poseControlled values based on the input device pose.
  99748. * @param poseData Pose coming from the device
  99749. */
  99750. updateFromDevice(poseData: DevicePose): void;
  99751. private _htmlElementAttached;
  99752. private _detachIfAttached;
  99753. /**
  99754. * WebVR's attach control will start broadcasting frames to the device.
  99755. * Note that in certain browsers (chrome for example) this function must be called
  99756. * within a user-interaction callback. Example:
  99757. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  99758. *
  99759. * @param element html element to attach the vrDevice to
  99760. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  99761. */
  99762. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99763. /**
  99764. * Detaches the camera from the html element and disables VR
  99765. *
  99766. * @param element html element to detach from
  99767. */
  99768. detachControl(element: HTMLElement): void;
  99769. /**
  99770. * @returns the name of this class
  99771. */
  99772. getClassName(): string;
  99773. /**
  99774. * Calls resetPose on the vrDisplay
  99775. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  99776. */
  99777. resetToCurrentRotation(): void;
  99778. /**
  99779. * @hidden
  99780. * Updates the rig cameras (left and right eye)
  99781. */
  99782. _updateRigCameras(): void;
  99783. private _workingVector;
  99784. private _oneVector;
  99785. private _workingMatrix;
  99786. private updateCacheCalled;
  99787. private _correctPositionIfNotTrackPosition;
  99788. /**
  99789. * @hidden
  99790. * Updates the cached values of the camera
  99791. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  99792. */
  99793. _updateCache(ignoreParentClass?: boolean): void;
  99794. /**
  99795. * @hidden
  99796. * Get current device position in babylon world
  99797. */
  99798. _computeDevicePosition(): void;
  99799. /**
  99800. * Updates the current device position and rotation in the babylon world
  99801. */
  99802. update(): void;
  99803. /**
  99804. * @hidden
  99805. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  99806. * @returns an identity matrix
  99807. */
  99808. _getViewMatrix(): Matrix;
  99809. private _tmpMatrix;
  99810. /**
  99811. * This function is called by the two RIG cameras.
  99812. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  99813. * @hidden
  99814. */
  99815. _getWebVRViewMatrix(): Matrix;
  99816. /** @hidden */
  99817. _getWebVRProjectionMatrix(): Matrix;
  99818. private _onGamepadConnectedObserver;
  99819. private _onGamepadDisconnectedObserver;
  99820. private _updateCacheWhenTrackingDisabledObserver;
  99821. /**
  99822. * Initializes the controllers and their meshes
  99823. */
  99824. initControllers(): void;
  99825. }
  99826. }
  99827. declare module BABYLON {
  99828. /**
  99829. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  99830. *
  99831. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  99832. *
  99833. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  99834. */
  99835. export class MaterialHelper {
  99836. /**
  99837. * Bind the current view position to an effect.
  99838. * @param effect The effect to be bound
  99839. * @param scene The scene the eyes position is used from
  99840. * @param variableName name of the shader variable that will hold the eye position
  99841. */
  99842. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  99843. /**
  99844. * Helps preparing the defines values about the UVs in used in the effect.
  99845. * UVs are shared as much as we can accross channels in the shaders.
  99846. * @param texture The texture we are preparing the UVs for
  99847. * @param defines The defines to update
  99848. * @param key The channel key "diffuse", "specular"... used in the shader
  99849. */
  99850. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  99851. /**
  99852. * Binds a texture matrix value to its corrsponding uniform
  99853. * @param texture The texture to bind the matrix for
  99854. * @param uniformBuffer The uniform buffer receivin the data
  99855. * @param key The channel key "diffuse", "specular"... used in the shader
  99856. */
  99857. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  99858. /**
  99859. * Gets the current status of the fog (should it be enabled?)
  99860. * @param mesh defines the mesh to evaluate for fog support
  99861. * @param scene defines the hosting scene
  99862. * @returns true if fog must be enabled
  99863. */
  99864. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  99865. /**
  99866. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  99867. * @param mesh defines the current mesh
  99868. * @param scene defines the current scene
  99869. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  99870. * @param pointsCloud defines if point cloud rendering has to be turned on
  99871. * @param fogEnabled defines if fog has to be turned on
  99872. * @param alphaTest defines if alpha testing has to be turned on
  99873. * @param defines defines the current list of defines
  99874. */
  99875. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  99876. /**
  99877. * Helper used to prepare the list of defines associated with frame values for shader compilation
  99878. * @param scene defines the current scene
  99879. * @param engine defines the current engine
  99880. * @param defines specifies the list of active defines
  99881. * @param useInstances defines if instances have to be turned on
  99882. * @param useClipPlane defines if clip plane have to be turned on
  99883. * @param useInstances defines if instances have to be turned on
  99884. * @param useThinInstances defines if thin instances have to be turned on
  99885. */
  99886. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  99887. /**
  99888. * Prepares the defines for bones
  99889. * @param mesh The mesh containing the geometry data we will draw
  99890. * @param defines The defines to update
  99891. */
  99892. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  99893. /**
  99894. * Prepares the defines for morph targets
  99895. * @param mesh The mesh containing the geometry data we will draw
  99896. * @param defines The defines to update
  99897. */
  99898. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  99899. /**
  99900. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  99901. * @param mesh The mesh containing the geometry data we will draw
  99902. * @param defines The defines to update
  99903. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  99904. * @param useBones Precise whether bones should be used or not (override mesh info)
  99905. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  99906. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  99907. * @returns false if defines are considered not dirty and have not been checked
  99908. */
  99909. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  99910. /**
  99911. * Prepares the defines related to multiview
  99912. * @param scene The scene we are intending to draw
  99913. * @param defines The defines to update
  99914. */
  99915. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  99916. /**
  99917. * Prepares the defines related to the prepass
  99918. * @param scene The scene we are intending to draw
  99919. * @param defines The defines to update
  99920. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  99921. */
  99922. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  99923. /**
  99924. * Prepares the defines related to the light information passed in parameter
  99925. * @param scene The scene we are intending to draw
  99926. * @param mesh The mesh the effect is compiling for
  99927. * @param light The light the effect is compiling for
  99928. * @param lightIndex The index of the light
  99929. * @param defines The defines to update
  99930. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99931. * @param state Defines the current state regarding what is needed (normals, etc...)
  99932. */
  99933. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  99934. needNormals: boolean;
  99935. needRebuild: boolean;
  99936. shadowEnabled: boolean;
  99937. specularEnabled: boolean;
  99938. lightmapMode: boolean;
  99939. }): void;
  99940. /**
  99941. * Prepares the defines related to the light information passed in parameter
  99942. * @param scene The scene we are intending to draw
  99943. * @param mesh The mesh the effect is compiling for
  99944. * @param defines The defines to update
  99945. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99946. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  99947. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  99948. * @returns true if normals will be required for the rest of the effect
  99949. */
  99950. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  99951. /**
  99952. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  99953. * @param lightIndex defines the light index
  99954. * @param uniformsList The uniform list
  99955. * @param samplersList The sampler list
  99956. * @param projectedLightTexture defines if projected texture must be used
  99957. * @param uniformBuffersList defines an optional list of uniform buffers
  99958. */
  99959. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  99960. /**
  99961. * Prepares the uniforms and samplers list to be used in the effect
  99962. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  99963. * @param samplersList The sampler list
  99964. * @param defines The defines helping in the list generation
  99965. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  99966. */
  99967. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  99968. /**
  99969. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  99970. * @param defines The defines to update while falling back
  99971. * @param fallbacks The authorized effect fallbacks
  99972. * @param maxSimultaneousLights The maximum number of lights allowed
  99973. * @param rank the current rank of the Effect
  99974. * @returns The newly affected rank
  99975. */
  99976. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  99977. private static _TmpMorphInfluencers;
  99978. /**
  99979. * Prepares the list of attributes required for morph targets according to the effect defines.
  99980. * @param attribs The current list of supported attribs
  99981. * @param mesh The mesh to prepare the morph targets attributes for
  99982. * @param influencers The number of influencers
  99983. */
  99984. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  99985. /**
  99986. * Prepares the list of attributes required for morph targets according to the effect defines.
  99987. * @param attribs The current list of supported attribs
  99988. * @param mesh The mesh to prepare the morph targets attributes for
  99989. * @param defines The current Defines of the effect
  99990. */
  99991. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  99992. /**
  99993. * Prepares the list of attributes required for bones according to the effect defines.
  99994. * @param attribs The current list of supported attribs
  99995. * @param mesh The mesh to prepare the bones attributes for
  99996. * @param defines The current Defines of the effect
  99997. * @param fallbacks The current efffect fallback strategy
  99998. */
  99999. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  100000. /**
  100001. * Check and prepare the list of attributes required for instances according to the effect defines.
  100002. * @param attribs The current list of supported attribs
  100003. * @param defines The current MaterialDefines of the effect
  100004. */
  100005. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  100006. /**
  100007. * Add the list of attributes required for instances to the attribs array.
  100008. * @param attribs The current list of supported attribs
  100009. */
  100010. static PushAttributesForInstances(attribs: string[]): void;
  100011. /**
  100012. * Binds the light information to the effect.
  100013. * @param light The light containing the generator
  100014. * @param effect The effect we are binding the data to
  100015. * @param lightIndex The light index in the effect used to render
  100016. */
  100017. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  100018. /**
  100019. * Binds the lights information from the scene to the effect for the given mesh.
  100020. * @param light Light to bind
  100021. * @param lightIndex Light index
  100022. * @param scene The scene where the light belongs to
  100023. * @param effect The effect we are binding the data to
  100024. * @param useSpecular Defines if specular is supported
  100025. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100026. */
  100027. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  100028. /**
  100029. * Binds the lights information from the scene to the effect for the given mesh.
  100030. * @param scene The scene the lights belongs to
  100031. * @param mesh The mesh we are binding the information to render
  100032. * @param effect The effect we are binding the data to
  100033. * @param defines The generated defines for the effect
  100034. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  100035. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100036. */
  100037. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  100038. private static _tempFogColor;
  100039. /**
  100040. * Binds the fog information from the scene to the effect for the given mesh.
  100041. * @param scene The scene the lights belongs to
  100042. * @param mesh The mesh we are binding the information to render
  100043. * @param effect The effect we are binding the data to
  100044. * @param linearSpace Defines if the fog effect is applied in linear space
  100045. */
  100046. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  100047. /**
  100048. * Binds the bones information from the mesh to the effect.
  100049. * @param mesh The mesh we are binding the information to render
  100050. * @param effect The effect we are binding the data to
  100051. */
  100052. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  100053. /**
  100054. * Binds the morph targets information from the mesh to the effect.
  100055. * @param abstractMesh The mesh we are binding the information to render
  100056. * @param effect The effect we are binding the data to
  100057. */
  100058. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  100059. /**
  100060. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  100061. * @param defines The generated defines used in the effect
  100062. * @param effect The effect we are binding the data to
  100063. * @param scene The scene we are willing to render with logarithmic scale for
  100064. */
  100065. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  100066. /**
  100067. * Binds the clip plane information from the scene to the effect.
  100068. * @param scene The scene the clip plane information are extracted from
  100069. * @param effect The effect we are binding the data to
  100070. */
  100071. static BindClipPlane(effect: Effect, scene: Scene): void;
  100072. }
  100073. }
  100074. declare module BABYLON {
  100075. /**
  100076. * Block used to expose an input value
  100077. */
  100078. export class InputBlock extends NodeMaterialBlock {
  100079. private _mode;
  100080. private _associatedVariableName;
  100081. private _storedValue;
  100082. private _valueCallback;
  100083. private _type;
  100084. private _animationType;
  100085. /** Gets or set a value used to limit the range of float values */
  100086. min: number;
  100087. /** Gets or set a value used to limit the range of float values */
  100088. max: number;
  100089. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  100090. isBoolean: boolean;
  100091. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  100092. matrixMode: number;
  100093. /** @hidden */
  100094. _systemValue: Nullable<NodeMaterialSystemValues>;
  100095. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  100096. visibleInInspector: boolean;
  100097. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  100098. isConstant: boolean;
  100099. /** Gets or sets the group to use to display this block in the Inspector */
  100100. groupInInspector: string;
  100101. /** Gets an observable raised when the value is changed */
  100102. onValueChangedObservable: Observable<InputBlock>;
  100103. /**
  100104. * Gets or sets the connection point type (default is float)
  100105. */
  100106. get type(): NodeMaterialBlockConnectionPointTypes;
  100107. /**
  100108. * Creates a new InputBlock
  100109. * @param name defines the block name
  100110. * @param target defines the target of that block (Vertex by default)
  100111. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  100112. */
  100113. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  100114. /**
  100115. * Validates if a name is a reserve word.
  100116. * @param newName the new name to be given to the node.
  100117. * @returns false if the name is a reserve word, else true.
  100118. */
  100119. validateBlockName(newName: string): boolean;
  100120. /**
  100121. * Gets the output component
  100122. */
  100123. get output(): NodeMaterialConnectionPoint;
  100124. /**
  100125. * Set the source of this connection point to a vertex attribute
  100126. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  100127. * @returns the current connection point
  100128. */
  100129. setAsAttribute(attributeName?: string): InputBlock;
  100130. /**
  100131. * Set the source of this connection point to a system value
  100132. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  100133. * @returns the current connection point
  100134. */
  100135. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  100136. /**
  100137. * Gets or sets the value of that point.
  100138. * Please note that this value will be ignored if valueCallback is defined
  100139. */
  100140. get value(): any;
  100141. set value(value: any);
  100142. /**
  100143. * Gets or sets a callback used to get the value of that point.
  100144. * Please note that setting this value will force the connection point to ignore the value property
  100145. */
  100146. get valueCallback(): () => any;
  100147. set valueCallback(value: () => any);
  100148. /**
  100149. * Gets or sets the associated variable name in the shader
  100150. */
  100151. get associatedVariableName(): string;
  100152. set associatedVariableName(value: string);
  100153. /** Gets or sets the type of animation applied to the input */
  100154. get animationType(): AnimatedInputBlockTypes;
  100155. set animationType(value: AnimatedInputBlockTypes);
  100156. /**
  100157. * Gets a boolean indicating that this connection point not defined yet
  100158. */
  100159. get isUndefined(): boolean;
  100160. /**
  100161. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  100162. * In this case the connection point name must be the name of the uniform to use.
  100163. * Can only be set on inputs
  100164. */
  100165. get isUniform(): boolean;
  100166. set isUniform(value: boolean);
  100167. /**
  100168. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  100169. * In this case the connection point name must be the name of the attribute to use
  100170. * Can only be set on inputs
  100171. */
  100172. get isAttribute(): boolean;
  100173. set isAttribute(value: boolean);
  100174. /**
  100175. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  100176. * Can only be set on exit points
  100177. */
  100178. get isVarying(): boolean;
  100179. set isVarying(value: boolean);
  100180. /**
  100181. * Gets a boolean indicating that the current connection point is a system value
  100182. */
  100183. get isSystemValue(): boolean;
  100184. /**
  100185. * Gets or sets the current well known value or null if not defined as a system value
  100186. */
  100187. get systemValue(): Nullable<NodeMaterialSystemValues>;
  100188. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  100189. /**
  100190. * Gets the current class name
  100191. * @returns the class name
  100192. */
  100193. getClassName(): string;
  100194. /**
  100195. * Animate the input if animationType !== None
  100196. * @param scene defines the rendering scene
  100197. */
  100198. animate(scene: Scene): void;
  100199. private _emitDefine;
  100200. initialize(state: NodeMaterialBuildState): void;
  100201. /**
  100202. * Set the input block to its default value (based on its type)
  100203. */
  100204. setDefaultValue(): void;
  100205. private _emitConstant;
  100206. /** @hidden */
  100207. get _noContextSwitch(): boolean;
  100208. private _emit;
  100209. /** @hidden */
  100210. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  100211. /** @hidden */
  100212. _transmit(effect: Effect, scene: Scene): void;
  100213. protected _buildBlock(state: NodeMaterialBuildState): void;
  100214. protected _dumpPropertiesCode(): string;
  100215. dispose(): void;
  100216. serialize(): any;
  100217. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100218. }
  100219. }
  100220. declare module BABYLON {
  100221. /**
  100222. * Enum used to define the compatibility state between two connection points
  100223. */
  100224. export enum NodeMaterialConnectionPointCompatibilityStates {
  100225. /** Points are compatibles */
  100226. Compatible = 0,
  100227. /** Points are incompatible because of their types */
  100228. TypeIncompatible = 1,
  100229. /** Points are incompatible because of their targets (vertex vs fragment) */
  100230. TargetIncompatible = 2
  100231. }
  100232. /**
  100233. * Defines the direction of a connection point
  100234. */
  100235. export enum NodeMaterialConnectionPointDirection {
  100236. /** Input */
  100237. Input = 0,
  100238. /** Output */
  100239. Output = 1
  100240. }
  100241. /**
  100242. * Defines a connection point for a block
  100243. */
  100244. export class NodeMaterialConnectionPoint {
  100245. /** @hidden */
  100246. _ownerBlock: NodeMaterialBlock;
  100247. /** @hidden */
  100248. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  100249. private _endpoints;
  100250. private _associatedVariableName;
  100251. private _direction;
  100252. /** @hidden */
  100253. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100254. /** @hidden */
  100255. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100256. private _type;
  100257. /** @hidden */
  100258. _enforceAssociatedVariableName: boolean;
  100259. /** Gets the direction of the point */
  100260. get direction(): NodeMaterialConnectionPointDirection;
  100261. /** Indicates that this connection point needs dual validation before being connected to another point */
  100262. needDualDirectionValidation: boolean;
  100263. /**
  100264. * Gets or sets the additional types supported by this connection point
  100265. */
  100266. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100267. /**
  100268. * Gets or sets the additional types excluded by this connection point
  100269. */
  100270. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100271. /**
  100272. * Observable triggered when this point is connected
  100273. */
  100274. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  100275. /**
  100276. * Gets or sets the associated variable name in the shader
  100277. */
  100278. get associatedVariableName(): string;
  100279. set associatedVariableName(value: string);
  100280. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  100281. get innerType(): NodeMaterialBlockConnectionPointTypes;
  100282. /**
  100283. * Gets or sets the connection point type (default is float)
  100284. */
  100285. get type(): NodeMaterialBlockConnectionPointTypes;
  100286. set type(value: NodeMaterialBlockConnectionPointTypes);
  100287. /**
  100288. * Gets or sets the connection point name
  100289. */
  100290. name: string;
  100291. /**
  100292. * Gets or sets the connection point name
  100293. */
  100294. displayName: string;
  100295. /**
  100296. * Gets or sets a boolean indicating that this connection point can be omitted
  100297. */
  100298. isOptional: boolean;
  100299. /**
  100300. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  100301. */
  100302. isExposedOnFrame: boolean;
  100303. /**
  100304. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  100305. */
  100306. define: string;
  100307. /** @hidden */
  100308. _prioritizeVertex: boolean;
  100309. private _target;
  100310. /** Gets or sets the target of that connection point */
  100311. get target(): NodeMaterialBlockTargets;
  100312. set target(value: NodeMaterialBlockTargets);
  100313. /**
  100314. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  100315. */
  100316. get isConnected(): boolean;
  100317. /**
  100318. * Gets a boolean indicating that the current point is connected to an input block
  100319. */
  100320. get isConnectedToInputBlock(): boolean;
  100321. /**
  100322. * Gets a the connected input block (if any)
  100323. */
  100324. get connectInputBlock(): Nullable<InputBlock>;
  100325. /** Get the other side of the connection (if any) */
  100326. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  100327. /** Get the block that owns this connection point */
  100328. get ownerBlock(): NodeMaterialBlock;
  100329. /** Get the block connected on the other side of this connection (if any) */
  100330. get sourceBlock(): Nullable<NodeMaterialBlock>;
  100331. /** Get the block connected on the endpoints of this connection (if any) */
  100332. get connectedBlocks(): Array<NodeMaterialBlock>;
  100333. /** Gets the list of connected endpoints */
  100334. get endpoints(): NodeMaterialConnectionPoint[];
  100335. /** Gets a boolean indicating if that output point is connected to at least one input */
  100336. get hasEndpoints(): boolean;
  100337. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  100338. get isConnectedInVertexShader(): boolean;
  100339. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  100340. get isConnectedInFragmentShader(): boolean;
  100341. /**
  100342. * Creates a block suitable to be used as an input for this input point.
  100343. * If null is returned, a block based on the point type will be created.
  100344. * @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
  100345. */
  100346. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100347. /**
  100348. * Creates a new connection point
  100349. * @param name defines the connection point name
  100350. * @param ownerBlock defines the block hosting this connection point
  100351. * @param direction defines the direction of the connection point
  100352. */
  100353. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  100354. /**
  100355. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  100356. * @returns the class name
  100357. */
  100358. getClassName(): string;
  100359. /**
  100360. * Gets a boolean indicating if the current point can be connected to another point
  100361. * @param connectionPoint defines the other connection point
  100362. * @returns a boolean
  100363. */
  100364. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  100365. /**
  100366. * Gets a number indicating if the current point can be connected to another point
  100367. * @param connectionPoint defines the other connection point
  100368. * @returns a number defining the compatibility state
  100369. */
  100370. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100371. /**
  100372. * Connect this point to another connection point
  100373. * @param connectionPoint defines the other connection point
  100374. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  100375. * @returns the current connection point
  100376. */
  100377. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  100378. /**
  100379. * Disconnect this point from one of his endpoint
  100380. * @param endpoint defines the other connection point
  100381. * @returns the current connection point
  100382. */
  100383. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  100384. /**
  100385. * Serializes this point in a JSON representation
  100386. * @param isInput defines if the connection point is an input (default is true)
  100387. * @returns the serialized point object
  100388. */
  100389. serialize(isInput?: boolean): any;
  100390. /**
  100391. * Release resources
  100392. */
  100393. dispose(): void;
  100394. }
  100395. }
  100396. declare module BABYLON {
  100397. /**
  100398. * Enum used to define the material modes
  100399. */
  100400. export enum NodeMaterialModes {
  100401. /** Regular material */
  100402. Material = 0,
  100403. /** For post process */
  100404. PostProcess = 1,
  100405. /** For particle system */
  100406. Particle = 2
  100407. }
  100408. }
  100409. declare module BABYLON {
  100410. /**
  100411. * Block used to read a texture from a sampler
  100412. */
  100413. export class TextureBlock extends NodeMaterialBlock {
  100414. private _defineName;
  100415. private _linearDefineName;
  100416. private _gammaDefineName;
  100417. private _tempTextureRead;
  100418. private _samplerName;
  100419. private _transformedUVName;
  100420. private _textureTransformName;
  100421. private _textureInfoName;
  100422. private _mainUVName;
  100423. private _mainUVDefineName;
  100424. private _fragmentOnly;
  100425. /**
  100426. * Gets or sets the texture associated with the node
  100427. */
  100428. texture: Nullable<Texture>;
  100429. /**
  100430. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100431. */
  100432. convertToGammaSpace: boolean;
  100433. /**
  100434. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100435. */
  100436. convertToLinearSpace: boolean;
  100437. /**
  100438. * Create a new TextureBlock
  100439. * @param name defines the block name
  100440. */
  100441. constructor(name: string, fragmentOnly?: boolean);
  100442. /**
  100443. * Gets the current class name
  100444. * @returns the class name
  100445. */
  100446. getClassName(): string;
  100447. /**
  100448. * Gets the uv input component
  100449. */
  100450. get uv(): NodeMaterialConnectionPoint;
  100451. /**
  100452. * Gets the rgba output component
  100453. */
  100454. get rgba(): NodeMaterialConnectionPoint;
  100455. /**
  100456. * Gets the rgb output component
  100457. */
  100458. get rgb(): NodeMaterialConnectionPoint;
  100459. /**
  100460. * Gets the r output component
  100461. */
  100462. get r(): NodeMaterialConnectionPoint;
  100463. /**
  100464. * Gets the g output component
  100465. */
  100466. get g(): NodeMaterialConnectionPoint;
  100467. /**
  100468. * Gets the b output component
  100469. */
  100470. get b(): NodeMaterialConnectionPoint;
  100471. /**
  100472. * Gets the a output component
  100473. */
  100474. get a(): NodeMaterialConnectionPoint;
  100475. get target(): NodeMaterialBlockTargets;
  100476. autoConfigure(material: NodeMaterial): void;
  100477. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  100478. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100479. isReady(): boolean;
  100480. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100481. private get _isMixed();
  100482. private _injectVertexCode;
  100483. private _writeTextureRead;
  100484. private _writeOutput;
  100485. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100486. protected _dumpPropertiesCode(): string;
  100487. serialize(): any;
  100488. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100489. }
  100490. }
  100491. declare module BABYLON {
  100492. /** @hidden */
  100493. export var reflectionFunction: {
  100494. name: string;
  100495. shader: string;
  100496. };
  100497. }
  100498. declare module BABYLON {
  100499. /**
  100500. * Base block used to read a reflection texture from a sampler
  100501. */
  100502. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  100503. /** @hidden */
  100504. _define3DName: string;
  100505. /** @hidden */
  100506. _defineCubicName: string;
  100507. /** @hidden */
  100508. _defineExplicitName: string;
  100509. /** @hidden */
  100510. _defineProjectionName: string;
  100511. /** @hidden */
  100512. _defineLocalCubicName: string;
  100513. /** @hidden */
  100514. _defineSphericalName: string;
  100515. /** @hidden */
  100516. _definePlanarName: string;
  100517. /** @hidden */
  100518. _defineEquirectangularName: string;
  100519. /** @hidden */
  100520. _defineMirroredEquirectangularFixedName: string;
  100521. /** @hidden */
  100522. _defineEquirectangularFixedName: string;
  100523. /** @hidden */
  100524. _defineSkyboxName: string;
  100525. /** @hidden */
  100526. _defineOppositeZ: string;
  100527. /** @hidden */
  100528. _cubeSamplerName: string;
  100529. /** @hidden */
  100530. _2DSamplerName: string;
  100531. protected _positionUVWName: string;
  100532. protected _directionWName: string;
  100533. protected _reflectionVectorName: string;
  100534. /** @hidden */
  100535. _reflectionCoordsName: string;
  100536. /** @hidden */
  100537. _reflectionMatrixName: string;
  100538. protected _reflectionColorName: string;
  100539. /**
  100540. * Gets or sets the texture associated with the node
  100541. */
  100542. texture: Nullable<BaseTexture>;
  100543. /**
  100544. * Create a new ReflectionTextureBaseBlock
  100545. * @param name defines the block name
  100546. */
  100547. constructor(name: string);
  100548. /**
  100549. * Gets the current class name
  100550. * @returns the class name
  100551. */
  100552. getClassName(): string;
  100553. /**
  100554. * Gets the world position input component
  100555. */
  100556. abstract get position(): NodeMaterialConnectionPoint;
  100557. /**
  100558. * Gets the world position input component
  100559. */
  100560. abstract get worldPosition(): NodeMaterialConnectionPoint;
  100561. /**
  100562. * Gets the world normal input component
  100563. */
  100564. abstract get worldNormal(): NodeMaterialConnectionPoint;
  100565. /**
  100566. * Gets the world input component
  100567. */
  100568. abstract get world(): NodeMaterialConnectionPoint;
  100569. /**
  100570. * Gets the camera (or eye) position component
  100571. */
  100572. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  100573. /**
  100574. * Gets the view input component
  100575. */
  100576. abstract get view(): NodeMaterialConnectionPoint;
  100577. protected _getTexture(): Nullable<BaseTexture>;
  100578. autoConfigure(material: NodeMaterial): void;
  100579. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100580. isReady(): boolean;
  100581. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100582. /**
  100583. * Gets the code to inject in the vertex shader
  100584. * @param state current state of the node material building
  100585. * @returns the shader code
  100586. */
  100587. handleVertexSide(state: NodeMaterialBuildState): string;
  100588. /**
  100589. * Handles the inits for the fragment code path
  100590. * @param state node material build state
  100591. */
  100592. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  100593. /**
  100594. * Generates the reflection coords code for the fragment code path
  100595. * @param worldNormalVarName name of the world normal variable
  100596. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  100597. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  100598. * @returns the shader code
  100599. */
  100600. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  100601. /**
  100602. * Generates the reflection color code for the fragment code path
  100603. * @param lodVarName name of the lod variable
  100604. * @param swizzleLookupTexture swizzle to use for the final color variable
  100605. * @returns the shader code
  100606. */
  100607. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  100608. /**
  100609. * Generates the code corresponding to the connected output points
  100610. * @param state node material build state
  100611. * @param varName name of the variable to output
  100612. * @returns the shader code
  100613. */
  100614. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  100615. protected _buildBlock(state: NodeMaterialBuildState): this;
  100616. protected _dumpPropertiesCode(): string;
  100617. serialize(): any;
  100618. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100619. }
  100620. }
  100621. declare module BABYLON {
  100622. /**
  100623. * Defines a connection point to be used for points with a custom object type
  100624. */
  100625. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  100626. private _blockType;
  100627. private _blockName;
  100628. private _nameForCheking?;
  100629. /**
  100630. * Creates a new connection point
  100631. * @param name defines the connection point name
  100632. * @param ownerBlock defines the block hosting this connection point
  100633. * @param direction defines the direction of the connection point
  100634. */
  100635. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  100636. /**
  100637. * Gets a number indicating if the current point can be connected to another point
  100638. * @param connectionPoint defines the other connection point
  100639. * @returns a number defining the compatibility state
  100640. */
  100641. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100642. /**
  100643. * Creates a block suitable to be used as an input for this input point.
  100644. * If null is returned, a block based on the point type will be created.
  100645. * @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
  100646. */
  100647. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100648. }
  100649. }
  100650. declare module BABYLON {
  100651. /**
  100652. * Enum defining the type of properties that can be edited in the property pages in the NME
  100653. */
  100654. export enum PropertyTypeForEdition {
  100655. /** property is a boolean */
  100656. Boolean = 0,
  100657. /** property is a float */
  100658. Float = 1,
  100659. /** property is a Vector2 */
  100660. Vector2 = 2,
  100661. /** property is a list of values */
  100662. List = 3
  100663. }
  100664. /**
  100665. * Interface that defines an option in a variable of type list
  100666. */
  100667. export interface IEditablePropertyListOption {
  100668. /** label of the option */
  100669. "label": string;
  100670. /** value of the option */
  100671. "value": number;
  100672. }
  100673. /**
  100674. * Interface that defines the options available for an editable property
  100675. */
  100676. export interface IEditablePropertyOption {
  100677. /** min value */
  100678. "min"?: number;
  100679. /** max value */
  100680. "max"?: number;
  100681. /** notifiers: indicates which actions to take when the property is changed */
  100682. "notifiers"?: {
  100683. /** the material should be rebuilt */
  100684. "rebuild"?: boolean;
  100685. /** the preview should be updated */
  100686. "update"?: boolean;
  100687. };
  100688. /** list of the options for a variable of type list */
  100689. "options"?: IEditablePropertyListOption[];
  100690. }
  100691. /**
  100692. * Interface that describes an editable property
  100693. */
  100694. export interface IPropertyDescriptionForEdition {
  100695. /** name of the property */
  100696. "propertyName": string;
  100697. /** display name of the property */
  100698. "displayName": string;
  100699. /** type of the property */
  100700. "type": PropertyTypeForEdition;
  100701. /** group of the property - all properties with the same group value will be displayed in a specific section */
  100702. "groupName": string;
  100703. /** options for the property */
  100704. "options": IEditablePropertyOption;
  100705. }
  100706. /**
  100707. * Decorator that flags a property in a node material block as being editable
  100708. */
  100709. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  100710. }
  100711. declare module BABYLON {
  100712. /**
  100713. * Block used to implement the refraction part of the sub surface module of the PBR material
  100714. */
  100715. export class RefractionBlock extends NodeMaterialBlock {
  100716. /** @hidden */
  100717. _define3DName: string;
  100718. /** @hidden */
  100719. _refractionMatrixName: string;
  100720. /** @hidden */
  100721. _defineLODRefractionAlpha: string;
  100722. /** @hidden */
  100723. _defineLinearSpecularRefraction: string;
  100724. /** @hidden */
  100725. _defineOppositeZ: string;
  100726. /** @hidden */
  100727. _cubeSamplerName: string;
  100728. /** @hidden */
  100729. _2DSamplerName: string;
  100730. /** @hidden */
  100731. _vRefractionMicrosurfaceInfosName: string;
  100732. /** @hidden */
  100733. _vRefractionInfosName: string;
  100734. private _scene;
  100735. /**
  100736. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  100737. * Materials half opaque for instance using refraction could benefit from this control.
  100738. */
  100739. linkRefractionWithTransparency: boolean;
  100740. /**
  100741. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  100742. */
  100743. invertRefractionY: boolean;
  100744. /**
  100745. * Gets or sets the texture associated with the node
  100746. */
  100747. texture: Nullable<BaseTexture>;
  100748. /**
  100749. * Create a new RefractionBlock
  100750. * @param name defines the block name
  100751. */
  100752. constructor(name: string);
  100753. /**
  100754. * Gets the current class name
  100755. * @returns the class name
  100756. */
  100757. getClassName(): string;
  100758. /**
  100759. * Gets the intensity input component
  100760. */
  100761. get intensity(): NodeMaterialConnectionPoint;
  100762. /**
  100763. * Gets the index of refraction input component
  100764. */
  100765. get indexOfRefraction(): NodeMaterialConnectionPoint;
  100766. /**
  100767. * Gets the tint at distance input component
  100768. */
  100769. get tintAtDistance(): NodeMaterialConnectionPoint;
  100770. /**
  100771. * Gets the view input component
  100772. */
  100773. get view(): NodeMaterialConnectionPoint;
  100774. /**
  100775. * Gets the refraction object output component
  100776. */
  100777. get refraction(): NodeMaterialConnectionPoint;
  100778. /**
  100779. * Returns true if the block has a texture
  100780. */
  100781. get hasTexture(): boolean;
  100782. protected _getTexture(): Nullable<BaseTexture>;
  100783. autoConfigure(material: NodeMaterial): void;
  100784. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100785. isReady(): boolean;
  100786. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  100787. /**
  100788. * Gets the main code of the block (fragment side)
  100789. * @param state current state of the node material building
  100790. * @returns the shader code
  100791. */
  100792. getCode(state: NodeMaterialBuildState): string;
  100793. protected _buildBlock(state: NodeMaterialBuildState): this;
  100794. protected _dumpPropertiesCode(): string;
  100795. serialize(): any;
  100796. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100797. }
  100798. }
  100799. declare module BABYLON {
  100800. /**
  100801. * Base block used as input for post process
  100802. */
  100803. export class CurrentScreenBlock extends NodeMaterialBlock {
  100804. private _samplerName;
  100805. private _linearDefineName;
  100806. private _gammaDefineName;
  100807. private _mainUVName;
  100808. private _tempTextureRead;
  100809. /**
  100810. * Gets or sets the texture associated with the node
  100811. */
  100812. texture: Nullable<BaseTexture>;
  100813. /**
  100814. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100815. */
  100816. convertToGammaSpace: boolean;
  100817. /**
  100818. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100819. */
  100820. convertToLinearSpace: boolean;
  100821. /**
  100822. * Create a new CurrentScreenBlock
  100823. * @param name defines the block name
  100824. */
  100825. constructor(name: string);
  100826. /**
  100827. * Gets the current class name
  100828. * @returns the class name
  100829. */
  100830. getClassName(): string;
  100831. /**
  100832. * Gets the uv input component
  100833. */
  100834. get uv(): NodeMaterialConnectionPoint;
  100835. /**
  100836. * Gets the rgba output component
  100837. */
  100838. get rgba(): NodeMaterialConnectionPoint;
  100839. /**
  100840. * Gets the rgb output component
  100841. */
  100842. get rgb(): NodeMaterialConnectionPoint;
  100843. /**
  100844. * Gets the r output component
  100845. */
  100846. get r(): NodeMaterialConnectionPoint;
  100847. /**
  100848. * Gets the g output component
  100849. */
  100850. get g(): NodeMaterialConnectionPoint;
  100851. /**
  100852. * Gets the b output component
  100853. */
  100854. get b(): NodeMaterialConnectionPoint;
  100855. /**
  100856. * Gets the a output component
  100857. */
  100858. get a(): NodeMaterialConnectionPoint;
  100859. /**
  100860. * Initialize the block and prepare the context for build
  100861. * @param state defines the state that will be used for the build
  100862. */
  100863. initialize(state: NodeMaterialBuildState): void;
  100864. get target(): NodeMaterialBlockTargets;
  100865. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100866. isReady(): boolean;
  100867. private _injectVertexCode;
  100868. private _writeTextureRead;
  100869. private _writeOutput;
  100870. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100871. serialize(): any;
  100872. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100873. }
  100874. }
  100875. declare module BABYLON {
  100876. /**
  100877. * Base block used for the particle texture
  100878. */
  100879. export class ParticleTextureBlock extends NodeMaterialBlock {
  100880. private _samplerName;
  100881. private _linearDefineName;
  100882. private _gammaDefineName;
  100883. private _tempTextureRead;
  100884. /**
  100885. * Gets or sets the texture associated with the node
  100886. */
  100887. texture: Nullable<BaseTexture>;
  100888. /**
  100889. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100890. */
  100891. convertToGammaSpace: boolean;
  100892. /**
  100893. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100894. */
  100895. convertToLinearSpace: boolean;
  100896. /**
  100897. * Create a new ParticleTextureBlock
  100898. * @param name defines the block name
  100899. */
  100900. constructor(name: string);
  100901. /**
  100902. * Gets the current class name
  100903. * @returns the class name
  100904. */
  100905. getClassName(): string;
  100906. /**
  100907. * Gets the uv input component
  100908. */
  100909. get uv(): NodeMaterialConnectionPoint;
  100910. /**
  100911. * Gets the rgba output component
  100912. */
  100913. get rgba(): NodeMaterialConnectionPoint;
  100914. /**
  100915. * Gets the rgb output component
  100916. */
  100917. get rgb(): NodeMaterialConnectionPoint;
  100918. /**
  100919. * Gets the r output component
  100920. */
  100921. get r(): NodeMaterialConnectionPoint;
  100922. /**
  100923. * Gets the g output component
  100924. */
  100925. get g(): NodeMaterialConnectionPoint;
  100926. /**
  100927. * Gets the b output component
  100928. */
  100929. get b(): NodeMaterialConnectionPoint;
  100930. /**
  100931. * Gets the a output component
  100932. */
  100933. get a(): NodeMaterialConnectionPoint;
  100934. /**
  100935. * Initialize the block and prepare the context for build
  100936. * @param state defines the state that will be used for the build
  100937. */
  100938. initialize(state: NodeMaterialBuildState): void;
  100939. autoConfigure(material: NodeMaterial): void;
  100940. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100941. isReady(): boolean;
  100942. private _writeOutput;
  100943. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100944. serialize(): any;
  100945. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100946. }
  100947. }
  100948. declare module BABYLON {
  100949. /**
  100950. * Class used to store shared data between 2 NodeMaterialBuildState
  100951. */
  100952. export class NodeMaterialBuildStateSharedData {
  100953. /**
  100954. * Gets the list of emitted varyings
  100955. */
  100956. temps: string[];
  100957. /**
  100958. * Gets the list of emitted varyings
  100959. */
  100960. varyings: string[];
  100961. /**
  100962. * Gets the varying declaration string
  100963. */
  100964. varyingDeclaration: string;
  100965. /**
  100966. * Input blocks
  100967. */
  100968. inputBlocks: InputBlock[];
  100969. /**
  100970. * Input blocks
  100971. */
  100972. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  100973. /**
  100974. * Bindable blocks (Blocks that need to set data to the effect)
  100975. */
  100976. bindableBlocks: NodeMaterialBlock[];
  100977. /**
  100978. * List of blocks that can provide a compilation fallback
  100979. */
  100980. blocksWithFallbacks: NodeMaterialBlock[];
  100981. /**
  100982. * List of blocks that can provide a define update
  100983. */
  100984. blocksWithDefines: NodeMaterialBlock[];
  100985. /**
  100986. * List of blocks that can provide a repeatable content
  100987. */
  100988. repeatableContentBlocks: NodeMaterialBlock[];
  100989. /**
  100990. * List of blocks that can provide a dynamic list of uniforms
  100991. */
  100992. dynamicUniformBlocks: NodeMaterialBlock[];
  100993. /**
  100994. * List of blocks that can block the isReady function for the material
  100995. */
  100996. blockingBlocks: NodeMaterialBlock[];
  100997. /**
  100998. * Gets the list of animated inputs
  100999. */
  101000. animatedInputs: InputBlock[];
  101001. /**
  101002. * Build Id used to avoid multiple recompilations
  101003. */
  101004. buildId: number;
  101005. /** List of emitted variables */
  101006. variableNames: {
  101007. [key: string]: number;
  101008. };
  101009. /** List of emitted defines */
  101010. defineNames: {
  101011. [key: string]: number;
  101012. };
  101013. /** Should emit comments? */
  101014. emitComments: boolean;
  101015. /** Emit build activity */
  101016. verbose: boolean;
  101017. /** Gets or sets the hosting scene */
  101018. scene: Scene;
  101019. /**
  101020. * Gets the compilation hints emitted at compilation time
  101021. */
  101022. hints: {
  101023. needWorldViewMatrix: boolean;
  101024. needWorldViewProjectionMatrix: boolean;
  101025. needAlphaBlending: boolean;
  101026. needAlphaTesting: boolean;
  101027. };
  101028. /**
  101029. * List of compilation checks
  101030. */
  101031. checks: {
  101032. emitVertex: boolean;
  101033. emitFragment: boolean;
  101034. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  101035. };
  101036. /**
  101037. * Is vertex program allowed to be empty?
  101038. */
  101039. allowEmptyVertexProgram: boolean;
  101040. /** Creates a new shared data */
  101041. constructor();
  101042. /**
  101043. * Emits console errors and exceptions if there is a failing check
  101044. */
  101045. emitErrors(): void;
  101046. }
  101047. }
  101048. declare module BABYLON {
  101049. /**
  101050. * Class used to store node based material build state
  101051. */
  101052. export class NodeMaterialBuildState {
  101053. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  101054. supportUniformBuffers: boolean;
  101055. /**
  101056. * Gets the list of emitted attributes
  101057. */
  101058. attributes: string[];
  101059. /**
  101060. * Gets the list of emitted uniforms
  101061. */
  101062. uniforms: string[];
  101063. /**
  101064. * Gets the list of emitted constants
  101065. */
  101066. constants: string[];
  101067. /**
  101068. * Gets the list of emitted samplers
  101069. */
  101070. samplers: string[];
  101071. /**
  101072. * Gets the list of emitted functions
  101073. */
  101074. functions: {
  101075. [key: string]: string;
  101076. };
  101077. /**
  101078. * Gets the list of emitted extensions
  101079. */
  101080. extensions: {
  101081. [key: string]: string;
  101082. };
  101083. /**
  101084. * Gets the target of the compilation state
  101085. */
  101086. target: NodeMaterialBlockTargets;
  101087. /**
  101088. * Gets the list of emitted counters
  101089. */
  101090. counters: {
  101091. [key: string]: number;
  101092. };
  101093. /**
  101094. * Shared data between multiple NodeMaterialBuildState instances
  101095. */
  101096. sharedData: NodeMaterialBuildStateSharedData;
  101097. /** @hidden */
  101098. _vertexState: NodeMaterialBuildState;
  101099. /** @hidden */
  101100. _attributeDeclaration: string;
  101101. /** @hidden */
  101102. _uniformDeclaration: string;
  101103. /** @hidden */
  101104. _constantDeclaration: string;
  101105. /** @hidden */
  101106. _samplerDeclaration: string;
  101107. /** @hidden */
  101108. _varyingTransfer: string;
  101109. /** @hidden */
  101110. _injectAtEnd: string;
  101111. private _repeatableContentAnchorIndex;
  101112. /** @hidden */
  101113. _builtCompilationString: string;
  101114. /**
  101115. * Gets the emitted compilation strings
  101116. */
  101117. compilationString: string;
  101118. /**
  101119. * Finalize the compilation strings
  101120. * @param state defines the current compilation state
  101121. */
  101122. finalize(state: NodeMaterialBuildState): void;
  101123. /** @hidden */
  101124. get _repeatableContentAnchor(): string;
  101125. /** @hidden */
  101126. _getFreeVariableName(prefix: string): string;
  101127. /** @hidden */
  101128. _getFreeDefineName(prefix: string): string;
  101129. /** @hidden */
  101130. _excludeVariableName(name: string): void;
  101131. /** @hidden */
  101132. _emit2DSampler(name: string): void;
  101133. /** @hidden */
  101134. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  101135. /** @hidden */
  101136. _emitExtension(name: string, extension: string, define?: string): void;
  101137. /** @hidden */
  101138. _emitFunction(name: string, code: string, comments: string): void;
  101139. /** @hidden */
  101140. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  101141. replaceStrings?: {
  101142. search: RegExp;
  101143. replace: string;
  101144. }[];
  101145. repeatKey?: string;
  101146. }): string;
  101147. /** @hidden */
  101148. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  101149. repeatKey?: string;
  101150. removeAttributes?: boolean;
  101151. removeUniforms?: boolean;
  101152. removeVaryings?: boolean;
  101153. removeIfDef?: boolean;
  101154. replaceStrings?: {
  101155. search: RegExp;
  101156. replace: string;
  101157. }[];
  101158. }, storeKey?: string): void;
  101159. /** @hidden */
  101160. _registerTempVariable(name: string): boolean;
  101161. /** @hidden */
  101162. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  101163. /** @hidden */
  101164. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  101165. /** @hidden */
  101166. _emitFloat(value: number): string;
  101167. }
  101168. }
  101169. declare module BABYLON {
  101170. /**
  101171. * Helper class used to generate session unique ID
  101172. */
  101173. export class UniqueIdGenerator {
  101174. private static _UniqueIdCounter;
  101175. /**
  101176. * Gets an unique (relatively to the current scene) Id
  101177. */
  101178. static get UniqueId(): number;
  101179. }
  101180. }
  101181. declare module BABYLON {
  101182. /**
  101183. * Defines a block that can be used inside a node based material
  101184. */
  101185. export class NodeMaterialBlock {
  101186. private _buildId;
  101187. private _buildTarget;
  101188. private _target;
  101189. private _isFinalMerger;
  101190. private _isInput;
  101191. private _name;
  101192. protected _isUnique: boolean;
  101193. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  101194. inputsAreExclusive: boolean;
  101195. /** @hidden */
  101196. _codeVariableName: string;
  101197. /** @hidden */
  101198. _inputs: NodeMaterialConnectionPoint[];
  101199. /** @hidden */
  101200. _outputs: NodeMaterialConnectionPoint[];
  101201. /** @hidden */
  101202. _preparationId: number;
  101203. /**
  101204. * Gets the name of the block
  101205. */
  101206. get name(): string;
  101207. /**
  101208. * Sets the name of the block. Will check if the name is valid.
  101209. */
  101210. set name(newName: string);
  101211. /**
  101212. * Gets or sets the unique id of the node
  101213. */
  101214. uniqueId: number;
  101215. /**
  101216. * Gets or sets the comments associated with this block
  101217. */
  101218. comments: string;
  101219. /**
  101220. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  101221. */
  101222. get isUnique(): boolean;
  101223. /**
  101224. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  101225. */
  101226. get isFinalMerger(): boolean;
  101227. /**
  101228. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  101229. */
  101230. get isInput(): boolean;
  101231. /**
  101232. * Gets or sets the build Id
  101233. */
  101234. get buildId(): number;
  101235. set buildId(value: number);
  101236. /**
  101237. * Gets or sets the target of the block
  101238. */
  101239. get target(): NodeMaterialBlockTargets;
  101240. set target(value: NodeMaterialBlockTargets);
  101241. /**
  101242. * Gets the list of input points
  101243. */
  101244. get inputs(): NodeMaterialConnectionPoint[];
  101245. /** Gets the list of output points */
  101246. get outputs(): NodeMaterialConnectionPoint[];
  101247. /**
  101248. * Find an input by its name
  101249. * @param name defines the name of the input to look for
  101250. * @returns the input or null if not found
  101251. */
  101252. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101253. /**
  101254. * Find an output by its name
  101255. * @param name defines the name of the outputto look for
  101256. * @returns the output or null if not found
  101257. */
  101258. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101259. /**
  101260. * Creates a new NodeMaterialBlock
  101261. * @param name defines the block name
  101262. * @param target defines the target of that block (Vertex by default)
  101263. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  101264. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  101265. */
  101266. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  101267. /**
  101268. * Initialize the block and prepare the context for build
  101269. * @param state defines the state that will be used for the build
  101270. */
  101271. initialize(state: NodeMaterialBuildState): void;
  101272. /**
  101273. * Bind data to effect. Will only be called for blocks with isBindable === true
  101274. * @param effect defines the effect to bind data to
  101275. * @param nodeMaterial defines the hosting NodeMaterial
  101276. * @param mesh defines the mesh that will be rendered
  101277. * @param subMesh defines the submesh that will be rendered
  101278. */
  101279. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  101280. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  101281. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  101282. protected _writeFloat(value: number): string;
  101283. /**
  101284. * Gets the current class name e.g. "NodeMaterialBlock"
  101285. * @returns the class name
  101286. */
  101287. getClassName(): string;
  101288. /**
  101289. * Register a new input. Must be called inside a block constructor
  101290. * @param name defines the connection point name
  101291. * @param type defines the connection point type
  101292. * @param isOptional defines a boolean indicating that this input can be omitted
  101293. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101294. * @param point an already created connection point. If not provided, create a new one
  101295. * @returns the current block
  101296. */
  101297. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101298. /**
  101299. * Register a new output. Must be called inside a block constructor
  101300. * @param name defines the connection point name
  101301. * @param type defines the connection point type
  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. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101307. /**
  101308. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  101309. * @param forOutput defines an optional connection point to check compatibility with
  101310. * @returns the first available input or null
  101311. */
  101312. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  101313. /**
  101314. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  101315. * @param forBlock defines an optional block to check compatibility with
  101316. * @returns the first available input or null
  101317. */
  101318. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  101319. /**
  101320. * Gets the sibling of the given output
  101321. * @param current defines the current output
  101322. * @returns the next output in the list or null
  101323. */
  101324. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  101325. /**
  101326. * Connect current block with another block
  101327. * @param other defines the block to connect with
  101328. * @param options define the various options to help pick the right connections
  101329. * @returns the current block
  101330. */
  101331. connectTo(other: NodeMaterialBlock, options?: {
  101332. input?: string;
  101333. output?: string;
  101334. outputSwizzle?: string;
  101335. }): this | undefined;
  101336. protected _buildBlock(state: NodeMaterialBuildState): void;
  101337. /**
  101338. * Add uniforms, samplers and uniform buffers at compilation time
  101339. * @param state defines the state to update
  101340. * @param nodeMaterial defines the node material requesting the update
  101341. * @param defines defines the material defines to update
  101342. * @param uniformBuffers defines the list of uniform buffer names
  101343. */
  101344. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  101345. /**
  101346. * Add potential fallbacks if shader compilation fails
  101347. * @param mesh defines the mesh to be rendered
  101348. * @param fallbacks defines the current prioritized list of fallbacks
  101349. */
  101350. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  101351. /**
  101352. * Initialize defines for shader compilation
  101353. * @param mesh defines the mesh to be rendered
  101354. * @param nodeMaterial defines the node material requesting the update
  101355. * @param defines defines the material defines to update
  101356. * @param useInstances specifies that instances should be used
  101357. */
  101358. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  101359. /**
  101360. * Update defines for shader compilation
  101361. * @param mesh defines the mesh to be rendered
  101362. * @param nodeMaterial defines the node material requesting the update
  101363. * @param defines defines the material defines to update
  101364. * @param useInstances specifies that instances should be used
  101365. * @param subMesh defines which submesh to render
  101366. */
  101367. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101368. /**
  101369. * Lets the block try to connect some inputs automatically
  101370. * @param material defines the hosting NodeMaterial
  101371. */
  101372. autoConfigure(material: NodeMaterial): void;
  101373. /**
  101374. * Function called when a block is declared as repeatable content generator
  101375. * @param vertexShaderState defines the current compilation state for the vertex shader
  101376. * @param fragmentShaderState defines the current compilation state for the fragment shader
  101377. * @param mesh defines the mesh to be rendered
  101378. * @param defines defines the material defines to update
  101379. */
  101380. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  101381. /**
  101382. * Checks if the block is ready
  101383. * @param mesh defines the mesh to be rendered
  101384. * @param nodeMaterial defines the node material requesting the update
  101385. * @param defines defines the material defines to update
  101386. * @param useInstances specifies that instances should be used
  101387. * @returns true if the block is ready
  101388. */
  101389. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  101390. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  101391. private _processBuild;
  101392. /**
  101393. * Validates the new name for the block node.
  101394. * @param newName the new name to be given to the node.
  101395. * @returns false if the name is a reserve word, else true.
  101396. */
  101397. validateBlockName(newName: string): boolean;
  101398. /**
  101399. * Compile the current node and generate the shader code
  101400. * @param state defines the current compilation state (uniforms, samplers, current string)
  101401. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  101402. * @returns true if already built
  101403. */
  101404. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  101405. protected _inputRename(name: string): string;
  101406. protected _outputRename(name: string): string;
  101407. protected _dumpPropertiesCode(): string;
  101408. /** @hidden */
  101409. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  101410. /** @hidden */
  101411. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  101412. /**
  101413. * Clone the current block to a new identical block
  101414. * @param scene defines the hosting scene
  101415. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101416. * @returns a copy of the current block
  101417. */
  101418. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  101419. /**
  101420. * Serializes this block in a JSON representation
  101421. * @returns the serialized block object
  101422. */
  101423. serialize(): any;
  101424. /** @hidden */
  101425. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101426. private _deserializePortDisplayNamesAndExposedOnFrame;
  101427. /**
  101428. * Release resources
  101429. */
  101430. dispose(): void;
  101431. }
  101432. }
  101433. declare module BABYLON {
  101434. /**
  101435. * Base class of materials working in push mode in babylon JS
  101436. * @hidden
  101437. */
  101438. export class PushMaterial extends Material {
  101439. protected _activeEffect: Effect;
  101440. protected _normalMatrix: Matrix;
  101441. constructor(name: string, scene: Scene);
  101442. getEffect(): Effect;
  101443. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  101444. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  101445. /**
  101446. * Binds the given world matrix to the active effect
  101447. *
  101448. * @param world the matrix to bind
  101449. */
  101450. bindOnlyWorldMatrix(world: Matrix): void;
  101451. /**
  101452. * Binds the given normal matrix to the active effect
  101453. *
  101454. * @param normalMatrix the matrix to bind
  101455. */
  101456. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  101457. bind(world: Matrix, mesh?: Mesh): void;
  101458. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  101459. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  101460. }
  101461. }
  101462. declare module BABYLON {
  101463. /**
  101464. * Root class for all node material optimizers
  101465. */
  101466. export class NodeMaterialOptimizer {
  101467. /**
  101468. * Function used to optimize a NodeMaterial graph
  101469. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  101470. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  101471. */
  101472. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  101473. }
  101474. }
  101475. declare module BABYLON {
  101476. /**
  101477. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  101478. */
  101479. export class TransformBlock extends NodeMaterialBlock {
  101480. /**
  101481. * Defines the value to use to complement W value to transform it to a Vector4
  101482. */
  101483. complementW: number;
  101484. /**
  101485. * Defines the value to use to complement z value to transform it to a Vector4
  101486. */
  101487. complementZ: number;
  101488. /**
  101489. * Creates a new TransformBlock
  101490. * @param name defines the block name
  101491. */
  101492. constructor(name: string);
  101493. /**
  101494. * Gets the current class name
  101495. * @returns the class name
  101496. */
  101497. getClassName(): string;
  101498. /**
  101499. * Gets the vector input
  101500. */
  101501. get vector(): NodeMaterialConnectionPoint;
  101502. /**
  101503. * Gets the output component
  101504. */
  101505. get output(): NodeMaterialConnectionPoint;
  101506. /**
  101507. * Gets the xyz output component
  101508. */
  101509. get xyz(): NodeMaterialConnectionPoint;
  101510. /**
  101511. * Gets the matrix transform input
  101512. */
  101513. get transform(): NodeMaterialConnectionPoint;
  101514. protected _buildBlock(state: NodeMaterialBuildState): this;
  101515. /**
  101516. * Update defines for shader compilation
  101517. * @param mesh defines the mesh to be rendered
  101518. * @param nodeMaterial defines the node material requesting the update
  101519. * @param defines defines the material defines to update
  101520. * @param useInstances specifies that instances should be used
  101521. * @param subMesh defines which submesh to render
  101522. */
  101523. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101524. serialize(): any;
  101525. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101526. protected _dumpPropertiesCode(): string;
  101527. }
  101528. }
  101529. declare module BABYLON {
  101530. /**
  101531. * Block used to output the vertex position
  101532. */
  101533. export class VertexOutputBlock extends NodeMaterialBlock {
  101534. /**
  101535. * Creates a new VertexOutputBlock
  101536. * @param name defines the block name
  101537. */
  101538. constructor(name: string);
  101539. /**
  101540. * Gets the current class name
  101541. * @returns the class name
  101542. */
  101543. getClassName(): string;
  101544. /**
  101545. * Gets the vector input component
  101546. */
  101547. get vector(): NodeMaterialConnectionPoint;
  101548. protected _buildBlock(state: NodeMaterialBuildState): this;
  101549. }
  101550. }
  101551. declare module BABYLON {
  101552. /**
  101553. * Block used to output the final color
  101554. */
  101555. export class FragmentOutputBlock extends NodeMaterialBlock {
  101556. /**
  101557. * Create a new FragmentOutputBlock
  101558. * @param name defines the block name
  101559. */
  101560. constructor(name: string);
  101561. /**
  101562. * Gets the current class name
  101563. * @returns the class name
  101564. */
  101565. getClassName(): string;
  101566. /**
  101567. * Gets the rgba input component
  101568. */
  101569. get rgba(): NodeMaterialConnectionPoint;
  101570. /**
  101571. * Gets the rgb input component
  101572. */
  101573. get rgb(): NodeMaterialConnectionPoint;
  101574. /**
  101575. * Gets the a input component
  101576. */
  101577. get a(): NodeMaterialConnectionPoint;
  101578. protected _buildBlock(state: NodeMaterialBuildState): this;
  101579. }
  101580. }
  101581. declare module BABYLON {
  101582. /**
  101583. * Block used for the particle ramp gradient section
  101584. */
  101585. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  101586. /**
  101587. * Create a new ParticleRampGradientBlock
  101588. * @param name defines the block name
  101589. */
  101590. constructor(name: string);
  101591. /**
  101592. * Gets the current class name
  101593. * @returns the class name
  101594. */
  101595. getClassName(): string;
  101596. /**
  101597. * Gets the color input component
  101598. */
  101599. get color(): NodeMaterialConnectionPoint;
  101600. /**
  101601. * Gets the rampColor output component
  101602. */
  101603. get rampColor(): NodeMaterialConnectionPoint;
  101604. /**
  101605. * Initialize the block and prepare the context for build
  101606. * @param state defines the state that will be used for the build
  101607. */
  101608. initialize(state: NodeMaterialBuildState): void;
  101609. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101610. }
  101611. }
  101612. declare module BABYLON {
  101613. /**
  101614. * Block used for the particle blend multiply section
  101615. */
  101616. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  101617. /**
  101618. * Create a new ParticleBlendMultiplyBlock
  101619. * @param name defines the block name
  101620. */
  101621. constructor(name: string);
  101622. /**
  101623. * Gets the current class name
  101624. * @returns the class name
  101625. */
  101626. getClassName(): string;
  101627. /**
  101628. * Gets the color input component
  101629. */
  101630. get color(): NodeMaterialConnectionPoint;
  101631. /**
  101632. * Gets the alphaTexture input component
  101633. */
  101634. get alphaTexture(): NodeMaterialConnectionPoint;
  101635. /**
  101636. * Gets the alphaColor input component
  101637. */
  101638. get alphaColor(): NodeMaterialConnectionPoint;
  101639. /**
  101640. * Gets the blendColor output component
  101641. */
  101642. get blendColor(): NodeMaterialConnectionPoint;
  101643. /**
  101644. * Initialize the block and prepare the context for build
  101645. * @param state defines the state that will be used for the build
  101646. */
  101647. initialize(state: NodeMaterialBuildState): void;
  101648. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101649. }
  101650. }
  101651. declare module BABYLON {
  101652. /**
  101653. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  101654. */
  101655. export class VectorMergerBlock extends NodeMaterialBlock {
  101656. /**
  101657. * Create a new VectorMergerBlock
  101658. * @param name defines the block name
  101659. */
  101660. constructor(name: string);
  101661. /**
  101662. * Gets the current class name
  101663. * @returns the class name
  101664. */
  101665. getClassName(): string;
  101666. /**
  101667. * Gets the xyz component (input)
  101668. */
  101669. get xyzIn(): NodeMaterialConnectionPoint;
  101670. /**
  101671. * Gets the xy component (input)
  101672. */
  101673. get xyIn(): NodeMaterialConnectionPoint;
  101674. /**
  101675. * Gets the x component (input)
  101676. */
  101677. get x(): NodeMaterialConnectionPoint;
  101678. /**
  101679. * Gets the y component (input)
  101680. */
  101681. get y(): NodeMaterialConnectionPoint;
  101682. /**
  101683. * Gets the z component (input)
  101684. */
  101685. get z(): NodeMaterialConnectionPoint;
  101686. /**
  101687. * Gets the w component (input)
  101688. */
  101689. get w(): NodeMaterialConnectionPoint;
  101690. /**
  101691. * Gets the xyzw component (output)
  101692. */
  101693. get xyzw(): NodeMaterialConnectionPoint;
  101694. /**
  101695. * Gets the xyz component (output)
  101696. */
  101697. get xyzOut(): NodeMaterialConnectionPoint;
  101698. /**
  101699. * Gets the xy component (output)
  101700. */
  101701. get xyOut(): NodeMaterialConnectionPoint;
  101702. /**
  101703. * Gets the xy component (output)
  101704. * @deprecated Please use xyOut instead.
  101705. */
  101706. get xy(): NodeMaterialConnectionPoint;
  101707. /**
  101708. * Gets the xyz component (output)
  101709. * @deprecated Please use xyzOut instead.
  101710. */
  101711. get xyz(): NodeMaterialConnectionPoint;
  101712. protected _buildBlock(state: NodeMaterialBuildState): this;
  101713. }
  101714. }
  101715. declare module BABYLON {
  101716. /**
  101717. * Block used to remap a float from a range to a new one
  101718. */
  101719. export class RemapBlock extends NodeMaterialBlock {
  101720. /**
  101721. * Gets or sets the source range
  101722. */
  101723. sourceRange: Vector2;
  101724. /**
  101725. * Gets or sets the target range
  101726. */
  101727. targetRange: Vector2;
  101728. /**
  101729. * Creates a new RemapBlock
  101730. * @param name defines the block name
  101731. */
  101732. constructor(name: string);
  101733. /**
  101734. * Gets the current class name
  101735. * @returns the class name
  101736. */
  101737. getClassName(): string;
  101738. /**
  101739. * Gets the input component
  101740. */
  101741. get input(): NodeMaterialConnectionPoint;
  101742. /**
  101743. * Gets the source min input component
  101744. */
  101745. get sourceMin(): NodeMaterialConnectionPoint;
  101746. /**
  101747. * Gets the source max input component
  101748. */
  101749. get sourceMax(): NodeMaterialConnectionPoint;
  101750. /**
  101751. * Gets the target min input component
  101752. */
  101753. get targetMin(): NodeMaterialConnectionPoint;
  101754. /**
  101755. * Gets the target max input component
  101756. */
  101757. get targetMax(): NodeMaterialConnectionPoint;
  101758. /**
  101759. * Gets the output component
  101760. */
  101761. get output(): NodeMaterialConnectionPoint;
  101762. protected _buildBlock(state: NodeMaterialBuildState): this;
  101763. protected _dumpPropertiesCode(): string;
  101764. serialize(): any;
  101765. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101766. }
  101767. }
  101768. declare module BABYLON {
  101769. /**
  101770. * Block used to multiply 2 values
  101771. */
  101772. export class MultiplyBlock extends NodeMaterialBlock {
  101773. /**
  101774. * Creates a new MultiplyBlock
  101775. * @param name defines the block name
  101776. */
  101777. constructor(name: string);
  101778. /**
  101779. * Gets the current class name
  101780. * @returns the class name
  101781. */
  101782. getClassName(): string;
  101783. /**
  101784. * Gets the left operand input component
  101785. */
  101786. get left(): NodeMaterialConnectionPoint;
  101787. /**
  101788. * Gets the right operand input component
  101789. */
  101790. get right(): NodeMaterialConnectionPoint;
  101791. /**
  101792. * Gets the output component
  101793. */
  101794. get output(): NodeMaterialConnectionPoint;
  101795. protected _buildBlock(state: NodeMaterialBuildState): this;
  101796. }
  101797. }
  101798. declare module BABYLON {
  101799. /**
  101800. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  101801. */
  101802. export class ColorSplitterBlock extends NodeMaterialBlock {
  101803. /**
  101804. * Create a new ColorSplitterBlock
  101805. * @param name defines the block name
  101806. */
  101807. constructor(name: string);
  101808. /**
  101809. * Gets the current class name
  101810. * @returns the class name
  101811. */
  101812. getClassName(): string;
  101813. /**
  101814. * Gets the rgba component (input)
  101815. */
  101816. get rgba(): NodeMaterialConnectionPoint;
  101817. /**
  101818. * Gets the rgb component (input)
  101819. */
  101820. get rgbIn(): NodeMaterialConnectionPoint;
  101821. /**
  101822. * Gets the rgb component (output)
  101823. */
  101824. get rgbOut(): NodeMaterialConnectionPoint;
  101825. /**
  101826. * Gets the r component (output)
  101827. */
  101828. get r(): NodeMaterialConnectionPoint;
  101829. /**
  101830. * Gets the g component (output)
  101831. */
  101832. get g(): NodeMaterialConnectionPoint;
  101833. /**
  101834. * Gets the b component (output)
  101835. */
  101836. get b(): NodeMaterialConnectionPoint;
  101837. /**
  101838. * Gets the a component (output)
  101839. */
  101840. get a(): NodeMaterialConnectionPoint;
  101841. protected _inputRename(name: string): string;
  101842. protected _outputRename(name: string): string;
  101843. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101844. }
  101845. }
  101846. declare module BABYLON {
  101847. /**
  101848. * Interface used to configure the node material editor
  101849. */
  101850. export interface INodeMaterialEditorOptions {
  101851. /** Define the URl to load node editor script */
  101852. editorURL?: string;
  101853. }
  101854. /** @hidden */
  101855. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  101856. NORMAL: boolean;
  101857. TANGENT: boolean;
  101858. UV1: boolean;
  101859. /** BONES */
  101860. NUM_BONE_INFLUENCERS: number;
  101861. BonesPerMesh: number;
  101862. BONETEXTURE: boolean;
  101863. /** MORPH TARGETS */
  101864. MORPHTARGETS: boolean;
  101865. MORPHTARGETS_NORMAL: boolean;
  101866. MORPHTARGETS_TANGENT: boolean;
  101867. MORPHTARGETS_UV: boolean;
  101868. NUM_MORPH_INFLUENCERS: number;
  101869. /** IMAGE PROCESSING */
  101870. IMAGEPROCESSING: boolean;
  101871. VIGNETTE: boolean;
  101872. VIGNETTEBLENDMODEMULTIPLY: boolean;
  101873. VIGNETTEBLENDMODEOPAQUE: boolean;
  101874. TONEMAPPING: boolean;
  101875. TONEMAPPING_ACES: boolean;
  101876. CONTRAST: boolean;
  101877. EXPOSURE: boolean;
  101878. COLORCURVES: boolean;
  101879. COLORGRADING: boolean;
  101880. COLORGRADING3D: boolean;
  101881. SAMPLER3DGREENDEPTH: boolean;
  101882. SAMPLER3DBGRMAP: boolean;
  101883. IMAGEPROCESSINGPOSTPROCESS: boolean;
  101884. /** MISC. */
  101885. BUMPDIRECTUV: number;
  101886. constructor();
  101887. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  101888. }
  101889. /**
  101890. * Class used to configure NodeMaterial
  101891. */
  101892. export interface INodeMaterialOptions {
  101893. /**
  101894. * Defines if blocks should emit comments
  101895. */
  101896. emitComments: boolean;
  101897. }
  101898. /**
  101899. * Class used to create a node based material built by assembling shader blocks
  101900. */
  101901. export class NodeMaterial extends PushMaterial {
  101902. private static _BuildIdGenerator;
  101903. private _options;
  101904. private _vertexCompilationState;
  101905. private _fragmentCompilationState;
  101906. private _sharedData;
  101907. private _buildId;
  101908. private _buildWasSuccessful;
  101909. private _cachedWorldViewMatrix;
  101910. private _cachedWorldViewProjectionMatrix;
  101911. private _optimizers;
  101912. private _animationFrame;
  101913. /** Define the Url to load node editor script */
  101914. static EditorURL: string;
  101915. /** Define the Url to load snippets */
  101916. static SnippetUrl: string;
  101917. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  101918. static IgnoreTexturesAtLoadTime: boolean;
  101919. private BJSNODEMATERIALEDITOR;
  101920. /** Get the inspector from bundle or global */
  101921. private _getGlobalNodeMaterialEditor;
  101922. /**
  101923. * Snippet ID if the material was created from the snippet server
  101924. */
  101925. snippetId: string;
  101926. /**
  101927. * Gets or sets data used by visual editor
  101928. * @see https://nme.babylonjs.com
  101929. */
  101930. editorData: any;
  101931. /**
  101932. * 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)
  101933. */
  101934. ignoreAlpha: boolean;
  101935. /**
  101936. * Defines the maximum number of lights that can be used in the material
  101937. */
  101938. maxSimultaneousLights: number;
  101939. /**
  101940. * Observable raised when the material is built
  101941. */
  101942. onBuildObservable: Observable<NodeMaterial>;
  101943. /**
  101944. * Gets or sets the root nodes of the material vertex shader
  101945. */
  101946. _vertexOutputNodes: NodeMaterialBlock[];
  101947. /**
  101948. * Gets or sets the root nodes of the material fragment (pixel) shader
  101949. */
  101950. _fragmentOutputNodes: NodeMaterialBlock[];
  101951. /** Gets or sets options to control the node material overall behavior */
  101952. get options(): INodeMaterialOptions;
  101953. set options(options: INodeMaterialOptions);
  101954. /**
  101955. * Default configuration related to image processing available in the standard Material.
  101956. */
  101957. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  101958. /**
  101959. * Gets the image processing configuration used either in this material.
  101960. */
  101961. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  101962. /**
  101963. * Sets the Default image processing configuration used either in the this material.
  101964. *
  101965. * If sets to null, the scene one is in use.
  101966. */
  101967. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  101968. /**
  101969. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  101970. */
  101971. attachedBlocks: NodeMaterialBlock[];
  101972. /**
  101973. * Specifies the mode of the node material
  101974. * @hidden
  101975. */
  101976. _mode: NodeMaterialModes;
  101977. /**
  101978. * Gets the mode property
  101979. */
  101980. get mode(): NodeMaterialModes;
  101981. /**
  101982. * Create a new node based material
  101983. * @param name defines the material name
  101984. * @param scene defines the hosting scene
  101985. * @param options defines creation option
  101986. */
  101987. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  101988. /**
  101989. * Gets the current class name of the material e.g. "NodeMaterial"
  101990. * @returns the class name
  101991. */
  101992. getClassName(): string;
  101993. /**
  101994. * Keep track of the image processing observer to allow dispose and replace.
  101995. */
  101996. private _imageProcessingObserver;
  101997. /**
  101998. * Attaches a new image processing configuration to the Standard Material.
  101999. * @param configuration
  102000. */
  102001. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  102002. /**
  102003. * Get a block by its name
  102004. * @param name defines the name of the block to retrieve
  102005. * @returns the required block or null if not found
  102006. */
  102007. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  102008. /**
  102009. * Get a block by its name
  102010. * @param predicate defines the predicate used to find the good candidate
  102011. * @returns the required block or null if not found
  102012. */
  102013. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  102014. /**
  102015. * Get an input block by its name
  102016. * @param predicate defines the predicate used to find the good candidate
  102017. * @returns the required input block or null if not found
  102018. */
  102019. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  102020. /**
  102021. * Gets the list of input blocks attached to this material
  102022. * @returns an array of InputBlocks
  102023. */
  102024. getInputBlocks(): InputBlock[];
  102025. /**
  102026. * Adds a new optimizer to the list of optimizers
  102027. * @param optimizer defines the optimizers to add
  102028. * @returns the current material
  102029. */
  102030. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102031. /**
  102032. * Remove an optimizer from the list of optimizers
  102033. * @param optimizer defines the optimizers to remove
  102034. * @returns the current material
  102035. */
  102036. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102037. /**
  102038. * Add a new block to the list of output nodes
  102039. * @param node defines the node to add
  102040. * @returns the current material
  102041. */
  102042. addOutputNode(node: NodeMaterialBlock): this;
  102043. /**
  102044. * Remove a block from the list of root nodes
  102045. * @param node defines the node to remove
  102046. * @returns the current material
  102047. */
  102048. removeOutputNode(node: NodeMaterialBlock): this;
  102049. private _addVertexOutputNode;
  102050. private _removeVertexOutputNode;
  102051. private _addFragmentOutputNode;
  102052. private _removeFragmentOutputNode;
  102053. /**
  102054. * Specifies if the material will require alpha blending
  102055. * @returns a boolean specifying if alpha blending is needed
  102056. */
  102057. needAlphaBlending(): boolean;
  102058. /**
  102059. * Specifies if this material should be rendered in alpha test mode
  102060. * @returns a boolean specifying if an alpha test is needed.
  102061. */
  102062. needAlphaTesting(): boolean;
  102063. private _initializeBlock;
  102064. private _resetDualBlocks;
  102065. /**
  102066. * Remove a block from the current node material
  102067. * @param block defines the block to remove
  102068. */
  102069. removeBlock(block: NodeMaterialBlock): void;
  102070. /**
  102071. * Build the material and generates the inner effect
  102072. * @param verbose defines if the build should log activity
  102073. */
  102074. build(verbose?: boolean): void;
  102075. /**
  102076. * Runs an otpimization phase to try to improve the shader code
  102077. */
  102078. optimize(): void;
  102079. private _prepareDefinesForAttributes;
  102080. /**
  102081. * Create a post process from the material
  102082. * @param camera The camera to apply the render pass to.
  102083. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102084. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102085. * @param engine The engine which the post process will be applied. (default: current engine)
  102086. * @param reusable If the post process can be reused on the same frame. (default: false)
  102087. * @param textureType Type of textures used when performing the post process. (default: 0)
  102088. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102089. * @returns the post process created
  102090. */
  102091. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  102092. /**
  102093. * Create the post process effect from the material
  102094. * @param postProcess The post process to create the effect for
  102095. */
  102096. createEffectForPostProcess(postProcess: PostProcess): void;
  102097. private _createEffectOrPostProcess;
  102098. private _createEffectForParticles;
  102099. /**
  102100. * Create the effect to be used as the custom effect for a particle system
  102101. * @param particleSystem Particle system to create the effect for
  102102. * @param onCompiled defines a function to call when the effect creation is successful
  102103. * @param onError defines a function to call when the effect creation has failed
  102104. */
  102105. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102106. private _processDefines;
  102107. /**
  102108. * Get if the submesh is ready to be used and all its information available.
  102109. * Child classes can use it to update shaders
  102110. * @param mesh defines the mesh to check
  102111. * @param subMesh defines which submesh to check
  102112. * @param useInstances specifies that instances should be used
  102113. * @returns a boolean indicating that the submesh is ready or not
  102114. */
  102115. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  102116. /**
  102117. * Get a string representing the shaders built by the current node graph
  102118. */
  102119. get compiledShaders(): string;
  102120. /**
  102121. * Binds the world matrix to the material
  102122. * @param world defines the world transformation matrix
  102123. */
  102124. bindOnlyWorldMatrix(world: Matrix): void;
  102125. /**
  102126. * Binds the submesh to this material by preparing the effect and shader to draw
  102127. * @param world defines the world transformation matrix
  102128. * @param mesh defines the mesh containing the submesh
  102129. * @param subMesh defines the submesh to bind the material to
  102130. */
  102131. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  102132. /**
  102133. * Gets the active textures from the material
  102134. * @returns an array of textures
  102135. */
  102136. getActiveTextures(): BaseTexture[];
  102137. /**
  102138. * Gets the list of texture blocks
  102139. * @returns an array of texture blocks
  102140. */
  102141. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  102142. /**
  102143. * Specifies if the material uses a texture
  102144. * @param texture defines the texture to check against the material
  102145. * @returns a boolean specifying if the material uses the texture
  102146. */
  102147. hasTexture(texture: BaseTexture): boolean;
  102148. /**
  102149. * Disposes the material
  102150. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  102151. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  102152. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  102153. */
  102154. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  102155. /** Creates the node editor window. */
  102156. private _createNodeEditor;
  102157. /**
  102158. * Launch the node material editor
  102159. * @param config Define the configuration of the editor
  102160. * @return a promise fulfilled when the node editor is visible
  102161. */
  102162. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  102163. /**
  102164. * Clear the current material
  102165. */
  102166. clear(): void;
  102167. /**
  102168. * Clear the current material and set it to a default state
  102169. */
  102170. setToDefault(): void;
  102171. /**
  102172. * Clear the current material and set it to a default state for post process
  102173. */
  102174. setToDefaultPostProcess(): void;
  102175. /**
  102176. * Clear the current material and set it to a default state for particle
  102177. */
  102178. setToDefaultParticle(): void;
  102179. /**
  102180. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  102181. * @param url defines the url to load from
  102182. * @returns a promise that will fullfil when the material is fully loaded
  102183. */
  102184. loadAsync(url: string): Promise<void>;
  102185. private _gatherBlocks;
  102186. /**
  102187. * Generate a string containing the code declaration required to create an equivalent of this material
  102188. * @returns a string
  102189. */
  102190. generateCode(): string;
  102191. /**
  102192. * Serializes this material in a JSON representation
  102193. * @returns the serialized material object
  102194. */
  102195. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  102196. private _restoreConnections;
  102197. /**
  102198. * Clear the current graph and load a new one from a serialization object
  102199. * @param source defines the JSON representation of the material
  102200. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102201. * @param merge defines whether or not the source must be merged or replace the current content
  102202. */
  102203. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  102204. /**
  102205. * Makes a duplicate of the current material.
  102206. * @param name - name to use for the new material.
  102207. */
  102208. clone(name: string): NodeMaterial;
  102209. /**
  102210. * Creates a node material from parsed material data
  102211. * @param source defines the JSON representation of the material
  102212. * @param scene defines the hosting scene
  102213. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102214. * @returns a new node material
  102215. */
  102216. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  102217. /**
  102218. * Creates a node material from a snippet saved in a remote file
  102219. * @param name defines the name of the material to create
  102220. * @param url defines the url to load from
  102221. * @param scene defines the hosting scene
  102222. * @returns a promise that will resolve to the new node material
  102223. */
  102224. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  102225. /**
  102226. * Creates a node material from a snippet saved by the node material editor
  102227. * @param snippetId defines the snippet to load
  102228. * @param scene defines the hosting scene
  102229. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102230. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  102231. * @returns a promise that will resolve to the new node material
  102232. */
  102233. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  102234. /**
  102235. * Creates a new node material set to default basic configuration
  102236. * @param name defines the name of the material
  102237. * @param scene defines the hosting scene
  102238. * @returns a new NodeMaterial
  102239. */
  102240. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  102241. }
  102242. }
  102243. declare module BABYLON {
  102244. /**
  102245. * Size options for a post process
  102246. */
  102247. export type PostProcessOptions = {
  102248. width: number;
  102249. height: number;
  102250. };
  102251. /**
  102252. * PostProcess can be used to apply a shader to a texture after it has been rendered
  102253. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  102254. */
  102255. export class PostProcess {
  102256. /**
  102257. * Gets or sets the unique id of the post process
  102258. */
  102259. uniqueId: number;
  102260. /** Name of the PostProcess. */
  102261. name: string;
  102262. /**
  102263. * Width of the texture to apply the post process on
  102264. */
  102265. width: number;
  102266. /**
  102267. * Height of the texture to apply the post process on
  102268. */
  102269. height: number;
  102270. /**
  102271. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  102272. */
  102273. nodeMaterialSource: Nullable<NodeMaterial>;
  102274. /**
  102275. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  102276. * @hidden
  102277. */
  102278. _outputTexture: Nullable<InternalTexture>;
  102279. /**
  102280. * Sampling mode used by the shader
  102281. * See https://doc.babylonjs.com/classes/3.1/texture
  102282. */
  102283. renderTargetSamplingMode: number;
  102284. /**
  102285. * Clear color to use when screen clearing
  102286. */
  102287. clearColor: Color4;
  102288. /**
  102289. * If the buffer needs to be cleared before applying the post process. (default: true)
  102290. * Should be set to false if shader will overwrite all previous pixels.
  102291. */
  102292. autoClear: boolean;
  102293. /**
  102294. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  102295. */
  102296. alphaMode: number;
  102297. /**
  102298. * Sets the setAlphaBlendConstants of the babylon engine
  102299. */
  102300. alphaConstants: Color4;
  102301. /**
  102302. * Animations to be used for the post processing
  102303. */
  102304. animations: Animation[];
  102305. /**
  102306. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  102307. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  102308. */
  102309. enablePixelPerfectMode: boolean;
  102310. /**
  102311. * Force the postprocess to be applied without taking in account viewport
  102312. */
  102313. forceFullscreenViewport: boolean;
  102314. /**
  102315. * List of inspectable custom properties (used by the Inspector)
  102316. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102317. */
  102318. inspectableCustomProperties: IInspectable[];
  102319. /**
  102320. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  102321. *
  102322. * | Value | Type | Description |
  102323. * | ----- | ----------------------------------- | ----------- |
  102324. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  102325. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  102326. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  102327. *
  102328. */
  102329. scaleMode: number;
  102330. /**
  102331. * Force textures to be a power of two (default: false)
  102332. */
  102333. alwaysForcePOT: boolean;
  102334. private _samples;
  102335. /**
  102336. * Number of sample textures (default: 1)
  102337. */
  102338. get samples(): number;
  102339. set samples(n: number);
  102340. /**
  102341. * Modify the scale of the post process to be the same as the viewport (default: false)
  102342. */
  102343. adaptScaleToCurrentViewport: boolean;
  102344. private _camera;
  102345. protected _scene: Scene;
  102346. private _engine;
  102347. private _options;
  102348. private _reusable;
  102349. private _textureType;
  102350. private _textureFormat;
  102351. /**
  102352. * Smart array of input and output textures for the post process.
  102353. * @hidden
  102354. */
  102355. _textures: SmartArray<InternalTexture>;
  102356. /**
  102357. * The index in _textures that corresponds to the output texture.
  102358. * @hidden
  102359. */
  102360. _currentRenderTextureInd: number;
  102361. private _effect;
  102362. private _samplers;
  102363. private _fragmentUrl;
  102364. private _vertexUrl;
  102365. private _parameters;
  102366. private _scaleRatio;
  102367. protected _indexParameters: any;
  102368. private _shareOutputWithPostProcess;
  102369. private _texelSize;
  102370. private _forcedOutputTexture;
  102371. /**
  102372. * Returns the fragment url or shader name used in the post process.
  102373. * @returns the fragment url or name in the shader store.
  102374. */
  102375. getEffectName(): string;
  102376. /**
  102377. * An event triggered when the postprocess is activated.
  102378. */
  102379. onActivateObservable: Observable<Camera>;
  102380. private _onActivateObserver;
  102381. /**
  102382. * A function that is added to the onActivateObservable
  102383. */
  102384. set onActivate(callback: Nullable<(camera: Camera) => void>);
  102385. /**
  102386. * An event triggered when the postprocess changes its size.
  102387. */
  102388. onSizeChangedObservable: Observable<PostProcess>;
  102389. private _onSizeChangedObserver;
  102390. /**
  102391. * A function that is added to the onSizeChangedObservable
  102392. */
  102393. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  102394. /**
  102395. * An event triggered when the postprocess applies its effect.
  102396. */
  102397. onApplyObservable: Observable<Effect>;
  102398. private _onApplyObserver;
  102399. /**
  102400. * A function that is added to the onApplyObservable
  102401. */
  102402. set onApply(callback: (effect: Effect) => void);
  102403. /**
  102404. * An event triggered before rendering the postprocess
  102405. */
  102406. onBeforeRenderObservable: Observable<Effect>;
  102407. private _onBeforeRenderObserver;
  102408. /**
  102409. * A function that is added to the onBeforeRenderObservable
  102410. */
  102411. set onBeforeRender(callback: (effect: Effect) => void);
  102412. /**
  102413. * An event triggered after rendering the postprocess
  102414. */
  102415. onAfterRenderObservable: Observable<Effect>;
  102416. private _onAfterRenderObserver;
  102417. /**
  102418. * A function that is added to the onAfterRenderObservable
  102419. */
  102420. set onAfterRender(callback: (efect: Effect) => void);
  102421. /**
  102422. * 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
  102423. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  102424. */
  102425. get inputTexture(): InternalTexture;
  102426. set inputTexture(value: InternalTexture);
  102427. /**
  102428. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  102429. * the only way to unset it is to use this function to restore its internal state
  102430. */
  102431. restoreDefaultInputTexture(): void;
  102432. /**
  102433. * Gets the camera which post process is applied to.
  102434. * @returns The camera the post process is applied to.
  102435. */
  102436. getCamera(): Camera;
  102437. /**
  102438. * Gets the texel size of the postprocess.
  102439. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  102440. */
  102441. get texelSize(): Vector2;
  102442. /**
  102443. * Creates a new instance PostProcess
  102444. * @param name The name of the PostProcess.
  102445. * @param fragmentUrl The url of the fragment shader to be used.
  102446. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  102447. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  102448. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102449. * @param camera The camera to apply the render pass to.
  102450. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102451. * @param engine The engine which the post process will be applied. (default: current engine)
  102452. * @param reusable If the post process can be reused on the same frame. (default: false)
  102453. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  102454. * @param textureType Type of textures used when performing the post process. (default: 0)
  102455. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  102456. * @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
  102457. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  102458. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102459. */
  102460. 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);
  102461. /**
  102462. * Gets a string identifying the name of the class
  102463. * @returns "PostProcess" string
  102464. */
  102465. getClassName(): string;
  102466. /**
  102467. * Gets the engine which this post process belongs to.
  102468. * @returns The engine the post process was enabled with.
  102469. */
  102470. getEngine(): Engine;
  102471. /**
  102472. * The effect that is created when initializing the post process.
  102473. * @returns The created effect corresponding the the postprocess.
  102474. */
  102475. getEffect(): Effect;
  102476. /**
  102477. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  102478. * @param postProcess The post process to share the output with.
  102479. * @returns This post process.
  102480. */
  102481. shareOutputWith(postProcess: PostProcess): PostProcess;
  102482. /**
  102483. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  102484. * This should be called if the post process that shares output with this post process is disabled/disposed.
  102485. */
  102486. useOwnOutput(): void;
  102487. /**
  102488. * Updates the effect with the current post process compile time values and recompiles the shader.
  102489. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102490. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102491. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102492. * @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
  102493. * @param onCompiled Called when the shader has been compiled.
  102494. * @param onError Called if there is an error when compiling a shader.
  102495. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  102496. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  102497. */
  102498. 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;
  102499. /**
  102500. * The post process is reusable if it can be used multiple times within one frame.
  102501. * @returns If the post process is reusable
  102502. */
  102503. isReusable(): boolean;
  102504. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  102505. markTextureDirty(): void;
  102506. /**
  102507. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  102508. * 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.
  102509. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  102510. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  102511. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  102512. * @returns The target texture that was bound to be written to.
  102513. */
  102514. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  102515. /**
  102516. * If the post process is supported.
  102517. */
  102518. get isSupported(): boolean;
  102519. /**
  102520. * The aspect ratio of the output texture.
  102521. */
  102522. get aspectRatio(): number;
  102523. /**
  102524. * Get a value indicating if the post-process is ready to be used
  102525. * @returns true if the post-process is ready (shader is compiled)
  102526. */
  102527. isReady(): boolean;
  102528. /**
  102529. * Binds all textures and uniforms to the shader, this will be run on every pass.
  102530. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  102531. */
  102532. apply(): Nullable<Effect>;
  102533. private _disposeTextures;
  102534. /**
  102535. * Disposes the post process.
  102536. * @param camera The camera to dispose the post process on.
  102537. */
  102538. dispose(camera?: Camera): void;
  102539. /**
  102540. * Serializes the particle system to a JSON object
  102541. * @returns the JSON object
  102542. */
  102543. serialize(): any;
  102544. /**
  102545. * Creates a material from parsed material data
  102546. * @param parsedPostProcess defines parsed post process data
  102547. * @param scene defines the hosting scene
  102548. * @param rootUrl defines the root URL to use to load textures
  102549. * @returns a new post process
  102550. */
  102551. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  102552. }
  102553. }
  102554. declare module BABYLON {
  102555. /** @hidden */
  102556. export var kernelBlurVaryingDeclaration: {
  102557. name: string;
  102558. shader: string;
  102559. };
  102560. }
  102561. declare module BABYLON {
  102562. /** @hidden */
  102563. export var kernelBlurFragment: {
  102564. name: string;
  102565. shader: string;
  102566. };
  102567. }
  102568. declare module BABYLON {
  102569. /** @hidden */
  102570. export var kernelBlurFragment2: {
  102571. name: string;
  102572. shader: string;
  102573. };
  102574. }
  102575. declare module BABYLON {
  102576. /** @hidden */
  102577. export var kernelBlurPixelShader: {
  102578. name: string;
  102579. shader: string;
  102580. };
  102581. }
  102582. declare module BABYLON {
  102583. /** @hidden */
  102584. export var kernelBlurVertex: {
  102585. name: string;
  102586. shader: string;
  102587. };
  102588. }
  102589. declare module BABYLON {
  102590. /** @hidden */
  102591. export var kernelBlurVertexShader: {
  102592. name: string;
  102593. shader: string;
  102594. };
  102595. }
  102596. declare module BABYLON {
  102597. /**
  102598. * The Blur Post Process which blurs an image based on a kernel and direction.
  102599. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  102600. */
  102601. export class BlurPostProcess extends PostProcess {
  102602. private blockCompilation;
  102603. protected _kernel: number;
  102604. protected _idealKernel: number;
  102605. protected _packedFloat: boolean;
  102606. private _staticDefines;
  102607. /** The direction in which to blur the image. */
  102608. direction: Vector2;
  102609. /**
  102610. * Sets the length in pixels of the blur sample region
  102611. */
  102612. set kernel(v: number);
  102613. /**
  102614. * Gets the length in pixels of the blur sample region
  102615. */
  102616. get kernel(): number;
  102617. /**
  102618. * Sets wether or not the blur needs to unpack/repack floats
  102619. */
  102620. set packedFloat(v: boolean);
  102621. /**
  102622. * Gets wether or not the blur is unpacking/repacking floats
  102623. */
  102624. get packedFloat(): boolean;
  102625. /**
  102626. * Gets a string identifying the name of the class
  102627. * @returns "BlurPostProcess" string
  102628. */
  102629. getClassName(): string;
  102630. /**
  102631. * Creates a new instance BlurPostProcess
  102632. * @param name The name of the effect.
  102633. * @param direction The direction in which to blur the image.
  102634. * @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.
  102635. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102636. * @param camera The camera to apply the render pass to.
  102637. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102638. * @param engine The engine which the post process will be applied. (default: current engine)
  102639. * @param reusable If the post process can be reused on the same frame. (default: false)
  102640. * @param textureType Type of textures used when performing the post process. (default: 0)
  102641. * @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)
  102642. */
  102643. 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);
  102644. /**
  102645. * Updates the effect with the current post process compile time values and recompiles the shader.
  102646. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102647. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102648. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102649. * @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
  102650. * @param onCompiled Called when the shader has been compiled.
  102651. * @param onError Called if there is an error when compiling a shader.
  102652. */
  102653. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102654. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102655. /**
  102656. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  102657. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  102658. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  102659. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  102660. * The gaps between physical kernels are compensated for in the weighting of the samples
  102661. * @param idealKernel Ideal blur kernel.
  102662. * @return Nearest best kernel.
  102663. */
  102664. protected _nearestBestKernel(idealKernel: number): number;
  102665. /**
  102666. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  102667. * @param x The point on the Gaussian distribution to sample.
  102668. * @return the value of the Gaussian function at x.
  102669. */
  102670. protected _gaussianWeight(x: number): number;
  102671. /**
  102672. * Generates a string that can be used as a floating point number in GLSL.
  102673. * @param x Value to print.
  102674. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  102675. * @return GLSL float string.
  102676. */
  102677. protected _glslFloat(x: number, decimalFigures?: number): string;
  102678. /** @hidden */
  102679. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  102680. }
  102681. }
  102682. declare module BABYLON {
  102683. /**
  102684. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102685. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102686. * You can then easily use it as a reflectionTexture on a flat surface.
  102687. * In case the surface is not a plane, please consider relying on reflection probes.
  102688. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102689. */
  102690. export class MirrorTexture extends RenderTargetTexture {
  102691. private scene;
  102692. /**
  102693. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  102694. * 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.
  102695. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102696. */
  102697. mirrorPlane: Plane;
  102698. /**
  102699. * Define the blur ratio used to blur the reflection if needed.
  102700. */
  102701. set blurRatio(value: number);
  102702. get blurRatio(): number;
  102703. /**
  102704. * Define the adaptive blur kernel used to blur the reflection if needed.
  102705. * This will autocompute the closest best match for the `blurKernel`
  102706. */
  102707. set adaptiveBlurKernel(value: number);
  102708. /**
  102709. * Define the blur kernel used to blur the reflection if needed.
  102710. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102711. */
  102712. set blurKernel(value: number);
  102713. /**
  102714. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  102715. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102716. */
  102717. set blurKernelX(value: number);
  102718. get blurKernelX(): number;
  102719. /**
  102720. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  102721. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102722. */
  102723. set blurKernelY(value: number);
  102724. get blurKernelY(): number;
  102725. private _autoComputeBlurKernel;
  102726. protected _onRatioRescale(): void;
  102727. private _updateGammaSpace;
  102728. private _imageProcessingConfigChangeObserver;
  102729. private _transformMatrix;
  102730. private _mirrorMatrix;
  102731. private _savedViewMatrix;
  102732. private _blurX;
  102733. private _blurY;
  102734. private _adaptiveBlurKernel;
  102735. private _blurKernelX;
  102736. private _blurKernelY;
  102737. private _blurRatio;
  102738. /**
  102739. * Instantiates a Mirror Texture.
  102740. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102741. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102742. * You can then easily use it as a reflectionTexture on a flat surface.
  102743. * In case the surface is not a plane, please consider relying on reflection probes.
  102744. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102745. * @param name
  102746. * @param size
  102747. * @param scene
  102748. * @param generateMipMaps
  102749. * @param type
  102750. * @param samplingMode
  102751. * @param generateDepthBuffer
  102752. */
  102753. constructor(name: string, size: number | {
  102754. width: number;
  102755. height: number;
  102756. } | {
  102757. ratio: number;
  102758. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  102759. private _preparePostProcesses;
  102760. /**
  102761. * Clone the mirror texture.
  102762. * @returns the cloned texture
  102763. */
  102764. clone(): MirrorTexture;
  102765. /**
  102766. * Serialize the texture to a JSON representation you could use in Parse later on
  102767. * @returns the serialized JSON representation
  102768. */
  102769. serialize(): any;
  102770. /**
  102771. * Dispose the texture and release its associated resources.
  102772. */
  102773. dispose(): void;
  102774. }
  102775. }
  102776. declare module BABYLON {
  102777. /**
  102778. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102779. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102780. */
  102781. export class Texture extends BaseTexture {
  102782. /**
  102783. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  102784. */
  102785. static SerializeBuffers: boolean;
  102786. /** @hidden */
  102787. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  102788. /** @hidden */
  102789. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  102790. /** @hidden */
  102791. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  102792. /** nearest is mag = nearest and min = nearest and mip = linear */
  102793. static readonly NEAREST_SAMPLINGMODE: number;
  102794. /** nearest is mag = nearest and min = nearest and mip = linear */
  102795. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  102796. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102797. static readonly BILINEAR_SAMPLINGMODE: number;
  102798. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102799. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  102800. /** Trilinear is mag = linear and min = linear and mip = linear */
  102801. static readonly TRILINEAR_SAMPLINGMODE: number;
  102802. /** Trilinear is mag = linear and min = linear and mip = linear */
  102803. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  102804. /** mag = nearest and min = nearest and mip = nearest */
  102805. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  102806. /** mag = nearest and min = linear and mip = nearest */
  102807. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  102808. /** mag = nearest and min = linear and mip = linear */
  102809. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  102810. /** mag = nearest and min = linear and mip = none */
  102811. static readonly NEAREST_LINEAR: number;
  102812. /** mag = nearest and min = nearest and mip = none */
  102813. static readonly NEAREST_NEAREST: number;
  102814. /** mag = linear and min = nearest and mip = nearest */
  102815. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  102816. /** mag = linear and min = nearest and mip = linear */
  102817. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  102818. /** mag = linear and min = linear and mip = none */
  102819. static readonly LINEAR_LINEAR: number;
  102820. /** mag = linear and min = nearest and mip = none */
  102821. static readonly LINEAR_NEAREST: number;
  102822. /** Explicit coordinates mode */
  102823. static readonly EXPLICIT_MODE: number;
  102824. /** Spherical coordinates mode */
  102825. static readonly SPHERICAL_MODE: number;
  102826. /** Planar coordinates mode */
  102827. static readonly PLANAR_MODE: number;
  102828. /** Cubic coordinates mode */
  102829. static readonly CUBIC_MODE: number;
  102830. /** Projection coordinates mode */
  102831. static readonly PROJECTION_MODE: number;
  102832. /** Inverse Cubic coordinates mode */
  102833. static readonly SKYBOX_MODE: number;
  102834. /** Inverse Cubic coordinates mode */
  102835. static readonly INVCUBIC_MODE: number;
  102836. /** Equirectangular coordinates mode */
  102837. static readonly EQUIRECTANGULAR_MODE: number;
  102838. /** Equirectangular Fixed coordinates mode */
  102839. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  102840. /** Equirectangular Fixed Mirrored coordinates mode */
  102841. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  102842. /** Texture is not repeating outside of 0..1 UVs */
  102843. static readonly CLAMP_ADDRESSMODE: number;
  102844. /** Texture is repeating outside of 0..1 UVs */
  102845. static readonly WRAP_ADDRESSMODE: number;
  102846. /** Texture is repeating and mirrored */
  102847. static readonly MIRROR_ADDRESSMODE: number;
  102848. /**
  102849. * 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
  102850. */
  102851. static UseSerializedUrlIfAny: boolean;
  102852. /**
  102853. * Define the url of the texture.
  102854. */
  102855. url: Nullable<string>;
  102856. /**
  102857. * Define an offset on the texture to offset the u coordinates of the UVs
  102858. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102859. */
  102860. uOffset: number;
  102861. /**
  102862. * Define an offset on the texture to offset the v coordinates of the UVs
  102863. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102864. */
  102865. vOffset: number;
  102866. /**
  102867. * Define an offset on the texture to scale the u coordinates of the UVs
  102868. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102869. */
  102870. uScale: number;
  102871. /**
  102872. * Define an offset on the texture to scale the v coordinates of the UVs
  102873. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102874. */
  102875. vScale: number;
  102876. /**
  102877. * Define an offset on the texture to rotate around the u coordinates of the UVs
  102878. * @see https://doc.babylonjs.com/how_to/more_materials
  102879. */
  102880. uAng: number;
  102881. /**
  102882. * Define an offset on the texture to rotate around the v coordinates of the UVs
  102883. * @see https://doc.babylonjs.com/how_to/more_materials
  102884. */
  102885. vAng: number;
  102886. /**
  102887. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  102888. * @see https://doc.babylonjs.com/how_to/more_materials
  102889. */
  102890. wAng: number;
  102891. /**
  102892. * Defines the center of rotation (U)
  102893. */
  102894. uRotationCenter: number;
  102895. /**
  102896. * Defines the center of rotation (V)
  102897. */
  102898. vRotationCenter: number;
  102899. /**
  102900. * Defines the center of rotation (W)
  102901. */
  102902. wRotationCenter: number;
  102903. /**
  102904. * Are mip maps generated for this texture or not.
  102905. */
  102906. get noMipmap(): boolean;
  102907. /**
  102908. * List of inspectable custom properties (used by the Inspector)
  102909. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102910. */
  102911. inspectableCustomProperties: Nullable<IInspectable[]>;
  102912. private _noMipmap;
  102913. /** @hidden */
  102914. _invertY: boolean;
  102915. private _rowGenerationMatrix;
  102916. private _cachedTextureMatrix;
  102917. private _projectionModeMatrix;
  102918. private _t0;
  102919. private _t1;
  102920. private _t2;
  102921. private _cachedUOffset;
  102922. private _cachedVOffset;
  102923. private _cachedUScale;
  102924. private _cachedVScale;
  102925. private _cachedUAng;
  102926. private _cachedVAng;
  102927. private _cachedWAng;
  102928. private _cachedProjectionMatrixId;
  102929. private _cachedCoordinatesMode;
  102930. /** @hidden */
  102931. protected _initialSamplingMode: number;
  102932. /** @hidden */
  102933. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  102934. private _deleteBuffer;
  102935. protected _format: Nullable<number>;
  102936. private _delayedOnLoad;
  102937. private _delayedOnError;
  102938. private _mimeType?;
  102939. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  102940. get mimeType(): string | undefined;
  102941. /**
  102942. * Observable triggered once the texture has been loaded.
  102943. */
  102944. onLoadObservable: Observable<Texture>;
  102945. protected _isBlocking: boolean;
  102946. /**
  102947. * Is the texture preventing material to render while loading.
  102948. * If false, a default texture will be used instead of the loading one during the preparation step.
  102949. */
  102950. set isBlocking(value: boolean);
  102951. get isBlocking(): boolean;
  102952. /**
  102953. * Get the current sampling mode associated with the texture.
  102954. */
  102955. get samplingMode(): number;
  102956. /**
  102957. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  102958. */
  102959. get invertY(): boolean;
  102960. /**
  102961. * Instantiates a new texture.
  102962. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102963. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102964. * @param url defines the url of the picture to load as a texture
  102965. * @param sceneOrEngine defines the scene or engine the texture will belong to
  102966. * @param noMipmap defines if the texture will require mip maps or not
  102967. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  102968. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  102969. * @param onLoad defines a callback triggered when the texture has been loaded
  102970. * @param onError defines a callback triggered when an error occurred during the loading session
  102971. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  102972. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  102973. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  102974. * @param mimeType defines an optional mime type information
  102975. */
  102976. 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);
  102977. /**
  102978. * Update the url (and optional buffer) of this texture if url was null during construction.
  102979. * @param url the url of the texture
  102980. * @param buffer the buffer of the texture (defaults to null)
  102981. * @param onLoad callback called when the texture is loaded (defaults to null)
  102982. */
  102983. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  102984. /**
  102985. * Finish the loading sequence of a texture flagged as delayed load.
  102986. * @hidden
  102987. */
  102988. delayLoad(): void;
  102989. private _prepareRowForTextureGeneration;
  102990. /**
  102991. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  102992. * @returns the transform matrix of the texture.
  102993. */
  102994. getTextureMatrix(uBase?: number): Matrix;
  102995. /**
  102996. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  102997. * @returns The reflection texture transform
  102998. */
  102999. getReflectionTextureMatrix(): Matrix;
  103000. /**
  103001. * Clones the texture.
  103002. * @returns the cloned texture
  103003. */
  103004. clone(): Texture;
  103005. /**
  103006. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103007. * @returns The JSON representation of the texture
  103008. */
  103009. serialize(): any;
  103010. /**
  103011. * Get the current class name of the texture useful for serialization or dynamic coding.
  103012. * @returns "Texture"
  103013. */
  103014. getClassName(): string;
  103015. /**
  103016. * Dispose the texture and release its associated resources.
  103017. */
  103018. dispose(): void;
  103019. /**
  103020. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  103021. * @param parsedTexture Define the JSON representation of the texture
  103022. * @param scene Define the scene the parsed texture should be instantiated in
  103023. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  103024. * @returns The parsed texture if successful
  103025. */
  103026. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  103027. /**
  103028. * Creates a texture from its base 64 representation.
  103029. * @param data Define the base64 payload without the data: prefix
  103030. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103031. * @param scene Define the scene the texture should belong to
  103032. * @param noMipmap Forces the texture to not create mip map information if true
  103033. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103034. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103035. * @param onLoad define a callback triggered when the texture has been loaded
  103036. * @param onError define a callback triggered when an error occurred during the loading session
  103037. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103038. * @returns the created texture
  103039. */
  103040. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  103041. /**
  103042. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  103043. * @param data Define the base64 payload without the data: prefix
  103044. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103045. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  103046. * @param scene Define the scene the texture should belong to
  103047. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  103048. * @param noMipmap Forces the texture to not create mip map information if true
  103049. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103050. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103051. * @param onLoad define a callback triggered when the texture has been loaded
  103052. * @param onError define a callback triggered when an error occurred during the loading session
  103053. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103054. * @returns the created texture
  103055. */
  103056. 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;
  103057. }
  103058. }
  103059. declare module BABYLON {
  103060. /**
  103061. * PostProcessManager is used to manage one or more post processes or post process pipelines
  103062. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  103063. */
  103064. export class PostProcessManager {
  103065. private _scene;
  103066. private _indexBuffer;
  103067. private _vertexBuffers;
  103068. /**
  103069. * Creates a new instance PostProcess
  103070. * @param scene The scene that the post process is associated with.
  103071. */
  103072. constructor(scene: Scene);
  103073. private _prepareBuffers;
  103074. private _buildIndexBuffer;
  103075. /**
  103076. * Rebuilds the vertex buffers of the manager.
  103077. * @hidden
  103078. */
  103079. _rebuild(): void;
  103080. /**
  103081. * Prepares a frame to be run through a post process.
  103082. * @param sourceTexture The input texture to the post procesess. (default: null)
  103083. * @param postProcesses An array of post processes to be run. (default: null)
  103084. * @returns True if the post processes were able to be run.
  103085. * @hidden
  103086. */
  103087. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  103088. /**
  103089. * Manually render a set of post processes to a texture.
  103090. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  103091. * @param postProcesses An array of post processes to be run.
  103092. * @param targetTexture The target texture to render to.
  103093. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  103094. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  103095. * @param lodLevel defines which lod of the texture to render to
  103096. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  103097. */
  103098. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  103099. /**
  103100. * Finalize the result of the output of the postprocesses.
  103101. * @param doNotPresent If true the result will not be displayed to the screen.
  103102. * @param targetTexture The target texture to render to.
  103103. * @param faceIndex The index of the face to bind the target texture to.
  103104. * @param postProcesses The array of post processes to render.
  103105. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  103106. * @hidden
  103107. */
  103108. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  103109. /**
  103110. * Disposes of the post process manager.
  103111. */
  103112. dispose(): void;
  103113. }
  103114. }
  103115. declare module BABYLON {
  103116. /**
  103117. * This Helps creating a texture that will be created from a camera in your scene.
  103118. * It is basically a dynamic texture that could be used to create special effects for instance.
  103119. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  103120. */
  103121. export class RenderTargetTexture extends Texture {
  103122. /**
  103123. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  103124. */
  103125. static readonly REFRESHRATE_RENDER_ONCE: number;
  103126. /**
  103127. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  103128. */
  103129. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  103130. /**
  103131. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  103132. * the central point of your effect and can save a lot of performances.
  103133. */
  103134. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  103135. /**
  103136. * Use this predicate to dynamically define the list of mesh you want to render.
  103137. * If set, the renderList property will be overwritten.
  103138. */
  103139. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  103140. private _renderList;
  103141. /**
  103142. * Use this list to define the list of mesh you want to render.
  103143. */
  103144. get renderList(): Nullable<Array<AbstractMesh>>;
  103145. set renderList(value: Nullable<Array<AbstractMesh>>);
  103146. /**
  103147. * Use this function to overload the renderList array at rendering time.
  103148. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  103149. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  103150. * the cube (if the RTT is a cube, else layerOrFace=0).
  103151. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  103152. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  103153. * hold dummy elements!
  103154. */
  103155. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  103156. private _hookArray;
  103157. /**
  103158. * Define if particles should be rendered in your texture.
  103159. */
  103160. renderParticles: boolean;
  103161. /**
  103162. * Define if sprites should be rendered in your texture.
  103163. */
  103164. renderSprites: boolean;
  103165. /**
  103166. * Define the camera used to render the texture.
  103167. */
  103168. activeCamera: Nullable<Camera>;
  103169. /**
  103170. * Override the mesh isReady function with your own one.
  103171. */
  103172. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  103173. /**
  103174. * Override the render function of the texture with your own one.
  103175. */
  103176. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  103177. /**
  103178. * Define if camera post processes should be use while rendering the texture.
  103179. */
  103180. useCameraPostProcesses: boolean;
  103181. /**
  103182. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  103183. */
  103184. ignoreCameraViewport: boolean;
  103185. private _postProcessManager;
  103186. private _postProcesses;
  103187. private _resizeObserver;
  103188. /**
  103189. * An event triggered when the texture is unbind.
  103190. */
  103191. onBeforeBindObservable: Observable<RenderTargetTexture>;
  103192. /**
  103193. * An event triggered when the texture is unbind.
  103194. */
  103195. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  103196. private _onAfterUnbindObserver;
  103197. /**
  103198. * Set a after unbind callback in the texture.
  103199. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  103200. */
  103201. set onAfterUnbind(callback: () => void);
  103202. /**
  103203. * An event triggered before rendering the texture
  103204. */
  103205. onBeforeRenderObservable: Observable<number>;
  103206. private _onBeforeRenderObserver;
  103207. /**
  103208. * Set a before render callback in the texture.
  103209. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  103210. */
  103211. set onBeforeRender(callback: (faceIndex: number) => void);
  103212. /**
  103213. * An event triggered after rendering the texture
  103214. */
  103215. onAfterRenderObservable: Observable<number>;
  103216. private _onAfterRenderObserver;
  103217. /**
  103218. * Set a after render callback in the texture.
  103219. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  103220. */
  103221. set onAfterRender(callback: (faceIndex: number) => void);
  103222. /**
  103223. * An event triggered after the texture clear
  103224. */
  103225. onClearObservable: Observable<Engine>;
  103226. private _onClearObserver;
  103227. /**
  103228. * Set a clear callback in the texture.
  103229. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  103230. */
  103231. set onClear(callback: (Engine: Engine) => void);
  103232. /**
  103233. * An event triggered when the texture is resized.
  103234. */
  103235. onResizeObservable: Observable<RenderTargetTexture>;
  103236. /**
  103237. * Define the clear color of the Render Target if it should be different from the scene.
  103238. */
  103239. clearColor: Color4;
  103240. protected _size: number | {
  103241. width: number;
  103242. height: number;
  103243. layers?: number;
  103244. };
  103245. protected _initialSizeParameter: number | {
  103246. width: number;
  103247. height: number;
  103248. } | {
  103249. ratio: number;
  103250. };
  103251. protected _sizeRatio: Nullable<number>;
  103252. /** @hidden */
  103253. _generateMipMaps: boolean;
  103254. protected _renderingManager: RenderingManager;
  103255. /** @hidden */
  103256. _waitingRenderList?: string[];
  103257. protected _doNotChangeAspectRatio: boolean;
  103258. protected _currentRefreshId: number;
  103259. protected _refreshRate: number;
  103260. protected _textureMatrix: Matrix;
  103261. protected _samples: number;
  103262. protected _renderTargetOptions: RenderTargetCreationOptions;
  103263. /**
  103264. * Gets render target creation options that were used.
  103265. */
  103266. get renderTargetOptions(): RenderTargetCreationOptions;
  103267. protected _onRatioRescale(): void;
  103268. /**
  103269. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  103270. * It must define where the camera used to render the texture is set
  103271. */
  103272. boundingBoxPosition: Vector3;
  103273. private _boundingBoxSize;
  103274. /**
  103275. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  103276. * When defined, the cubemap will switch to local mode
  103277. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  103278. * @example https://www.babylonjs-playground.com/#RNASML
  103279. */
  103280. set boundingBoxSize(value: Vector3);
  103281. get boundingBoxSize(): Vector3;
  103282. /**
  103283. * In case the RTT has been created with a depth texture, get the associated
  103284. * depth texture.
  103285. * Otherwise, return null.
  103286. */
  103287. get depthStencilTexture(): Nullable<InternalTexture>;
  103288. /**
  103289. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  103290. * or used a shadow, depth texture...
  103291. * @param name The friendly name of the texture
  103292. * @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)
  103293. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  103294. * @param generateMipMaps True if mip maps need to be generated after render.
  103295. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  103296. * @param type The type of the buffer in the RTT (int, half float, float...)
  103297. * @param isCube True if a cube texture needs to be created
  103298. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  103299. * @param generateDepthBuffer True to generate a depth buffer
  103300. * @param generateStencilBuffer True to generate a stencil buffer
  103301. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  103302. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  103303. * @param delayAllocation if the texture allocation should be delayed (default: false)
  103304. */
  103305. constructor(name: string, size: number | {
  103306. width: number;
  103307. height: number;
  103308. layers?: number;
  103309. } | {
  103310. ratio: number;
  103311. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  103312. /**
  103313. * Creates a depth stencil texture.
  103314. * This is only available in WebGL 2 or with the depth texture extension available.
  103315. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  103316. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  103317. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  103318. */
  103319. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  103320. private _processSizeParameter;
  103321. /**
  103322. * Define the number of samples to use in case of MSAA.
  103323. * It defaults to one meaning no MSAA has been enabled.
  103324. */
  103325. get samples(): number;
  103326. set samples(value: number);
  103327. /**
  103328. * Resets the refresh counter of the texture and start bak from scratch.
  103329. * Could be useful to regenerate the texture if it is setup to render only once.
  103330. */
  103331. resetRefreshCounter(): void;
  103332. /**
  103333. * Define the refresh rate of the texture or the rendering frequency.
  103334. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  103335. */
  103336. get refreshRate(): number;
  103337. set refreshRate(value: number);
  103338. /**
  103339. * Adds a post process to the render target rendering passes.
  103340. * @param postProcess define the post process to add
  103341. */
  103342. addPostProcess(postProcess: PostProcess): void;
  103343. /**
  103344. * Clear all the post processes attached to the render target
  103345. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  103346. */
  103347. clearPostProcesses(dispose?: boolean): void;
  103348. /**
  103349. * Remove one of the post process from the list of attached post processes to the texture
  103350. * @param postProcess define the post process to remove from the list
  103351. */
  103352. removePostProcess(postProcess: PostProcess): void;
  103353. /** @hidden */
  103354. _shouldRender(): boolean;
  103355. /**
  103356. * Gets the actual render size of the texture.
  103357. * @returns the width of the render size
  103358. */
  103359. getRenderSize(): number;
  103360. /**
  103361. * Gets the actual render width of the texture.
  103362. * @returns the width of the render size
  103363. */
  103364. getRenderWidth(): number;
  103365. /**
  103366. * Gets the actual render height of the texture.
  103367. * @returns the height of the render size
  103368. */
  103369. getRenderHeight(): number;
  103370. /**
  103371. * Gets the actual number of layers of the texture.
  103372. * @returns the number of layers
  103373. */
  103374. getRenderLayers(): number;
  103375. /**
  103376. * Get if the texture can be rescaled or not.
  103377. */
  103378. get canRescale(): boolean;
  103379. /**
  103380. * Resize the texture using a ratio.
  103381. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  103382. */
  103383. scale(ratio: number): void;
  103384. /**
  103385. * Get the texture reflection matrix used to rotate/transform the reflection.
  103386. * @returns the reflection matrix
  103387. */
  103388. getReflectionTextureMatrix(): Matrix;
  103389. /**
  103390. * Resize the texture to a new desired size.
  103391. * Be carrefull as it will recreate all the data in the new texture.
  103392. * @param size Define the new size. It can be:
  103393. * - a number for squared texture,
  103394. * - an object containing { width: number, height: number }
  103395. * - or an object containing a ratio { ratio: number }
  103396. */
  103397. resize(size: number | {
  103398. width: number;
  103399. height: number;
  103400. } | {
  103401. ratio: number;
  103402. }): void;
  103403. private _defaultRenderListPrepared;
  103404. /**
  103405. * Renders all the objects from the render list into the texture.
  103406. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  103407. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  103408. */
  103409. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  103410. private _bestReflectionRenderTargetDimension;
  103411. private _prepareRenderingManager;
  103412. /**
  103413. * @hidden
  103414. * @param faceIndex face index to bind to if this is a cubetexture
  103415. * @param layer defines the index of the texture to bind in the array
  103416. */
  103417. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  103418. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103419. private renderToTarget;
  103420. /**
  103421. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  103422. * This allowed control for front to back rendering or reversly depending of the special needs.
  103423. *
  103424. * @param renderingGroupId The rendering group id corresponding to its index
  103425. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  103426. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  103427. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  103428. */
  103429. 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;
  103430. /**
  103431. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  103432. *
  103433. * @param renderingGroupId The rendering group id corresponding to its index
  103434. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  103435. */
  103436. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  103437. /**
  103438. * Clones the texture.
  103439. * @returns the cloned texture
  103440. */
  103441. clone(): RenderTargetTexture;
  103442. /**
  103443. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103444. * @returns The JSON representation of the texture
  103445. */
  103446. serialize(): any;
  103447. /**
  103448. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  103449. */
  103450. disposeFramebufferObjects(): void;
  103451. /**
  103452. * Dispose the texture and release its associated resources.
  103453. */
  103454. dispose(): void;
  103455. /** @hidden */
  103456. _rebuild(): void;
  103457. /**
  103458. * Clear the info related to rendering groups preventing retention point in material dispose.
  103459. */
  103460. freeRenderingGroups(): void;
  103461. /**
  103462. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  103463. * @returns the view count
  103464. */
  103465. getViewCount(): number;
  103466. }
  103467. }
  103468. declare module BABYLON {
  103469. /**
  103470. * Class used to manipulate GUIDs
  103471. */
  103472. export class GUID {
  103473. /**
  103474. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  103475. * Be aware Math.random() could cause collisions, but:
  103476. * "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"
  103477. * @returns a pseudo random id
  103478. */
  103479. static RandomId(): string;
  103480. }
  103481. }
  103482. declare module BABYLON {
  103483. /**
  103484. * Options to be used when creating a shadow depth material
  103485. */
  103486. export interface IIOptionShadowDepthMaterial {
  103487. /** Variables in the vertex shader code that need to have their names remapped.
  103488. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  103489. * "var_name" should be either: worldPos or vNormalW
  103490. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  103491. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  103492. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  103493. */
  103494. remappedVariables?: string[];
  103495. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  103496. standalone?: boolean;
  103497. }
  103498. /**
  103499. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  103500. */
  103501. export class ShadowDepthWrapper {
  103502. private _scene;
  103503. private _options?;
  103504. private _baseMaterial;
  103505. private _onEffectCreatedObserver;
  103506. private _subMeshToEffect;
  103507. private _subMeshToDepthEffect;
  103508. private _meshes;
  103509. /** @hidden */
  103510. _matriceNames: any;
  103511. /** Gets the standalone status of the wrapper */
  103512. get standalone(): boolean;
  103513. /** Gets the base material the wrapper is built upon */
  103514. get baseMaterial(): Material;
  103515. /**
  103516. * Instantiate a new shadow depth wrapper.
  103517. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  103518. * generate the shadow depth map. For more information, please refer to the documentation:
  103519. * https://doc.babylonjs.com/babylon101/shadows
  103520. * @param baseMaterial Material to wrap
  103521. * @param scene Define the scene the material belongs to
  103522. * @param options Options used to create the wrapper
  103523. */
  103524. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  103525. /**
  103526. * Gets the effect to use to generate the depth map
  103527. * @param subMesh subMesh to get the effect for
  103528. * @param shadowGenerator shadow generator to get the effect for
  103529. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  103530. */
  103531. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  103532. /**
  103533. * Specifies that the submesh is ready to be used for depth rendering
  103534. * @param subMesh submesh to check
  103535. * @param defines the list of defines to take into account when checking the effect
  103536. * @param shadowGenerator combined with subMesh, it defines the effect to check
  103537. * @param useInstances specifies that instances should be used
  103538. * @returns a boolean indicating that the submesh is ready or not
  103539. */
  103540. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  103541. /**
  103542. * Disposes the resources
  103543. */
  103544. dispose(): void;
  103545. private _makeEffect;
  103546. }
  103547. }
  103548. declare module BABYLON {
  103549. interface ThinEngine {
  103550. /**
  103551. * Unbind a list of render target textures from the webGL context
  103552. * This is used only when drawBuffer extension or webGL2 are active
  103553. * @param textures defines the render target textures to unbind
  103554. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  103555. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  103556. */
  103557. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  103558. /**
  103559. * Create a multi render target texture
  103560. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  103561. * @param size defines the size of the texture
  103562. * @param options defines the creation options
  103563. * @returns the cube texture as an InternalTexture
  103564. */
  103565. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  103566. /**
  103567. * Update the sample count for a given multiple render target texture
  103568. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  103569. * @param textures defines the textures to update
  103570. * @param samples defines the sample count to set
  103571. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  103572. */
  103573. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  103574. /**
  103575. * Select a subsets of attachments to draw to.
  103576. * @param attachments gl attachments
  103577. */
  103578. bindAttachments(attachments: number[]): void;
  103579. }
  103580. }
  103581. declare module BABYLON {
  103582. /**
  103583. * Creation options of the multi render target texture.
  103584. */
  103585. export interface IMultiRenderTargetOptions {
  103586. /**
  103587. * Define if the texture needs to create mip maps after render.
  103588. */
  103589. generateMipMaps?: boolean;
  103590. /**
  103591. * Define the types of all the draw buffers we want to create
  103592. */
  103593. types?: number[];
  103594. /**
  103595. * Define the sampling modes of all the draw buffers we want to create
  103596. */
  103597. samplingModes?: number[];
  103598. /**
  103599. * Define if a depth buffer is required
  103600. */
  103601. generateDepthBuffer?: boolean;
  103602. /**
  103603. * Define if a stencil buffer is required
  103604. */
  103605. generateStencilBuffer?: boolean;
  103606. /**
  103607. * Define if a depth texture is required instead of a depth buffer
  103608. */
  103609. generateDepthTexture?: boolean;
  103610. /**
  103611. * Define the number of desired draw buffers
  103612. */
  103613. textureCount?: number;
  103614. /**
  103615. * Define if aspect ratio should be adapted to the texture or stay the scene one
  103616. */
  103617. doNotChangeAspectRatio?: boolean;
  103618. /**
  103619. * Define the default type of the buffers we are creating
  103620. */
  103621. defaultType?: number;
  103622. }
  103623. /**
  103624. * A multi render target, like a render target provides the ability to render to a texture.
  103625. * Unlike the render target, it can render to several draw buffers in one draw.
  103626. * This is specially interesting in deferred rendering or for any effects requiring more than
  103627. * just one color from a single pass.
  103628. */
  103629. export class MultiRenderTarget extends RenderTargetTexture {
  103630. private _internalTextures;
  103631. private _textures;
  103632. private _multiRenderTargetOptions;
  103633. private _count;
  103634. /**
  103635. * Get if draw buffers are currently supported by the used hardware and browser.
  103636. */
  103637. get isSupported(): boolean;
  103638. /**
  103639. * Get the list of textures generated by the multi render target.
  103640. */
  103641. get textures(): Texture[];
  103642. /**
  103643. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  103644. */
  103645. get count(): number;
  103646. /**
  103647. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  103648. */
  103649. get depthTexture(): Texture;
  103650. /**
  103651. * Set the wrapping mode on U of all the textures we are rendering to.
  103652. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103653. */
  103654. set wrapU(wrap: number);
  103655. /**
  103656. * Set the wrapping mode on V of all the textures we are rendering to.
  103657. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103658. */
  103659. set wrapV(wrap: number);
  103660. /**
  103661. * Instantiate a new multi render target texture.
  103662. * A multi render target, like a render target provides the ability to render to a texture.
  103663. * Unlike the render target, it can render to several draw buffers in one draw.
  103664. * This is specially interesting in deferred rendering or for any effects requiring more than
  103665. * just one color from a single pass.
  103666. * @param name Define the name of the texture
  103667. * @param size Define the size of the buffers to render to
  103668. * @param count Define the number of target we are rendering into
  103669. * @param scene Define the scene the texture belongs to
  103670. * @param options Define the options used to create the multi render target
  103671. */
  103672. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  103673. /** @hidden */
  103674. _rebuild(): void;
  103675. private _createInternalTextures;
  103676. private _createTextures;
  103677. /**
  103678. * Define the number of samples used if MSAA is enabled.
  103679. */
  103680. get samples(): number;
  103681. set samples(value: number);
  103682. /**
  103683. * Resize all the textures in the multi render target.
  103684. * Be carrefull as it will recreate all the data in the new texture.
  103685. * @param size Define the new size
  103686. */
  103687. resize(size: any): void;
  103688. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103689. /**
  103690. * Dispose the render targets and their associated resources
  103691. */
  103692. dispose(): void;
  103693. /**
  103694. * Release all the underlying texture used as draw buffers.
  103695. */
  103696. releaseInternalTextures(): void;
  103697. }
  103698. }
  103699. declare module BABYLON {
  103700. /** @hidden */
  103701. export var imageProcessingPixelShader: {
  103702. name: string;
  103703. shader: string;
  103704. };
  103705. }
  103706. declare module BABYLON {
  103707. /**
  103708. * ImageProcessingPostProcess
  103709. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  103710. */
  103711. export class ImageProcessingPostProcess extends PostProcess {
  103712. /**
  103713. * Default configuration related to image processing available in the PBR Material.
  103714. */
  103715. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  103716. /**
  103717. * Gets the image processing configuration used either in this material.
  103718. */
  103719. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  103720. /**
  103721. * Sets the Default image processing configuration used either in the this material.
  103722. *
  103723. * If sets to null, the scene one is in use.
  103724. */
  103725. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  103726. /**
  103727. * Keep track of the image processing observer to allow dispose and replace.
  103728. */
  103729. private _imageProcessingObserver;
  103730. /**
  103731. * Attaches a new image processing configuration to the PBR Material.
  103732. * @param configuration
  103733. */
  103734. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  103735. /**
  103736. * If the post process is supported.
  103737. */
  103738. get isSupported(): boolean;
  103739. /**
  103740. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103741. */
  103742. get colorCurves(): Nullable<ColorCurves>;
  103743. /**
  103744. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103745. */
  103746. set colorCurves(value: Nullable<ColorCurves>);
  103747. /**
  103748. * Gets wether the color curves effect is enabled.
  103749. */
  103750. get colorCurvesEnabled(): boolean;
  103751. /**
  103752. * Sets wether the color curves effect is enabled.
  103753. */
  103754. set colorCurvesEnabled(value: boolean);
  103755. /**
  103756. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103757. */
  103758. get colorGradingTexture(): Nullable<BaseTexture>;
  103759. /**
  103760. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103761. */
  103762. set colorGradingTexture(value: Nullable<BaseTexture>);
  103763. /**
  103764. * Gets wether the color grading effect is enabled.
  103765. */
  103766. get colorGradingEnabled(): boolean;
  103767. /**
  103768. * Gets wether the color grading effect is enabled.
  103769. */
  103770. set colorGradingEnabled(value: boolean);
  103771. /**
  103772. * Gets exposure used in the effect.
  103773. */
  103774. get exposure(): number;
  103775. /**
  103776. * Sets exposure used in the effect.
  103777. */
  103778. set exposure(value: number);
  103779. /**
  103780. * Gets wether tonemapping is enabled or not.
  103781. */
  103782. get toneMappingEnabled(): boolean;
  103783. /**
  103784. * Sets wether tonemapping is enabled or not
  103785. */
  103786. set toneMappingEnabled(value: boolean);
  103787. /**
  103788. * Gets the type of tone mapping effect.
  103789. */
  103790. get toneMappingType(): number;
  103791. /**
  103792. * Sets the type of tone mapping effect.
  103793. */
  103794. set toneMappingType(value: number);
  103795. /**
  103796. * Gets contrast used in the effect.
  103797. */
  103798. get contrast(): number;
  103799. /**
  103800. * Sets contrast used in the effect.
  103801. */
  103802. set contrast(value: number);
  103803. /**
  103804. * Gets Vignette stretch size.
  103805. */
  103806. get vignetteStretch(): number;
  103807. /**
  103808. * Sets Vignette stretch size.
  103809. */
  103810. set vignetteStretch(value: number);
  103811. /**
  103812. * Gets Vignette centre X Offset.
  103813. */
  103814. get vignetteCentreX(): number;
  103815. /**
  103816. * Sets Vignette centre X Offset.
  103817. */
  103818. set vignetteCentreX(value: number);
  103819. /**
  103820. * Gets Vignette centre Y Offset.
  103821. */
  103822. get vignetteCentreY(): number;
  103823. /**
  103824. * Sets Vignette centre Y Offset.
  103825. */
  103826. set vignetteCentreY(value: number);
  103827. /**
  103828. * Gets Vignette weight or intensity of the vignette effect.
  103829. */
  103830. get vignetteWeight(): number;
  103831. /**
  103832. * Sets Vignette weight or intensity of the vignette effect.
  103833. */
  103834. set vignetteWeight(value: number);
  103835. /**
  103836. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103837. * if vignetteEnabled is set to true.
  103838. */
  103839. get vignetteColor(): Color4;
  103840. /**
  103841. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103842. * if vignetteEnabled is set to true.
  103843. */
  103844. set vignetteColor(value: Color4);
  103845. /**
  103846. * Gets Camera field of view used by the Vignette effect.
  103847. */
  103848. get vignetteCameraFov(): number;
  103849. /**
  103850. * Sets Camera field of view used by the Vignette effect.
  103851. */
  103852. set vignetteCameraFov(value: number);
  103853. /**
  103854. * Gets the vignette blend mode allowing different kind of effect.
  103855. */
  103856. get vignetteBlendMode(): number;
  103857. /**
  103858. * Sets the vignette blend mode allowing different kind of effect.
  103859. */
  103860. set vignetteBlendMode(value: number);
  103861. /**
  103862. * Gets wether the vignette effect is enabled.
  103863. */
  103864. get vignetteEnabled(): boolean;
  103865. /**
  103866. * Sets wether the vignette effect is enabled.
  103867. */
  103868. set vignetteEnabled(value: boolean);
  103869. private _fromLinearSpace;
  103870. /**
  103871. * Gets wether the input of the processing is in Gamma or Linear Space.
  103872. */
  103873. get fromLinearSpace(): boolean;
  103874. /**
  103875. * Sets wether the input of the processing is in Gamma or Linear Space.
  103876. */
  103877. set fromLinearSpace(value: boolean);
  103878. /**
  103879. * Defines cache preventing GC.
  103880. */
  103881. private _defines;
  103882. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  103883. /**
  103884. * "ImageProcessingPostProcess"
  103885. * @returns "ImageProcessingPostProcess"
  103886. */
  103887. getClassName(): string;
  103888. /**
  103889. * @hidden
  103890. */
  103891. _updateParameters(): void;
  103892. dispose(camera?: Camera): void;
  103893. }
  103894. }
  103895. declare module BABYLON {
  103896. /** @hidden */
  103897. export var fibonacci: {
  103898. name: string;
  103899. shader: string;
  103900. };
  103901. }
  103902. declare module BABYLON {
  103903. /** @hidden */
  103904. export var subSurfaceScatteringFunctions: {
  103905. name: string;
  103906. shader: string;
  103907. };
  103908. }
  103909. declare module BABYLON {
  103910. /** @hidden */
  103911. export var diffusionProfile: {
  103912. name: string;
  103913. shader: string;
  103914. };
  103915. }
  103916. declare module BABYLON {
  103917. /** @hidden */
  103918. export var subSurfaceScatteringPixelShader: {
  103919. name: string;
  103920. shader: string;
  103921. };
  103922. }
  103923. declare module BABYLON {
  103924. /**
  103925. * Sub surface scattering post process
  103926. */
  103927. export class SubSurfaceScatteringPostProcess extends PostProcess {
  103928. /**
  103929. * Gets a string identifying the name of the class
  103930. * @returns "SubSurfaceScatteringPostProcess" string
  103931. */
  103932. getClassName(): string;
  103933. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  103934. }
  103935. }
  103936. declare module BABYLON {
  103937. /**
  103938. * Interface for defining prepass effects in the prepass post-process pipeline
  103939. */
  103940. export interface PrePassEffectConfiguration {
  103941. /**
  103942. * Post process to attach for this effect
  103943. */
  103944. postProcess: PostProcess;
  103945. /**
  103946. * Is the effect enabled
  103947. */
  103948. enabled: boolean;
  103949. /**
  103950. * Disposes the effect configuration
  103951. */
  103952. dispose(): void;
  103953. /**
  103954. * Disposes the effect configuration
  103955. */
  103956. createPostProcess: () => PostProcess;
  103957. }
  103958. }
  103959. declare module BABYLON {
  103960. /**
  103961. * Contains all parameters needed for the prepass to perform
  103962. * screen space subsurface scattering
  103963. */
  103964. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  103965. private _ssDiffusionS;
  103966. private _ssFilterRadii;
  103967. private _ssDiffusionD;
  103968. /**
  103969. * Post process to attach for screen space subsurface scattering
  103970. */
  103971. postProcess: SubSurfaceScatteringPostProcess;
  103972. /**
  103973. * Diffusion profile color for subsurface scattering
  103974. */
  103975. get ssDiffusionS(): number[];
  103976. /**
  103977. * Diffusion profile max color channel value for subsurface scattering
  103978. */
  103979. get ssDiffusionD(): number[];
  103980. /**
  103981. * Diffusion profile filter radius for subsurface scattering
  103982. */
  103983. get ssFilterRadii(): number[];
  103984. /**
  103985. * Is subsurface enabled
  103986. */
  103987. enabled: boolean;
  103988. /**
  103989. * Diffusion profile colors for subsurface scattering
  103990. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  103991. * See ...
  103992. * Note that you can only store up to 5 of them
  103993. */
  103994. ssDiffusionProfileColors: Color3[];
  103995. /**
  103996. * Defines the ratio real world => scene units.
  103997. * Used for subsurface scattering
  103998. */
  103999. metersPerUnit: number;
  104000. private _scene;
  104001. /**
  104002. * Builds a subsurface configuration object
  104003. * @param scene The scene
  104004. */
  104005. constructor(scene: Scene);
  104006. /**
  104007. * Adds a new diffusion profile.
  104008. * Useful for more realistic subsurface scattering on diverse materials.
  104009. * @param color The color of the diffusion profile. Should be the average color of the material.
  104010. * @return The index of the diffusion profile for the material subsurface configuration
  104011. */
  104012. addDiffusionProfile(color: Color3): number;
  104013. /**
  104014. * Creates the sss post process
  104015. * @return The created post process
  104016. */
  104017. createPostProcess(): SubSurfaceScatteringPostProcess;
  104018. /**
  104019. * Deletes all diffusion profiles.
  104020. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  104021. */
  104022. clearAllDiffusionProfiles(): void;
  104023. /**
  104024. * Disposes this object
  104025. */
  104026. dispose(): void;
  104027. /**
  104028. * @hidden
  104029. * https://zero-radiance.github.io/post/sampling-diffusion/
  104030. *
  104031. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  104032. * ------------------------------------------------------------------------------------
  104033. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  104034. * PDF[r, phi, s] = r * R[r, phi, s]
  104035. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  104036. * ------------------------------------------------------------------------------------
  104037. * We importance sample the color channel with the widest scattering distance.
  104038. */
  104039. getDiffusionProfileParameters(color: Color3): number;
  104040. /**
  104041. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  104042. * 'u' is the random number (the value of the CDF): [0, 1).
  104043. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  104044. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  104045. */
  104046. private _sampleBurleyDiffusionProfile;
  104047. }
  104048. }
  104049. declare module BABYLON {
  104050. /**
  104051. * Renders a pre pass of the scene
  104052. * This means every mesh in the scene will be rendered to a render target texture
  104053. * And then this texture will be composited to the rendering canvas with post processes
  104054. * It is necessary for effects like subsurface scattering or deferred shading
  104055. */
  104056. export class PrePassRenderer {
  104057. /** @hidden */
  104058. static _SceneComponentInitialization: (scene: Scene) => void;
  104059. private _scene;
  104060. private _engine;
  104061. private _isDirty;
  104062. /**
  104063. * Number of textures in the multi render target texture where the scene is directly rendered
  104064. */
  104065. readonly mrtCount: number;
  104066. /**
  104067. * The render target where the scene is directly rendered
  104068. */
  104069. prePassRT: MultiRenderTarget;
  104070. private _mrtTypes;
  104071. private _multiRenderAttachments;
  104072. private _defaultAttachments;
  104073. private _clearAttachments;
  104074. private _postProcesses;
  104075. private readonly _clearColor;
  104076. /**
  104077. * Image processing post process for composition
  104078. */
  104079. imageProcessingPostProcess: ImageProcessingPostProcess;
  104080. /**
  104081. * Configuration for sub surface scattering post process
  104082. */
  104083. subSurfaceConfiguration: SubSurfaceConfiguration;
  104084. /**
  104085. * Should materials render their geometry on the MRT
  104086. */
  104087. materialsShouldRenderGeometry: boolean;
  104088. /**
  104089. * Should materials render the irradiance information on the MRT
  104090. */
  104091. materialsShouldRenderIrradiance: boolean;
  104092. private _enabled;
  104093. /**
  104094. * Indicates if the prepass is enabled
  104095. */
  104096. get enabled(): boolean;
  104097. /**
  104098. * How many samples are used for MSAA of the scene render target
  104099. */
  104100. get samples(): number;
  104101. set samples(n: number);
  104102. /**
  104103. * Instanciates a prepass renderer
  104104. * @param scene The scene
  104105. */
  104106. constructor(scene: Scene);
  104107. private _initializeAttachments;
  104108. private _createCompositionEffect;
  104109. /**
  104110. * Indicates if rendering a prepass is supported
  104111. */
  104112. get isSupported(): boolean;
  104113. /**
  104114. * Sets the proper output textures to draw in the engine.
  104115. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  104116. */
  104117. bindAttachmentsForEffect(effect: Effect): void;
  104118. /**
  104119. * @hidden
  104120. */
  104121. _beforeCameraDraw(): void;
  104122. /**
  104123. * @hidden
  104124. */
  104125. _afterCameraDraw(): void;
  104126. private _checkRTSize;
  104127. private _bindFrameBuffer;
  104128. /**
  104129. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  104130. */
  104131. clear(): void;
  104132. private _setState;
  104133. private _enable;
  104134. private _disable;
  104135. private _resetPostProcessChain;
  104136. private _bindPostProcessChain;
  104137. /**
  104138. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  104139. */
  104140. markAsDirty(): void;
  104141. private _update;
  104142. /**
  104143. * Disposes the prepass renderer.
  104144. */
  104145. dispose(): void;
  104146. }
  104147. }
  104148. declare module BABYLON {
  104149. /**
  104150. * Options for compiling materials.
  104151. */
  104152. export interface IMaterialCompilationOptions {
  104153. /**
  104154. * Defines whether clip planes are enabled.
  104155. */
  104156. clipPlane: boolean;
  104157. /**
  104158. * Defines whether instances are enabled.
  104159. */
  104160. useInstances: boolean;
  104161. }
  104162. /**
  104163. * Options passed when calling customShaderNameResolve
  104164. */
  104165. export interface ICustomShaderNameResolveOptions {
  104166. /**
  104167. * 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
  104168. */
  104169. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  104170. }
  104171. /**
  104172. * Base class for the main features of a material in Babylon.js
  104173. */
  104174. export class Material implements IAnimatable {
  104175. /**
  104176. * Returns the triangle fill mode
  104177. */
  104178. static readonly TriangleFillMode: number;
  104179. /**
  104180. * Returns the wireframe mode
  104181. */
  104182. static readonly WireFrameFillMode: number;
  104183. /**
  104184. * Returns the point fill mode
  104185. */
  104186. static readonly PointFillMode: number;
  104187. /**
  104188. * Returns the point list draw mode
  104189. */
  104190. static readonly PointListDrawMode: number;
  104191. /**
  104192. * Returns the line list draw mode
  104193. */
  104194. static readonly LineListDrawMode: number;
  104195. /**
  104196. * Returns the line loop draw mode
  104197. */
  104198. static readonly LineLoopDrawMode: number;
  104199. /**
  104200. * Returns the line strip draw mode
  104201. */
  104202. static readonly LineStripDrawMode: number;
  104203. /**
  104204. * Returns the triangle strip draw mode
  104205. */
  104206. static readonly TriangleStripDrawMode: number;
  104207. /**
  104208. * Returns the triangle fan draw mode
  104209. */
  104210. static readonly TriangleFanDrawMode: number;
  104211. /**
  104212. * Stores the clock-wise side orientation
  104213. */
  104214. static readonly ClockWiseSideOrientation: number;
  104215. /**
  104216. * Stores the counter clock-wise side orientation
  104217. */
  104218. static readonly CounterClockWiseSideOrientation: number;
  104219. /**
  104220. * The dirty texture flag value
  104221. */
  104222. static readonly TextureDirtyFlag: number;
  104223. /**
  104224. * The dirty light flag value
  104225. */
  104226. static readonly LightDirtyFlag: number;
  104227. /**
  104228. * The dirty fresnel flag value
  104229. */
  104230. static readonly FresnelDirtyFlag: number;
  104231. /**
  104232. * The dirty attribute flag value
  104233. */
  104234. static readonly AttributesDirtyFlag: number;
  104235. /**
  104236. * The dirty misc flag value
  104237. */
  104238. static readonly MiscDirtyFlag: number;
  104239. /**
  104240. * The all dirty flag value
  104241. */
  104242. static readonly AllDirtyFlag: number;
  104243. /**
  104244. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  104245. */
  104246. static readonly MATERIAL_OPAQUE: number;
  104247. /**
  104248. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  104249. */
  104250. static readonly MATERIAL_ALPHATEST: number;
  104251. /**
  104252. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104253. */
  104254. static readonly MATERIAL_ALPHABLEND: number;
  104255. /**
  104256. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104257. * They are also discarded below the alpha cutoff threshold to improve performances.
  104258. */
  104259. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  104260. /**
  104261. * The Whiteout method is used to blend normals.
  104262. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104263. */
  104264. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  104265. /**
  104266. * The Reoriented Normal Mapping method is used to blend normals.
  104267. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104268. */
  104269. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  104270. /**
  104271. * Custom callback helping to override the default shader used in the material.
  104272. */
  104273. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  104274. /**
  104275. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  104276. */
  104277. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  104278. /**
  104279. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  104280. * This means that the material can keep using a previous shader while a new one is being compiled.
  104281. * This is mostly used when shader parallel compilation is supported (true by default)
  104282. */
  104283. allowShaderHotSwapping: boolean;
  104284. /**
  104285. * The ID of the material
  104286. */
  104287. id: string;
  104288. /**
  104289. * Gets or sets the unique id of the material
  104290. */
  104291. uniqueId: number;
  104292. /**
  104293. * The name of the material
  104294. */
  104295. name: string;
  104296. /**
  104297. * Gets or sets user defined metadata
  104298. */
  104299. metadata: any;
  104300. /**
  104301. * For internal use only. Please do not use.
  104302. */
  104303. reservedDataStore: any;
  104304. /**
  104305. * Specifies if the ready state should be checked on each call
  104306. */
  104307. checkReadyOnEveryCall: boolean;
  104308. /**
  104309. * Specifies if the ready state should be checked once
  104310. */
  104311. checkReadyOnlyOnce: boolean;
  104312. /**
  104313. * The state of the material
  104314. */
  104315. state: string;
  104316. /**
  104317. * If the material can be rendered to several textures with MRT extension
  104318. */
  104319. get canRenderToMRT(): boolean;
  104320. /**
  104321. * The alpha value of the material
  104322. */
  104323. protected _alpha: number;
  104324. /**
  104325. * List of inspectable custom properties (used by the Inspector)
  104326. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  104327. */
  104328. inspectableCustomProperties: IInspectable[];
  104329. /**
  104330. * Sets the alpha value of the material
  104331. */
  104332. set alpha(value: number);
  104333. /**
  104334. * Gets the alpha value of the material
  104335. */
  104336. get alpha(): number;
  104337. /**
  104338. * Specifies if back face culling is enabled
  104339. */
  104340. protected _backFaceCulling: boolean;
  104341. /**
  104342. * Sets the back-face culling state
  104343. */
  104344. set backFaceCulling(value: boolean);
  104345. /**
  104346. * Gets the back-face culling state
  104347. */
  104348. get backFaceCulling(): boolean;
  104349. /**
  104350. * Stores the value for side orientation
  104351. */
  104352. sideOrientation: number;
  104353. /**
  104354. * Callback triggered when the material is compiled
  104355. */
  104356. onCompiled: Nullable<(effect: Effect) => void>;
  104357. /**
  104358. * Callback triggered when an error occurs
  104359. */
  104360. onError: Nullable<(effect: Effect, errors: string) => void>;
  104361. /**
  104362. * Callback triggered to get the render target textures
  104363. */
  104364. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  104365. /**
  104366. * Gets a boolean indicating that current material needs to register RTT
  104367. */
  104368. get hasRenderTargetTextures(): boolean;
  104369. /**
  104370. * Specifies if the material should be serialized
  104371. */
  104372. doNotSerialize: boolean;
  104373. /**
  104374. * @hidden
  104375. */
  104376. _storeEffectOnSubMeshes: boolean;
  104377. /**
  104378. * Stores the animations for the material
  104379. */
  104380. animations: Nullable<Array<Animation>>;
  104381. /**
  104382. * An event triggered when the material is disposed
  104383. */
  104384. onDisposeObservable: Observable<Material>;
  104385. /**
  104386. * An observer which watches for dispose events
  104387. */
  104388. private _onDisposeObserver;
  104389. private _onUnBindObservable;
  104390. /**
  104391. * Called during a dispose event
  104392. */
  104393. set onDispose(callback: () => void);
  104394. private _onBindObservable;
  104395. /**
  104396. * An event triggered when the material is bound
  104397. */
  104398. get onBindObservable(): Observable<AbstractMesh>;
  104399. /**
  104400. * An observer which watches for bind events
  104401. */
  104402. private _onBindObserver;
  104403. /**
  104404. * Called during a bind event
  104405. */
  104406. set onBind(callback: (Mesh: AbstractMesh) => void);
  104407. /**
  104408. * An event triggered when the material is unbound
  104409. */
  104410. get onUnBindObservable(): Observable<Material>;
  104411. protected _onEffectCreatedObservable: Nullable<Observable<{
  104412. effect: Effect;
  104413. subMesh: Nullable<SubMesh>;
  104414. }>>;
  104415. /**
  104416. * An event triggered when the effect is (re)created
  104417. */
  104418. get onEffectCreatedObservable(): Observable<{
  104419. effect: Effect;
  104420. subMesh: Nullable<SubMesh>;
  104421. }>;
  104422. /**
  104423. * Stores the value of the alpha mode
  104424. */
  104425. private _alphaMode;
  104426. /**
  104427. * Sets the value of the alpha mode.
  104428. *
  104429. * | Value | Type | Description |
  104430. * | --- | --- | --- |
  104431. * | 0 | ALPHA_DISABLE | |
  104432. * | 1 | ALPHA_ADD | |
  104433. * | 2 | ALPHA_COMBINE | |
  104434. * | 3 | ALPHA_SUBTRACT | |
  104435. * | 4 | ALPHA_MULTIPLY | |
  104436. * | 5 | ALPHA_MAXIMIZED | |
  104437. * | 6 | ALPHA_ONEONE | |
  104438. * | 7 | ALPHA_PREMULTIPLIED | |
  104439. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  104440. * | 9 | ALPHA_INTERPOLATE | |
  104441. * | 10 | ALPHA_SCREENMODE | |
  104442. *
  104443. */
  104444. set alphaMode(value: number);
  104445. /**
  104446. * Gets the value of the alpha mode
  104447. */
  104448. get alphaMode(): number;
  104449. /**
  104450. * Stores the state of the need depth pre-pass value
  104451. */
  104452. private _needDepthPrePass;
  104453. /**
  104454. * Sets the need depth pre-pass value
  104455. */
  104456. set needDepthPrePass(value: boolean);
  104457. /**
  104458. * Gets the depth pre-pass value
  104459. */
  104460. get needDepthPrePass(): boolean;
  104461. /**
  104462. * Specifies if depth writing should be disabled
  104463. */
  104464. disableDepthWrite: boolean;
  104465. /**
  104466. * Specifies if color writing should be disabled
  104467. */
  104468. disableColorWrite: boolean;
  104469. /**
  104470. * Specifies if depth writing should be forced
  104471. */
  104472. forceDepthWrite: boolean;
  104473. /**
  104474. * Specifies the depth function that should be used. 0 means the default engine function
  104475. */
  104476. depthFunction: number;
  104477. /**
  104478. * Specifies if there should be a separate pass for culling
  104479. */
  104480. separateCullingPass: boolean;
  104481. /**
  104482. * Stores the state specifing if fog should be enabled
  104483. */
  104484. private _fogEnabled;
  104485. /**
  104486. * Sets the state for enabling fog
  104487. */
  104488. set fogEnabled(value: boolean);
  104489. /**
  104490. * Gets the value of the fog enabled state
  104491. */
  104492. get fogEnabled(): boolean;
  104493. /**
  104494. * Stores the size of points
  104495. */
  104496. pointSize: number;
  104497. /**
  104498. * Stores the z offset value
  104499. */
  104500. zOffset: number;
  104501. get wireframe(): boolean;
  104502. /**
  104503. * Sets the state of wireframe mode
  104504. */
  104505. set wireframe(value: boolean);
  104506. /**
  104507. * Gets the value specifying if point clouds are enabled
  104508. */
  104509. get pointsCloud(): boolean;
  104510. /**
  104511. * Sets the state of point cloud mode
  104512. */
  104513. set pointsCloud(value: boolean);
  104514. /**
  104515. * Gets the material fill mode
  104516. */
  104517. get fillMode(): number;
  104518. /**
  104519. * Sets the material fill mode
  104520. */
  104521. set fillMode(value: number);
  104522. /**
  104523. * @hidden
  104524. * Stores the effects for the material
  104525. */
  104526. _effect: Nullable<Effect>;
  104527. /**
  104528. * Specifies if uniform buffers should be used
  104529. */
  104530. private _useUBO;
  104531. /**
  104532. * Stores a reference to the scene
  104533. */
  104534. private _scene;
  104535. /**
  104536. * Stores the fill mode state
  104537. */
  104538. private _fillMode;
  104539. /**
  104540. * Specifies if the depth write state should be cached
  104541. */
  104542. private _cachedDepthWriteState;
  104543. /**
  104544. * Specifies if the color write state should be cached
  104545. */
  104546. private _cachedColorWriteState;
  104547. /**
  104548. * Specifies if the depth function state should be cached
  104549. */
  104550. private _cachedDepthFunctionState;
  104551. /**
  104552. * Stores the uniform buffer
  104553. */
  104554. protected _uniformBuffer: UniformBuffer;
  104555. /** @hidden */
  104556. _indexInSceneMaterialArray: number;
  104557. /** @hidden */
  104558. meshMap: Nullable<{
  104559. [id: string]: AbstractMesh | undefined;
  104560. }>;
  104561. /**
  104562. * Creates a material instance
  104563. * @param name defines the name of the material
  104564. * @param scene defines the scene to reference
  104565. * @param doNotAdd specifies if the material should be added to the scene
  104566. */
  104567. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  104568. /**
  104569. * Returns a string representation of the current material
  104570. * @param fullDetails defines a boolean indicating which levels of logging is desired
  104571. * @returns a string with material information
  104572. */
  104573. toString(fullDetails?: boolean): string;
  104574. /**
  104575. * Gets the class name of the material
  104576. * @returns a string with the class name of the material
  104577. */
  104578. getClassName(): string;
  104579. /**
  104580. * Specifies if updates for the material been locked
  104581. */
  104582. get isFrozen(): boolean;
  104583. /**
  104584. * Locks updates for the material
  104585. */
  104586. freeze(): void;
  104587. /**
  104588. * Unlocks updates for the material
  104589. */
  104590. unfreeze(): void;
  104591. /**
  104592. * Specifies if the material is ready to be used
  104593. * @param mesh defines the mesh to check
  104594. * @param useInstances specifies if instances should be used
  104595. * @returns a boolean indicating if the material is ready to be used
  104596. */
  104597. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  104598. /**
  104599. * Specifies that the submesh is ready to be used
  104600. * @param mesh defines the mesh to check
  104601. * @param subMesh defines which submesh to check
  104602. * @param useInstances specifies that instances should be used
  104603. * @returns a boolean indicating that the submesh is ready or not
  104604. */
  104605. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104606. /**
  104607. * Returns the material effect
  104608. * @returns the effect associated with the material
  104609. */
  104610. getEffect(): Nullable<Effect>;
  104611. /**
  104612. * Returns the current scene
  104613. * @returns a Scene
  104614. */
  104615. getScene(): Scene;
  104616. /**
  104617. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  104618. */
  104619. protected _forceAlphaTest: boolean;
  104620. /**
  104621. * The transparency mode of the material.
  104622. */
  104623. protected _transparencyMode: Nullable<number>;
  104624. /**
  104625. * Gets the current transparency mode.
  104626. */
  104627. get transparencyMode(): Nullable<number>;
  104628. /**
  104629. * Sets the transparency mode of the material.
  104630. *
  104631. * | Value | Type | Description |
  104632. * | ----- | ----------------------------------- | ----------- |
  104633. * | 0 | OPAQUE | |
  104634. * | 1 | ALPHATEST | |
  104635. * | 2 | ALPHABLEND | |
  104636. * | 3 | ALPHATESTANDBLEND | |
  104637. *
  104638. */
  104639. set transparencyMode(value: Nullable<number>);
  104640. /**
  104641. * Returns true if alpha blending should be disabled.
  104642. */
  104643. protected get _disableAlphaBlending(): boolean;
  104644. /**
  104645. * Specifies whether or not this material should be rendered in alpha blend mode.
  104646. * @returns a boolean specifying if alpha blending is needed
  104647. */
  104648. needAlphaBlending(): boolean;
  104649. /**
  104650. * Specifies if the mesh will require alpha blending
  104651. * @param mesh defines the mesh to check
  104652. * @returns a boolean specifying if alpha blending is needed for the mesh
  104653. */
  104654. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  104655. /**
  104656. * Specifies whether or not this material should be rendered in alpha test mode.
  104657. * @returns a boolean specifying if an alpha test is needed.
  104658. */
  104659. needAlphaTesting(): boolean;
  104660. /**
  104661. * Specifies if material alpha testing should be turned on for the mesh
  104662. * @param mesh defines the mesh to check
  104663. */
  104664. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  104665. /**
  104666. * Gets the texture used for the alpha test
  104667. * @returns the texture to use for alpha testing
  104668. */
  104669. getAlphaTestTexture(): Nullable<BaseTexture>;
  104670. /**
  104671. * Marks the material to indicate that it needs to be re-calculated
  104672. */
  104673. markDirty(): void;
  104674. /** @hidden */
  104675. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  104676. /**
  104677. * Binds the material to the mesh
  104678. * @param world defines the world transformation matrix
  104679. * @param mesh defines the mesh to bind the material to
  104680. */
  104681. bind(world: Matrix, mesh?: Mesh): void;
  104682. /**
  104683. * Binds the submesh to the material
  104684. * @param world defines the world transformation matrix
  104685. * @param mesh defines the mesh containing the submesh
  104686. * @param subMesh defines the submesh to bind the material to
  104687. */
  104688. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  104689. /**
  104690. * Binds the world matrix to the material
  104691. * @param world defines the world transformation matrix
  104692. */
  104693. bindOnlyWorldMatrix(world: Matrix): void;
  104694. /**
  104695. * Binds the scene's uniform buffer to the effect.
  104696. * @param effect defines the effect to bind to the scene uniform buffer
  104697. * @param sceneUbo defines the uniform buffer storing scene data
  104698. */
  104699. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  104700. /**
  104701. * Binds the view matrix to the effect
  104702. * @param effect defines the effect to bind the view matrix to
  104703. */
  104704. bindView(effect: Effect): void;
  104705. /**
  104706. * Binds the view projection matrix to the effect
  104707. * @param effect defines the effect to bind the view projection matrix to
  104708. */
  104709. bindViewProjection(effect: Effect): void;
  104710. /**
  104711. * Processes to execute after binding the material to a mesh
  104712. * @param mesh defines the rendered mesh
  104713. */
  104714. protected _afterBind(mesh?: Mesh): void;
  104715. /**
  104716. * Unbinds the material from the mesh
  104717. */
  104718. unbind(): void;
  104719. /**
  104720. * Gets the active textures from the material
  104721. * @returns an array of textures
  104722. */
  104723. getActiveTextures(): BaseTexture[];
  104724. /**
  104725. * Specifies if the material uses a texture
  104726. * @param texture defines the texture to check against the material
  104727. * @returns a boolean specifying if the material uses the texture
  104728. */
  104729. hasTexture(texture: BaseTexture): boolean;
  104730. /**
  104731. * Makes a duplicate of the material, and gives it a new name
  104732. * @param name defines the new name for the duplicated material
  104733. * @returns the cloned material
  104734. */
  104735. clone(name: string): Nullable<Material>;
  104736. /**
  104737. * Gets the meshes bound to the material
  104738. * @returns an array of meshes bound to the material
  104739. */
  104740. getBindedMeshes(): AbstractMesh[];
  104741. /**
  104742. * Force shader compilation
  104743. * @param mesh defines the mesh associated with this material
  104744. * @param onCompiled defines a function to execute once the material is compiled
  104745. * @param options defines the options to configure the compilation
  104746. * @param onError defines a function to execute if the material fails compiling
  104747. */
  104748. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  104749. /**
  104750. * Force shader compilation
  104751. * @param mesh defines the mesh that will use this material
  104752. * @param options defines additional options for compiling the shaders
  104753. * @returns a promise that resolves when the compilation completes
  104754. */
  104755. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  104756. private static readonly _AllDirtyCallBack;
  104757. private static readonly _ImageProcessingDirtyCallBack;
  104758. private static readonly _TextureDirtyCallBack;
  104759. private static readonly _FresnelDirtyCallBack;
  104760. private static readonly _MiscDirtyCallBack;
  104761. private static readonly _LightsDirtyCallBack;
  104762. private static readonly _AttributeDirtyCallBack;
  104763. private static _FresnelAndMiscDirtyCallBack;
  104764. private static _TextureAndMiscDirtyCallBack;
  104765. private static readonly _DirtyCallbackArray;
  104766. private static readonly _RunDirtyCallBacks;
  104767. /**
  104768. * Marks a define in the material to indicate that it needs to be re-computed
  104769. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  104770. */
  104771. markAsDirty(flag: number): void;
  104772. /**
  104773. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  104774. * @param func defines a function which checks material defines against the submeshes
  104775. */
  104776. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  104777. /**
  104778. * Indicates that the scene should check if the rendering now needs a prepass
  104779. */
  104780. protected _markScenePrePassDirty(): void;
  104781. /**
  104782. * Indicates that we need to re-calculated for all submeshes
  104783. */
  104784. protected _markAllSubMeshesAsAllDirty(): void;
  104785. /**
  104786. * Indicates that image processing needs to be re-calculated for all submeshes
  104787. */
  104788. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  104789. /**
  104790. * Indicates that textures need to be re-calculated for all submeshes
  104791. */
  104792. protected _markAllSubMeshesAsTexturesDirty(): void;
  104793. /**
  104794. * Indicates that fresnel needs to be re-calculated for all submeshes
  104795. */
  104796. protected _markAllSubMeshesAsFresnelDirty(): void;
  104797. /**
  104798. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  104799. */
  104800. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  104801. /**
  104802. * Indicates that lights need to be re-calculated for all submeshes
  104803. */
  104804. protected _markAllSubMeshesAsLightsDirty(): void;
  104805. /**
  104806. * Indicates that attributes need to be re-calculated for all submeshes
  104807. */
  104808. protected _markAllSubMeshesAsAttributesDirty(): void;
  104809. /**
  104810. * Indicates that misc needs to be re-calculated for all submeshes
  104811. */
  104812. protected _markAllSubMeshesAsMiscDirty(): void;
  104813. /**
  104814. * Indicates that textures and misc need to be re-calculated for all submeshes
  104815. */
  104816. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  104817. /**
  104818. * Sets the required values to the prepass renderer.
  104819. * @param prePassRenderer defines the prepass renderer to setup.
  104820. * @returns true if the pre pass is needed.
  104821. */
  104822. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  104823. /**
  104824. * Disposes the material
  104825. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  104826. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  104827. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  104828. */
  104829. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  104830. /** @hidden */
  104831. private releaseVertexArrayObject;
  104832. /**
  104833. * Serializes this material
  104834. * @returns the serialized material object
  104835. */
  104836. serialize(): any;
  104837. /**
  104838. * Creates a material from parsed material data
  104839. * @param parsedMaterial defines parsed material data
  104840. * @param scene defines the hosting scene
  104841. * @param rootUrl defines the root URL to use to load textures
  104842. * @returns a new material
  104843. */
  104844. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  104845. }
  104846. }
  104847. declare module BABYLON {
  104848. /**
  104849. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104850. * separate meshes. This can be use to improve performances.
  104851. * @see https://doc.babylonjs.com/how_to/multi_materials
  104852. */
  104853. export class MultiMaterial extends Material {
  104854. private _subMaterials;
  104855. /**
  104856. * Gets or Sets the list of Materials used within the multi material.
  104857. * They need to be ordered according to the submeshes order in the associated mesh
  104858. */
  104859. get subMaterials(): Nullable<Material>[];
  104860. set subMaterials(value: Nullable<Material>[]);
  104861. /**
  104862. * Function used to align with Node.getChildren()
  104863. * @returns the list of Materials used within the multi material
  104864. */
  104865. getChildren(): Nullable<Material>[];
  104866. /**
  104867. * Instantiates a new Multi Material
  104868. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104869. * separate meshes. This can be use to improve performances.
  104870. * @see https://doc.babylonjs.com/how_to/multi_materials
  104871. * @param name Define the name in the scene
  104872. * @param scene Define the scene the material belongs to
  104873. */
  104874. constructor(name: string, scene: Scene);
  104875. private _hookArray;
  104876. /**
  104877. * Get one of the submaterial by its index in the submaterials array
  104878. * @param index The index to look the sub material at
  104879. * @returns The Material if the index has been defined
  104880. */
  104881. getSubMaterial(index: number): Nullable<Material>;
  104882. /**
  104883. * Get the list of active textures for the whole sub materials list.
  104884. * @returns All the textures that will be used during the rendering
  104885. */
  104886. getActiveTextures(): BaseTexture[];
  104887. /**
  104888. * Gets the current class name of the material e.g. "MultiMaterial"
  104889. * Mainly use in serialization.
  104890. * @returns the class name
  104891. */
  104892. getClassName(): string;
  104893. /**
  104894. * Checks if the material is ready to render the requested sub mesh
  104895. * @param mesh Define the mesh the submesh belongs to
  104896. * @param subMesh Define the sub mesh to look readyness for
  104897. * @param useInstances Define whether or not the material is used with instances
  104898. * @returns true if ready, otherwise false
  104899. */
  104900. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104901. /**
  104902. * Clones the current material and its related sub materials
  104903. * @param name Define the name of the newly cloned material
  104904. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  104905. * @returns the cloned material
  104906. */
  104907. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  104908. /**
  104909. * Serializes the materials into a JSON representation.
  104910. * @returns the JSON representation
  104911. */
  104912. serialize(): any;
  104913. /**
  104914. * Dispose the material and release its associated resources
  104915. * @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)
  104916. * @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)
  104917. * @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)
  104918. */
  104919. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  104920. /**
  104921. * Creates a MultiMaterial from parsed MultiMaterial data.
  104922. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  104923. * @param scene defines the hosting scene
  104924. * @returns a new MultiMaterial
  104925. */
  104926. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  104927. }
  104928. }
  104929. declare module BABYLON {
  104930. /**
  104931. * Defines a subdivision inside a mesh
  104932. */
  104933. export class SubMesh implements ICullable {
  104934. /** the material index to use */
  104935. materialIndex: number;
  104936. /** vertex index start */
  104937. verticesStart: number;
  104938. /** vertices count */
  104939. verticesCount: number;
  104940. /** index start */
  104941. indexStart: number;
  104942. /** indices count */
  104943. indexCount: number;
  104944. /** @hidden */
  104945. _materialDefines: Nullable<MaterialDefines>;
  104946. /** @hidden */
  104947. _materialEffect: Nullable<Effect>;
  104948. /** @hidden */
  104949. _effectOverride: Nullable<Effect>;
  104950. /**
  104951. * Gets material defines used by the effect associated to the sub mesh
  104952. */
  104953. get materialDefines(): Nullable<MaterialDefines>;
  104954. /**
  104955. * Sets material defines used by the effect associated to the sub mesh
  104956. */
  104957. set materialDefines(defines: Nullable<MaterialDefines>);
  104958. /**
  104959. * Gets associated effect
  104960. */
  104961. get effect(): Nullable<Effect>;
  104962. /**
  104963. * Sets associated effect (effect used to render this submesh)
  104964. * @param effect defines the effect to associate with
  104965. * @param defines defines the set of defines used to compile this effect
  104966. */
  104967. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  104968. /** @hidden */
  104969. _linesIndexCount: number;
  104970. private _mesh;
  104971. private _renderingMesh;
  104972. private _boundingInfo;
  104973. private _linesIndexBuffer;
  104974. /** @hidden */
  104975. _lastColliderWorldVertices: Nullable<Vector3[]>;
  104976. /** @hidden */
  104977. _trianglePlanes: Plane[];
  104978. /** @hidden */
  104979. _lastColliderTransformMatrix: Nullable<Matrix>;
  104980. /** @hidden */
  104981. _renderId: number;
  104982. /** @hidden */
  104983. _alphaIndex: number;
  104984. /** @hidden */
  104985. _distanceToCamera: number;
  104986. /** @hidden */
  104987. _id: number;
  104988. private _currentMaterial;
  104989. /**
  104990. * Add a new submesh to a mesh
  104991. * @param materialIndex defines the material index to use
  104992. * @param verticesStart defines vertex index start
  104993. * @param verticesCount defines vertices count
  104994. * @param indexStart defines index start
  104995. * @param indexCount defines indices count
  104996. * @param mesh defines the parent mesh
  104997. * @param renderingMesh defines an optional rendering mesh
  104998. * @param createBoundingBox defines if bounding box should be created for this submesh
  104999. * @returns the new submesh
  105000. */
  105001. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  105002. /**
  105003. * Creates a new submesh
  105004. * @param materialIndex defines the material index to use
  105005. * @param verticesStart defines vertex index start
  105006. * @param verticesCount defines vertices count
  105007. * @param indexStart defines index start
  105008. * @param indexCount defines indices count
  105009. * @param mesh defines the parent mesh
  105010. * @param renderingMesh defines an optional rendering mesh
  105011. * @param createBoundingBox defines if bounding box should be created for this submesh
  105012. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  105013. */
  105014. constructor(
  105015. /** the material index to use */
  105016. materialIndex: number,
  105017. /** vertex index start */
  105018. verticesStart: number,
  105019. /** vertices count */
  105020. verticesCount: number,
  105021. /** index start */
  105022. indexStart: number,
  105023. /** indices count */
  105024. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  105025. /**
  105026. * Returns true if this submesh covers the entire parent mesh
  105027. * @ignorenaming
  105028. */
  105029. get IsGlobal(): boolean;
  105030. /**
  105031. * Returns the submesh BoudingInfo object
  105032. * @returns current bounding info (or mesh's one if the submesh is global)
  105033. */
  105034. getBoundingInfo(): BoundingInfo;
  105035. /**
  105036. * Sets the submesh BoundingInfo
  105037. * @param boundingInfo defines the new bounding info to use
  105038. * @returns the SubMesh
  105039. */
  105040. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  105041. /**
  105042. * Returns the mesh of the current submesh
  105043. * @return the parent mesh
  105044. */
  105045. getMesh(): AbstractMesh;
  105046. /**
  105047. * Returns the rendering mesh of the submesh
  105048. * @returns the rendering mesh (could be different from parent mesh)
  105049. */
  105050. getRenderingMesh(): Mesh;
  105051. /**
  105052. * Returns the replacement mesh of the submesh
  105053. * @returns the replacement mesh (could be different from parent mesh)
  105054. */
  105055. getReplacementMesh(): Nullable<AbstractMesh>;
  105056. /**
  105057. * Returns the effective mesh of the submesh
  105058. * @returns the effective mesh (could be different from parent mesh)
  105059. */
  105060. getEffectiveMesh(): AbstractMesh;
  105061. /**
  105062. * Returns the submesh material
  105063. * @returns null or the current material
  105064. */
  105065. getMaterial(): Nullable<Material>;
  105066. private _IsMultiMaterial;
  105067. /**
  105068. * Sets a new updated BoundingInfo object to the submesh
  105069. * @param data defines an optional position array to use to determine the bounding info
  105070. * @returns the SubMesh
  105071. */
  105072. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  105073. /** @hidden */
  105074. _checkCollision(collider: Collider): boolean;
  105075. /**
  105076. * Updates the submesh BoundingInfo
  105077. * @param world defines the world matrix to use to update the bounding info
  105078. * @returns the submesh
  105079. */
  105080. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  105081. /**
  105082. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  105083. * @param frustumPlanes defines the frustum planes
  105084. * @returns true if the submesh is intersecting with the frustum
  105085. */
  105086. isInFrustum(frustumPlanes: Plane[]): boolean;
  105087. /**
  105088. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  105089. * @param frustumPlanes defines the frustum planes
  105090. * @returns true if the submesh is inside the frustum
  105091. */
  105092. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  105093. /**
  105094. * Renders the submesh
  105095. * @param enableAlphaMode defines if alpha needs to be used
  105096. * @returns the submesh
  105097. */
  105098. render(enableAlphaMode: boolean): SubMesh;
  105099. /**
  105100. * @hidden
  105101. */
  105102. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  105103. /**
  105104. * Checks if the submesh intersects with a ray
  105105. * @param ray defines the ray to test
  105106. * @returns true is the passed ray intersects the submesh bounding box
  105107. */
  105108. canIntersects(ray: Ray): boolean;
  105109. /**
  105110. * Intersects current submesh with a ray
  105111. * @param ray defines the ray to test
  105112. * @param positions defines mesh's positions array
  105113. * @param indices defines mesh's indices array
  105114. * @param fastCheck defines if the first intersection will be used (and not the closest)
  105115. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  105116. * @returns intersection info or null if no intersection
  105117. */
  105118. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  105119. /** @hidden */
  105120. private _intersectLines;
  105121. /** @hidden */
  105122. private _intersectUnIndexedLines;
  105123. /** @hidden */
  105124. private _intersectTriangles;
  105125. /** @hidden */
  105126. private _intersectUnIndexedTriangles;
  105127. /** @hidden */
  105128. _rebuild(): void;
  105129. /**
  105130. * Creates a new submesh from the passed mesh
  105131. * @param newMesh defines the new hosting mesh
  105132. * @param newRenderingMesh defines an optional rendering mesh
  105133. * @returns the new submesh
  105134. */
  105135. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  105136. /**
  105137. * Release associated resources
  105138. */
  105139. dispose(): void;
  105140. /**
  105141. * Gets the class name
  105142. * @returns the string "SubMesh".
  105143. */
  105144. getClassName(): string;
  105145. /**
  105146. * Creates a new submesh from indices data
  105147. * @param materialIndex the index of the main mesh material
  105148. * @param startIndex the index where to start the copy in the mesh indices array
  105149. * @param indexCount the number of indices to copy then from the startIndex
  105150. * @param mesh the main mesh to create the submesh from
  105151. * @param renderingMesh the optional rendering mesh
  105152. * @returns a new submesh
  105153. */
  105154. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  105155. }
  105156. }
  105157. declare module BABYLON {
  105158. /**
  105159. * Class used to represent data loading progression
  105160. */
  105161. export class SceneLoaderFlags {
  105162. private static _ForceFullSceneLoadingForIncremental;
  105163. private static _ShowLoadingScreen;
  105164. private static _CleanBoneMatrixWeights;
  105165. private static _loggingLevel;
  105166. /**
  105167. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  105168. */
  105169. static get ForceFullSceneLoadingForIncremental(): boolean;
  105170. static set ForceFullSceneLoadingForIncremental(value: boolean);
  105171. /**
  105172. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  105173. */
  105174. static get ShowLoadingScreen(): boolean;
  105175. static set ShowLoadingScreen(value: boolean);
  105176. /**
  105177. * Defines the current logging level (while loading the scene)
  105178. * @ignorenaming
  105179. */
  105180. static get loggingLevel(): number;
  105181. static set loggingLevel(value: number);
  105182. /**
  105183. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  105184. */
  105185. static get CleanBoneMatrixWeights(): boolean;
  105186. static set CleanBoneMatrixWeights(value: boolean);
  105187. }
  105188. }
  105189. declare module BABYLON {
  105190. /**
  105191. * Class used to store geometry data (vertex buffers + index buffer)
  105192. */
  105193. export class Geometry implements IGetSetVerticesData {
  105194. /**
  105195. * Gets or sets the ID of the geometry
  105196. */
  105197. id: string;
  105198. /**
  105199. * Gets or sets the unique ID of the geometry
  105200. */
  105201. uniqueId: number;
  105202. /**
  105203. * Gets the delay loading state of the geometry (none by default which means not delayed)
  105204. */
  105205. delayLoadState: number;
  105206. /**
  105207. * Gets the file containing the data to load when running in delay load state
  105208. */
  105209. delayLoadingFile: Nullable<string>;
  105210. /**
  105211. * Callback called when the geometry is updated
  105212. */
  105213. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  105214. private _scene;
  105215. private _engine;
  105216. private _meshes;
  105217. private _totalVertices;
  105218. /** @hidden */
  105219. _indices: IndicesArray;
  105220. /** @hidden */
  105221. _vertexBuffers: {
  105222. [key: string]: VertexBuffer;
  105223. };
  105224. private _isDisposed;
  105225. private _extend;
  105226. private _boundingBias;
  105227. /** @hidden */
  105228. _delayInfo: Array<string>;
  105229. private _indexBuffer;
  105230. private _indexBufferIsUpdatable;
  105231. /** @hidden */
  105232. _boundingInfo: Nullable<BoundingInfo>;
  105233. /** @hidden */
  105234. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  105235. /** @hidden */
  105236. _softwareSkinningFrameId: number;
  105237. private _vertexArrayObjects;
  105238. private _updatable;
  105239. /** @hidden */
  105240. _positions: Nullable<Vector3[]>;
  105241. /**
  105242. * 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
  105243. */
  105244. get boundingBias(): Vector2;
  105245. /**
  105246. * 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
  105247. */
  105248. set boundingBias(value: Vector2);
  105249. /**
  105250. * Static function used to attach a new empty geometry to a mesh
  105251. * @param mesh defines the mesh to attach the geometry to
  105252. * @returns the new Geometry
  105253. */
  105254. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  105255. /** Get the list of meshes using this geometry */
  105256. get meshes(): Mesh[];
  105257. /**
  105258. * 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
  105259. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  105260. */
  105261. useBoundingInfoFromGeometry: boolean;
  105262. /**
  105263. * Creates a new geometry
  105264. * @param id defines the unique ID
  105265. * @param scene defines the hosting scene
  105266. * @param vertexData defines the VertexData used to get geometry data
  105267. * @param updatable defines if geometry must be updatable (false by default)
  105268. * @param mesh defines the mesh that will be associated with the geometry
  105269. */
  105270. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  105271. /**
  105272. * Gets the current extend of the geometry
  105273. */
  105274. get extend(): {
  105275. minimum: Vector3;
  105276. maximum: Vector3;
  105277. };
  105278. /**
  105279. * Gets the hosting scene
  105280. * @returns the hosting Scene
  105281. */
  105282. getScene(): Scene;
  105283. /**
  105284. * Gets the hosting engine
  105285. * @returns the hosting Engine
  105286. */
  105287. getEngine(): Engine;
  105288. /**
  105289. * Defines if the geometry is ready to use
  105290. * @returns true if the geometry is ready to be used
  105291. */
  105292. isReady(): boolean;
  105293. /**
  105294. * Gets a value indicating that the geometry should not be serialized
  105295. */
  105296. get doNotSerialize(): boolean;
  105297. /** @hidden */
  105298. _rebuild(): void;
  105299. /**
  105300. * Affects all geometry data in one call
  105301. * @param vertexData defines the geometry data
  105302. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  105303. */
  105304. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  105305. /**
  105306. * Set specific vertex data
  105307. * @param kind defines the data kind (Position, normal, etc...)
  105308. * @param data defines the vertex data to use
  105309. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105310. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105311. */
  105312. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  105313. /**
  105314. * Removes a specific vertex data
  105315. * @param kind defines the data kind (Position, normal, etc...)
  105316. */
  105317. removeVerticesData(kind: string): void;
  105318. /**
  105319. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  105320. * @param buffer defines the vertex buffer to use
  105321. * @param totalVertices defines the total number of vertices for position kind (could be null)
  105322. */
  105323. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  105324. /**
  105325. * Update a specific vertex buffer
  105326. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  105327. * It will do nothing if the buffer is not updatable
  105328. * @param kind defines the data kind (Position, normal, etc...)
  105329. * @param data defines the data to use
  105330. * @param offset defines the offset in the target buffer where to store the data
  105331. * @param useBytes set to true if the offset is in bytes
  105332. */
  105333. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  105334. /**
  105335. * Update a specific vertex buffer
  105336. * This function will create a new buffer if the current one is not updatable
  105337. * @param kind defines the data kind (Position, normal, etc...)
  105338. * @param data defines the data to use
  105339. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  105340. */
  105341. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  105342. private _updateBoundingInfo;
  105343. /** @hidden */
  105344. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  105345. /**
  105346. * Gets total number of vertices
  105347. * @returns the total number of vertices
  105348. */
  105349. getTotalVertices(): number;
  105350. /**
  105351. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105352. * @param kind defines the data kind (Position, normal, etc...)
  105353. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105354. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105355. * @returns a float array containing vertex data
  105356. */
  105357. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105358. /**
  105359. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  105360. * @param kind defines the data kind (Position, normal, etc...)
  105361. * @returns true if the vertex buffer with the specified kind is updatable
  105362. */
  105363. isVertexBufferUpdatable(kind: string): boolean;
  105364. /**
  105365. * Gets a specific vertex buffer
  105366. * @param kind defines the data kind (Position, normal, etc...)
  105367. * @returns a VertexBuffer
  105368. */
  105369. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  105370. /**
  105371. * Returns all vertex buffers
  105372. * @return an object holding all vertex buffers indexed by kind
  105373. */
  105374. getVertexBuffers(): Nullable<{
  105375. [key: string]: VertexBuffer;
  105376. }>;
  105377. /**
  105378. * Gets a boolean indicating if specific vertex buffer is present
  105379. * @param kind defines the data kind (Position, normal, etc...)
  105380. * @returns true if data is present
  105381. */
  105382. isVerticesDataPresent(kind: string): boolean;
  105383. /**
  105384. * Gets a list of all attached data kinds (Position, normal, etc...)
  105385. * @returns a list of string containing all kinds
  105386. */
  105387. getVerticesDataKinds(): string[];
  105388. /**
  105389. * Update index buffer
  105390. * @param indices defines the indices to store in the index buffer
  105391. * @param offset defines the offset in the target buffer where to store the data
  105392. * @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)
  105393. */
  105394. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  105395. /**
  105396. * Creates a new index buffer
  105397. * @param indices defines the indices to store in the index buffer
  105398. * @param totalVertices defines the total number of vertices (could be null)
  105399. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105400. */
  105401. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  105402. /**
  105403. * Return the total number of indices
  105404. * @returns the total number of indices
  105405. */
  105406. getTotalIndices(): number;
  105407. /**
  105408. * Gets the index buffer array
  105409. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105410. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105411. * @returns the index buffer array
  105412. */
  105413. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105414. /**
  105415. * Gets the index buffer
  105416. * @return the index buffer
  105417. */
  105418. getIndexBuffer(): Nullable<DataBuffer>;
  105419. /** @hidden */
  105420. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  105421. /**
  105422. * Release the associated resources for a specific mesh
  105423. * @param mesh defines the source mesh
  105424. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  105425. */
  105426. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  105427. /**
  105428. * Apply current geometry to a given mesh
  105429. * @param mesh defines the mesh to apply geometry to
  105430. */
  105431. applyToMesh(mesh: Mesh): void;
  105432. private _updateExtend;
  105433. private _applyToMesh;
  105434. private notifyUpdate;
  105435. /**
  105436. * Load the geometry if it was flagged as delay loaded
  105437. * @param scene defines the hosting scene
  105438. * @param onLoaded defines a callback called when the geometry is loaded
  105439. */
  105440. load(scene: Scene, onLoaded?: () => void): void;
  105441. private _queueLoad;
  105442. /**
  105443. * Invert the geometry to move from a right handed system to a left handed one.
  105444. */
  105445. toLeftHanded(): void;
  105446. /** @hidden */
  105447. _resetPointsArrayCache(): void;
  105448. /** @hidden */
  105449. _generatePointsArray(): boolean;
  105450. /**
  105451. * Gets a value indicating if the geometry is disposed
  105452. * @returns true if the geometry was disposed
  105453. */
  105454. isDisposed(): boolean;
  105455. private _disposeVertexArrayObjects;
  105456. /**
  105457. * Free all associated resources
  105458. */
  105459. dispose(): void;
  105460. /**
  105461. * Clone the current geometry into a new geometry
  105462. * @param id defines the unique ID of the new geometry
  105463. * @returns a new geometry object
  105464. */
  105465. copy(id: string): Geometry;
  105466. /**
  105467. * Serialize the current geometry info (and not the vertices data) into a JSON object
  105468. * @return a JSON representation of the current geometry data (without the vertices data)
  105469. */
  105470. serialize(): any;
  105471. private toNumberArray;
  105472. /**
  105473. * Serialize all vertices data into a JSON oject
  105474. * @returns a JSON representation of the current geometry data
  105475. */
  105476. serializeVerticeData(): any;
  105477. /**
  105478. * Extracts a clone of a mesh geometry
  105479. * @param mesh defines the source mesh
  105480. * @param id defines the unique ID of the new geometry object
  105481. * @returns the new geometry object
  105482. */
  105483. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  105484. /**
  105485. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  105486. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  105487. * Be aware Math.random() could cause collisions, but:
  105488. * "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"
  105489. * @returns a string containing a new GUID
  105490. */
  105491. static RandomId(): string;
  105492. /** @hidden */
  105493. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  105494. private static _CleanMatricesWeights;
  105495. /**
  105496. * Create a new geometry from persisted data (Using .babylon file format)
  105497. * @param parsedVertexData defines the persisted data
  105498. * @param scene defines the hosting scene
  105499. * @param rootUrl defines the root url to use to load assets (like delayed data)
  105500. * @returns the new geometry object
  105501. */
  105502. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  105503. }
  105504. }
  105505. declare module BABYLON {
  105506. /**
  105507. * Define an interface for all classes that will get and set the data on vertices
  105508. */
  105509. export interface IGetSetVerticesData {
  105510. /**
  105511. * Gets a boolean indicating if specific vertex data is present
  105512. * @param kind defines the vertex data kind to use
  105513. * @returns true is data kind is present
  105514. */
  105515. isVerticesDataPresent(kind: string): boolean;
  105516. /**
  105517. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105518. * @param kind defines the data kind (Position, normal, etc...)
  105519. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105520. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105521. * @returns a float array containing vertex data
  105522. */
  105523. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105524. /**
  105525. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  105526. * @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.
  105527. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105528. * @returns the indices array or an empty array if the mesh has no geometry
  105529. */
  105530. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105531. /**
  105532. * Set specific vertex data
  105533. * @param kind defines the data kind (Position, normal, etc...)
  105534. * @param data defines the vertex data to use
  105535. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105536. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105537. */
  105538. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  105539. /**
  105540. * Update a specific associated vertex buffer
  105541. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  105542. * - VertexBuffer.PositionKind
  105543. * - VertexBuffer.UVKind
  105544. * - VertexBuffer.UV2Kind
  105545. * - VertexBuffer.UV3Kind
  105546. * - VertexBuffer.UV4Kind
  105547. * - VertexBuffer.UV5Kind
  105548. * - VertexBuffer.UV6Kind
  105549. * - VertexBuffer.ColorKind
  105550. * - VertexBuffer.MatricesIndicesKind
  105551. * - VertexBuffer.MatricesIndicesExtraKind
  105552. * - VertexBuffer.MatricesWeightsKind
  105553. * - VertexBuffer.MatricesWeightsExtraKind
  105554. * @param data defines the data source
  105555. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  105556. * @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)
  105557. */
  105558. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  105559. /**
  105560. * Creates a new index buffer
  105561. * @param indices defines the indices to store in the index buffer
  105562. * @param totalVertices defines the total number of vertices (could be null)
  105563. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105564. */
  105565. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  105566. }
  105567. /**
  105568. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  105569. */
  105570. export class VertexData {
  105571. /**
  105572. * Mesh side orientation : usually the external or front surface
  105573. */
  105574. static readonly FRONTSIDE: number;
  105575. /**
  105576. * Mesh side orientation : usually the internal or back surface
  105577. */
  105578. static readonly BACKSIDE: number;
  105579. /**
  105580. * Mesh side orientation : both internal and external or front and back surfaces
  105581. */
  105582. static readonly DOUBLESIDE: number;
  105583. /**
  105584. * Mesh side orientation : by default, `FRONTSIDE`
  105585. */
  105586. static readonly DEFAULTSIDE: number;
  105587. /**
  105588. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  105589. */
  105590. positions: Nullable<FloatArray>;
  105591. /**
  105592. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  105593. */
  105594. normals: Nullable<FloatArray>;
  105595. /**
  105596. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  105597. */
  105598. tangents: Nullable<FloatArray>;
  105599. /**
  105600. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105601. */
  105602. uvs: Nullable<FloatArray>;
  105603. /**
  105604. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105605. */
  105606. uvs2: Nullable<FloatArray>;
  105607. /**
  105608. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105609. */
  105610. uvs3: Nullable<FloatArray>;
  105611. /**
  105612. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105613. */
  105614. uvs4: Nullable<FloatArray>;
  105615. /**
  105616. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105617. */
  105618. uvs5: Nullable<FloatArray>;
  105619. /**
  105620. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105621. */
  105622. uvs6: Nullable<FloatArray>;
  105623. /**
  105624. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  105625. */
  105626. colors: Nullable<FloatArray>;
  105627. /**
  105628. * 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).
  105629. */
  105630. matricesIndices: Nullable<FloatArray>;
  105631. /**
  105632. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  105633. */
  105634. matricesWeights: Nullable<FloatArray>;
  105635. /**
  105636. * An array extending the number of possible indices
  105637. */
  105638. matricesIndicesExtra: Nullable<FloatArray>;
  105639. /**
  105640. * An array extending the number of possible weights when the number of indices is extended
  105641. */
  105642. matricesWeightsExtra: Nullable<FloatArray>;
  105643. /**
  105644. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  105645. */
  105646. indices: Nullable<IndicesArray>;
  105647. /**
  105648. * Uses the passed data array to set the set the values for the specified kind of data
  105649. * @param data a linear array of floating numbers
  105650. * @param kind the type of data that is being set, eg positions, colors etc
  105651. */
  105652. set(data: FloatArray, kind: string): void;
  105653. /**
  105654. * Associates the vertexData to the passed Mesh.
  105655. * Sets it as updatable or not (default `false`)
  105656. * @param mesh the mesh the vertexData is applied to
  105657. * @param updatable when used and having the value true allows new data to update the vertexData
  105658. * @returns the VertexData
  105659. */
  105660. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  105661. /**
  105662. * Associates the vertexData to the passed Geometry.
  105663. * Sets it as updatable or not (default `false`)
  105664. * @param geometry the geometry the vertexData is applied to
  105665. * @param updatable when used and having the value true allows new data to update the vertexData
  105666. * @returns VertexData
  105667. */
  105668. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  105669. /**
  105670. * Updates the associated mesh
  105671. * @param mesh the mesh to be updated
  105672. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105673. * @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
  105674. * @returns VertexData
  105675. */
  105676. updateMesh(mesh: Mesh): VertexData;
  105677. /**
  105678. * Updates the associated geometry
  105679. * @param geometry the geometry to be updated
  105680. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105681. * @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
  105682. * @returns VertexData.
  105683. */
  105684. updateGeometry(geometry: Geometry): VertexData;
  105685. private _applyTo;
  105686. private _update;
  105687. /**
  105688. * Transforms each position and each normal of the vertexData according to the passed Matrix
  105689. * @param matrix the transforming matrix
  105690. * @returns the VertexData
  105691. */
  105692. transform(matrix: Matrix): VertexData;
  105693. /**
  105694. * Merges the passed VertexData into the current one
  105695. * @param other the VertexData to be merged into the current one
  105696. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  105697. * @returns the modified VertexData
  105698. */
  105699. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  105700. private _mergeElement;
  105701. private _validate;
  105702. /**
  105703. * Serializes the VertexData
  105704. * @returns a serialized object
  105705. */
  105706. serialize(): any;
  105707. /**
  105708. * Extracts the vertexData from a mesh
  105709. * @param mesh the mesh from which to extract the VertexData
  105710. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  105711. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105712. * @returns the object VertexData associated to the passed mesh
  105713. */
  105714. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105715. /**
  105716. * Extracts the vertexData from the geometry
  105717. * @param geometry the geometry from which to extract the VertexData
  105718. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  105719. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105720. * @returns the object VertexData associated to the passed mesh
  105721. */
  105722. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105723. private static _ExtractFrom;
  105724. /**
  105725. * Creates the VertexData for a Ribbon
  105726. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  105727. * * pathArray array of paths, each of which an array of successive Vector3
  105728. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  105729. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  105730. * * 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
  105731. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105732. * * 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)
  105733. * * 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)
  105734. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  105735. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  105736. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  105737. * @returns the VertexData of the ribbon
  105738. */
  105739. static CreateRibbon(options: {
  105740. pathArray: Vector3[][];
  105741. closeArray?: boolean;
  105742. closePath?: boolean;
  105743. offset?: number;
  105744. sideOrientation?: number;
  105745. frontUVs?: Vector4;
  105746. backUVs?: Vector4;
  105747. invertUV?: boolean;
  105748. uvs?: Vector2[];
  105749. colors?: Color4[];
  105750. }): VertexData;
  105751. /**
  105752. * Creates the VertexData for a box
  105753. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105754. * * size sets the width, height and depth of the box to the value of size, optional default 1
  105755. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  105756. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  105757. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  105758. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105759. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105760. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105761. * * 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)
  105762. * * 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)
  105763. * @returns the VertexData of the box
  105764. */
  105765. static CreateBox(options: {
  105766. size?: number;
  105767. width?: number;
  105768. height?: number;
  105769. depth?: number;
  105770. faceUV?: Vector4[];
  105771. faceColors?: Color4[];
  105772. sideOrientation?: number;
  105773. frontUVs?: Vector4;
  105774. backUVs?: Vector4;
  105775. }): VertexData;
  105776. /**
  105777. * Creates the VertexData for a tiled box
  105778. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105779. * * faceTiles sets the pattern, tile size and number of tiles for a face
  105780. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105781. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105782. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105783. * @returns the VertexData of the box
  105784. */
  105785. static CreateTiledBox(options: {
  105786. pattern?: number;
  105787. width?: number;
  105788. height?: number;
  105789. depth?: number;
  105790. tileSize?: number;
  105791. tileWidth?: number;
  105792. tileHeight?: number;
  105793. alignHorizontal?: number;
  105794. alignVertical?: number;
  105795. faceUV?: Vector4[];
  105796. faceColors?: Color4[];
  105797. sideOrientation?: number;
  105798. }): VertexData;
  105799. /**
  105800. * Creates the VertexData for a tiled plane
  105801. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105802. * * pattern a limited pattern arrangement depending on the number
  105803. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  105804. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  105805. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  105806. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105807. * * 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)
  105808. * * 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)
  105809. * @returns the VertexData of the tiled plane
  105810. */
  105811. static CreateTiledPlane(options: {
  105812. pattern?: number;
  105813. tileSize?: number;
  105814. tileWidth?: number;
  105815. tileHeight?: number;
  105816. size?: number;
  105817. width?: number;
  105818. height?: number;
  105819. alignHorizontal?: number;
  105820. alignVertical?: number;
  105821. sideOrientation?: number;
  105822. frontUVs?: Vector4;
  105823. backUVs?: Vector4;
  105824. }): VertexData;
  105825. /**
  105826. * Creates the VertexData for an ellipsoid, defaults to a sphere
  105827. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105828. * * segments sets the number of horizontal strips optional, default 32
  105829. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  105830. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  105831. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  105832. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  105833. * * 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
  105834. * * 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
  105835. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105836. * * 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)
  105837. * * 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)
  105838. * @returns the VertexData of the ellipsoid
  105839. */
  105840. static CreateSphere(options: {
  105841. segments?: number;
  105842. diameter?: number;
  105843. diameterX?: number;
  105844. diameterY?: number;
  105845. diameterZ?: number;
  105846. arc?: number;
  105847. slice?: number;
  105848. sideOrientation?: number;
  105849. frontUVs?: Vector4;
  105850. backUVs?: Vector4;
  105851. }): VertexData;
  105852. /**
  105853. * Creates the VertexData for a cylinder, cone or prism
  105854. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105855. * * height sets the height (y direction) of the cylinder, optional, default 2
  105856. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  105857. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  105858. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  105859. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105860. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  105861. * * 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
  105862. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  105863. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  105864. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  105865. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  105866. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105867. * * 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)
  105868. * * 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)
  105869. * @returns the VertexData of the cylinder, cone or prism
  105870. */
  105871. static CreateCylinder(options: {
  105872. height?: number;
  105873. diameterTop?: number;
  105874. diameterBottom?: number;
  105875. diameter?: number;
  105876. tessellation?: number;
  105877. subdivisions?: number;
  105878. arc?: number;
  105879. faceColors?: Color4[];
  105880. faceUV?: Vector4[];
  105881. hasRings?: boolean;
  105882. enclose?: boolean;
  105883. sideOrientation?: number;
  105884. frontUVs?: Vector4;
  105885. backUVs?: Vector4;
  105886. }): VertexData;
  105887. /**
  105888. * Creates the VertexData for a torus
  105889. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105890. * * diameter the diameter of the torus, optional default 1
  105891. * * thickness the diameter of the tube forming the torus, optional default 0.5
  105892. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105893. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105894. * * 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)
  105895. * * 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)
  105896. * @returns the VertexData of the torus
  105897. */
  105898. static CreateTorus(options: {
  105899. diameter?: number;
  105900. thickness?: number;
  105901. tessellation?: number;
  105902. sideOrientation?: number;
  105903. frontUVs?: Vector4;
  105904. backUVs?: Vector4;
  105905. }): VertexData;
  105906. /**
  105907. * Creates the VertexData of the LineSystem
  105908. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  105909. * - lines an array of lines, each line being an array of successive Vector3
  105910. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  105911. * @returns the VertexData of the LineSystem
  105912. */
  105913. static CreateLineSystem(options: {
  105914. lines: Vector3[][];
  105915. colors?: Nullable<Color4[][]>;
  105916. }): VertexData;
  105917. /**
  105918. * Create the VertexData for a DashedLines
  105919. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  105920. * - points an array successive Vector3
  105921. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  105922. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  105923. * - dashNb the intended total number of dashes, optional, default 200
  105924. * @returns the VertexData for the DashedLines
  105925. */
  105926. static CreateDashedLines(options: {
  105927. points: Vector3[];
  105928. dashSize?: number;
  105929. gapSize?: number;
  105930. dashNb?: number;
  105931. }): VertexData;
  105932. /**
  105933. * Creates the VertexData for a Ground
  105934. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105935. * - width the width (x direction) of the ground, optional, default 1
  105936. * - height the height (z direction) of the ground, optional, default 1
  105937. * - subdivisions the number of subdivisions per side, optional, default 1
  105938. * @returns the VertexData of the Ground
  105939. */
  105940. static CreateGround(options: {
  105941. width?: number;
  105942. height?: number;
  105943. subdivisions?: number;
  105944. subdivisionsX?: number;
  105945. subdivisionsY?: number;
  105946. }): VertexData;
  105947. /**
  105948. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  105949. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105950. * * xmin the ground minimum X coordinate, optional, default -1
  105951. * * zmin the ground minimum Z coordinate, optional, default -1
  105952. * * xmax the ground maximum X coordinate, optional, default 1
  105953. * * zmax the ground maximum Z coordinate, optional, default 1
  105954. * * 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}
  105955. * * 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}
  105956. * @returns the VertexData of the TiledGround
  105957. */
  105958. static CreateTiledGround(options: {
  105959. xmin: number;
  105960. zmin: number;
  105961. xmax: number;
  105962. zmax: number;
  105963. subdivisions?: {
  105964. w: number;
  105965. h: number;
  105966. };
  105967. precision?: {
  105968. w: number;
  105969. h: number;
  105970. };
  105971. }): VertexData;
  105972. /**
  105973. * Creates the VertexData of the Ground designed from a heightmap
  105974. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  105975. * * width the width (x direction) of the ground
  105976. * * height the height (z direction) of the ground
  105977. * * subdivisions the number of subdivisions per side
  105978. * * minHeight the minimum altitude on the ground, optional, default 0
  105979. * * maxHeight the maximum altitude on the ground, optional default 1
  105980. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  105981. * * buffer the array holding the image color data
  105982. * * bufferWidth the width of image
  105983. * * bufferHeight the height of image
  105984. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  105985. * @returns the VertexData of the Ground designed from a heightmap
  105986. */
  105987. static CreateGroundFromHeightMap(options: {
  105988. width: number;
  105989. height: number;
  105990. subdivisions: number;
  105991. minHeight: number;
  105992. maxHeight: number;
  105993. colorFilter: Color3;
  105994. buffer: Uint8Array;
  105995. bufferWidth: number;
  105996. bufferHeight: number;
  105997. alphaFilter: number;
  105998. }): VertexData;
  105999. /**
  106000. * Creates the VertexData for a Plane
  106001. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  106002. * * size sets the width and height of the plane to the value of size, optional default 1
  106003. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  106004. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  106005. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106006. * * 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)
  106007. * * 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)
  106008. * @returns the VertexData of the box
  106009. */
  106010. static CreatePlane(options: {
  106011. size?: number;
  106012. width?: number;
  106013. height?: number;
  106014. sideOrientation?: number;
  106015. frontUVs?: Vector4;
  106016. backUVs?: Vector4;
  106017. }): VertexData;
  106018. /**
  106019. * Creates the VertexData of the Disc or regular Polygon
  106020. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  106021. * * radius the radius of the disc, optional default 0.5
  106022. * * tessellation the number of polygon sides, optional, default 64
  106023. * * 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
  106024. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106025. * * 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)
  106026. * * 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)
  106027. * @returns the VertexData of the box
  106028. */
  106029. static CreateDisc(options: {
  106030. radius?: number;
  106031. tessellation?: number;
  106032. arc?: number;
  106033. sideOrientation?: number;
  106034. frontUVs?: Vector4;
  106035. backUVs?: Vector4;
  106036. }): VertexData;
  106037. /**
  106038. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  106039. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  106040. * @param polygon a mesh built from polygonTriangulation.build()
  106041. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106042. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106043. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106044. * @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)
  106045. * @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)
  106046. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  106047. * @returns the VertexData of the Polygon
  106048. */
  106049. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  106050. /**
  106051. * Creates the VertexData of the IcoSphere
  106052. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  106053. * * radius the radius of the IcoSphere, optional default 1
  106054. * * radiusX allows stretching in the x direction, optional, default radius
  106055. * * radiusY allows stretching in the y direction, optional, default radius
  106056. * * radiusZ allows stretching in the z direction, optional, default radius
  106057. * * flat when true creates a flat shaded mesh, optional, default true
  106058. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106059. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106060. * * 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)
  106061. * * 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)
  106062. * @returns the VertexData of the IcoSphere
  106063. */
  106064. static CreateIcoSphere(options: {
  106065. radius?: number;
  106066. radiusX?: number;
  106067. radiusY?: number;
  106068. radiusZ?: number;
  106069. flat?: boolean;
  106070. subdivisions?: number;
  106071. sideOrientation?: number;
  106072. frontUVs?: Vector4;
  106073. backUVs?: Vector4;
  106074. }): VertexData;
  106075. /**
  106076. * Creates the VertexData for a Polyhedron
  106077. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  106078. * * type provided types are:
  106079. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  106080. * * 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)
  106081. * * size the size of the IcoSphere, optional default 1
  106082. * * sizeX allows stretching in the x direction, optional, default size
  106083. * * sizeY allows stretching in the y direction, optional, default size
  106084. * * sizeZ allows stretching in the z direction, optional, default size
  106085. * * 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
  106086. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106087. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106088. * * flat when true creates a flat shaded mesh, optional, default true
  106089. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106090. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106091. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  106092. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  106093. * @returns the VertexData of the Polyhedron
  106094. */
  106095. static CreatePolyhedron(options: {
  106096. type?: number;
  106097. size?: number;
  106098. sizeX?: number;
  106099. sizeY?: number;
  106100. sizeZ?: number;
  106101. custom?: any;
  106102. faceUV?: Vector4[];
  106103. faceColors?: Color4[];
  106104. flat?: boolean;
  106105. sideOrientation?: number;
  106106. frontUVs?: Vector4;
  106107. backUVs?: Vector4;
  106108. }): VertexData;
  106109. /**
  106110. * Creates the VertexData for a TorusKnot
  106111. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  106112. * * radius the radius of the torus knot, optional, default 2
  106113. * * tube the thickness of the tube, optional, default 0.5
  106114. * * radialSegments the number of sides on each tube segments, optional, default 32
  106115. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  106116. * * p the number of windings around the z axis, optional, default 2
  106117. * * q the number of windings around the x axis, optional, default 3
  106118. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106119. * * 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)
  106120. * * 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)
  106121. * @returns the VertexData of the Torus Knot
  106122. */
  106123. static CreateTorusKnot(options: {
  106124. radius?: number;
  106125. tube?: number;
  106126. radialSegments?: number;
  106127. tubularSegments?: number;
  106128. p?: number;
  106129. q?: number;
  106130. sideOrientation?: number;
  106131. frontUVs?: Vector4;
  106132. backUVs?: Vector4;
  106133. }): VertexData;
  106134. /**
  106135. * Compute normals for given positions and indices
  106136. * @param positions an array of vertex positions, [...., x, y, z, ......]
  106137. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  106138. * @param normals an array of vertex normals, [...., x, y, z, ......]
  106139. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  106140. * * facetNormals : optional array of facet normals (vector3)
  106141. * * facetPositions : optional array of facet positions (vector3)
  106142. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  106143. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  106144. * * bInfo : optional bounding info, required for facetPartitioning computation
  106145. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  106146. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  106147. * * useRightHandedSystem: optional boolean to for right handed system computation
  106148. * * depthSort : optional boolean to enable the facet depth sort computation
  106149. * * distanceTo : optional Vector3 to compute the facet depth from this location
  106150. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  106151. */
  106152. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  106153. facetNormals?: any;
  106154. facetPositions?: any;
  106155. facetPartitioning?: any;
  106156. ratio?: number;
  106157. bInfo?: any;
  106158. bbSize?: Vector3;
  106159. subDiv?: any;
  106160. useRightHandedSystem?: boolean;
  106161. depthSort?: boolean;
  106162. distanceTo?: Vector3;
  106163. depthSortedFacets?: any;
  106164. }): void;
  106165. /** @hidden */
  106166. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  106167. /**
  106168. * Applies VertexData created from the imported parameters to the geometry
  106169. * @param parsedVertexData the parsed data from an imported file
  106170. * @param geometry the geometry to apply the VertexData to
  106171. */
  106172. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  106173. }
  106174. }
  106175. declare module BABYLON {
  106176. /**
  106177. * Defines a target to use with MorphTargetManager
  106178. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106179. */
  106180. export class MorphTarget implements IAnimatable {
  106181. /** defines the name of the target */
  106182. name: string;
  106183. /**
  106184. * Gets or sets the list of animations
  106185. */
  106186. animations: Animation[];
  106187. private _scene;
  106188. private _positions;
  106189. private _normals;
  106190. private _tangents;
  106191. private _uvs;
  106192. private _influence;
  106193. private _uniqueId;
  106194. /**
  106195. * Observable raised when the influence changes
  106196. */
  106197. onInfluenceChanged: Observable<boolean>;
  106198. /** @hidden */
  106199. _onDataLayoutChanged: Observable<void>;
  106200. /**
  106201. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  106202. */
  106203. get influence(): number;
  106204. set influence(influence: number);
  106205. /**
  106206. * Gets or sets the id of the morph Target
  106207. */
  106208. id: string;
  106209. private _animationPropertiesOverride;
  106210. /**
  106211. * Gets or sets the animation properties override
  106212. */
  106213. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  106214. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  106215. /**
  106216. * Creates a new MorphTarget
  106217. * @param name defines the name of the target
  106218. * @param influence defines the influence to use
  106219. * @param scene defines the scene the morphtarget belongs to
  106220. */
  106221. constructor(
  106222. /** defines the name of the target */
  106223. name: string, influence?: number, scene?: Nullable<Scene>);
  106224. /**
  106225. * Gets the unique ID of this manager
  106226. */
  106227. get uniqueId(): number;
  106228. /**
  106229. * Gets a boolean defining if the target contains position data
  106230. */
  106231. get hasPositions(): boolean;
  106232. /**
  106233. * Gets a boolean defining if the target contains normal data
  106234. */
  106235. get hasNormals(): boolean;
  106236. /**
  106237. * Gets a boolean defining if the target contains tangent data
  106238. */
  106239. get hasTangents(): boolean;
  106240. /**
  106241. * Gets a boolean defining if the target contains texture coordinates data
  106242. */
  106243. get hasUVs(): boolean;
  106244. /**
  106245. * Affects position data to this target
  106246. * @param data defines the position data to use
  106247. */
  106248. setPositions(data: Nullable<FloatArray>): void;
  106249. /**
  106250. * Gets the position data stored in this target
  106251. * @returns a FloatArray containing the position data (or null if not present)
  106252. */
  106253. getPositions(): Nullable<FloatArray>;
  106254. /**
  106255. * Affects normal data to this target
  106256. * @param data defines the normal data to use
  106257. */
  106258. setNormals(data: Nullable<FloatArray>): void;
  106259. /**
  106260. * Gets the normal data stored in this target
  106261. * @returns a FloatArray containing the normal data (or null if not present)
  106262. */
  106263. getNormals(): Nullable<FloatArray>;
  106264. /**
  106265. * Affects tangent data to this target
  106266. * @param data defines the tangent data to use
  106267. */
  106268. setTangents(data: Nullable<FloatArray>): void;
  106269. /**
  106270. * Gets the tangent data stored in this target
  106271. * @returns a FloatArray containing the tangent data (or null if not present)
  106272. */
  106273. getTangents(): Nullable<FloatArray>;
  106274. /**
  106275. * Affects texture coordinates data to this target
  106276. * @param data defines the texture coordinates data to use
  106277. */
  106278. setUVs(data: Nullable<FloatArray>): void;
  106279. /**
  106280. * Gets the texture coordinates data stored in this target
  106281. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  106282. */
  106283. getUVs(): Nullable<FloatArray>;
  106284. /**
  106285. * Clone the current target
  106286. * @returns a new MorphTarget
  106287. */
  106288. clone(): MorphTarget;
  106289. /**
  106290. * Serializes the current target into a Serialization object
  106291. * @returns the serialized object
  106292. */
  106293. serialize(): any;
  106294. /**
  106295. * Returns the string "MorphTarget"
  106296. * @returns "MorphTarget"
  106297. */
  106298. getClassName(): string;
  106299. /**
  106300. * Creates a new target from serialized data
  106301. * @param serializationObject defines the serialized data to use
  106302. * @returns a new MorphTarget
  106303. */
  106304. static Parse(serializationObject: any): MorphTarget;
  106305. /**
  106306. * Creates a MorphTarget from mesh data
  106307. * @param mesh defines the source mesh
  106308. * @param name defines the name to use for the new target
  106309. * @param influence defines the influence to attach to the target
  106310. * @returns a new MorphTarget
  106311. */
  106312. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  106313. }
  106314. }
  106315. declare module BABYLON {
  106316. /**
  106317. * This class is used to deform meshes using morphing between different targets
  106318. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106319. */
  106320. export class MorphTargetManager {
  106321. private _targets;
  106322. private _targetInfluenceChangedObservers;
  106323. private _targetDataLayoutChangedObservers;
  106324. private _activeTargets;
  106325. private _scene;
  106326. private _influences;
  106327. private _supportsNormals;
  106328. private _supportsTangents;
  106329. private _supportsUVs;
  106330. private _vertexCount;
  106331. private _uniqueId;
  106332. private _tempInfluences;
  106333. /**
  106334. * Gets or sets a boolean indicating if normals must be morphed
  106335. */
  106336. enableNormalMorphing: boolean;
  106337. /**
  106338. * Gets or sets a boolean indicating if tangents must be morphed
  106339. */
  106340. enableTangentMorphing: boolean;
  106341. /**
  106342. * Gets or sets a boolean indicating if UV must be morphed
  106343. */
  106344. enableUVMorphing: boolean;
  106345. /**
  106346. * Creates a new MorphTargetManager
  106347. * @param scene defines the current scene
  106348. */
  106349. constructor(scene?: Nullable<Scene>);
  106350. /**
  106351. * Gets the unique ID of this manager
  106352. */
  106353. get uniqueId(): number;
  106354. /**
  106355. * Gets the number of vertices handled by this manager
  106356. */
  106357. get vertexCount(): number;
  106358. /**
  106359. * Gets a boolean indicating if this manager supports morphing of normals
  106360. */
  106361. get supportsNormals(): boolean;
  106362. /**
  106363. * Gets a boolean indicating if this manager supports morphing of tangents
  106364. */
  106365. get supportsTangents(): boolean;
  106366. /**
  106367. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  106368. */
  106369. get supportsUVs(): boolean;
  106370. /**
  106371. * Gets the number of targets stored in this manager
  106372. */
  106373. get numTargets(): number;
  106374. /**
  106375. * Gets the number of influencers (ie. the number of targets with influences > 0)
  106376. */
  106377. get numInfluencers(): number;
  106378. /**
  106379. * Gets the list of influences (one per target)
  106380. */
  106381. get influences(): Float32Array;
  106382. /**
  106383. * Gets the active target at specified index. An active target is a target with an influence > 0
  106384. * @param index defines the index to check
  106385. * @returns the requested target
  106386. */
  106387. getActiveTarget(index: number): MorphTarget;
  106388. /**
  106389. * Gets the target at specified index
  106390. * @param index defines the index to check
  106391. * @returns the requested target
  106392. */
  106393. getTarget(index: number): MorphTarget;
  106394. /**
  106395. * Add a new target to this manager
  106396. * @param target defines the target to add
  106397. */
  106398. addTarget(target: MorphTarget): void;
  106399. /**
  106400. * Removes a target from the manager
  106401. * @param target defines the target to remove
  106402. */
  106403. removeTarget(target: MorphTarget): void;
  106404. /**
  106405. * Clone the current manager
  106406. * @returns a new MorphTargetManager
  106407. */
  106408. clone(): MorphTargetManager;
  106409. /**
  106410. * Serializes the current manager into a Serialization object
  106411. * @returns the serialized object
  106412. */
  106413. serialize(): any;
  106414. private _syncActiveTargets;
  106415. /**
  106416. * Syncrhonize the targets with all the meshes using this morph target manager
  106417. */
  106418. synchronize(): void;
  106419. /**
  106420. * Creates a new MorphTargetManager from serialized data
  106421. * @param serializationObject defines the serialized data
  106422. * @param scene defines the hosting scene
  106423. * @returns the new MorphTargetManager
  106424. */
  106425. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  106426. }
  106427. }
  106428. declare module BABYLON {
  106429. /**
  106430. * Class used to represent a specific level of detail of a mesh
  106431. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106432. */
  106433. export class MeshLODLevel {
  106434. /** Defines the distance where this level should start being displayed */
  106435. distance: number;
  106436. /** Defines the mesh to use to render this level */
  106437. mesh: Nullable<Mesh>;
  106438. /**
  106439. * Creates a new LOD level
  106440. * @param distance defines the distance where this level should star being displayed
  106441. * @param mesh defines the mesh to use to render this level
  106442. */
  106443. constructor(
  106444. /** Defines the distance where this level should start being displayed */
  106445. distance: number,
  106446. /** Defines the mesh to use to render this level */
  106447. mesh: Nullable<Mesh>);
  106448. }
  106449. }
  106450. declare module BABYLON {
  106451. /**
  106452. * Helper class used to generate a canvas to manipulate images
  106453. */
  106454. export class CanvasGenerator {
  106455. /**
  106456. * Create a new canvas (or offscreen canvas depending on the context)
  106457. * @param width defines the expected width
  106458. * @param height defines the expected height
  106459. * @return a new canvas or offscreen canvas
  106460. */
  106461. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  106462. }
  106463. }
  106464. declare module BABYLON {
  106465. /**
  106466. * Mesh representing the gorund
  106467. */
  106468. export class GroundMesh extends Mesh {
  106469. /** If octree should be generated */
  106470. generateOctree: boolean;
  106471. private _heightQuads;
  106472. /** @hidden */
  106473. _subdivisionsX: number;
  106474. /** @hidden */
  106475. _subdivisionsY: number;
  106476. /** @hidden */
  106477. _width: number;
  106478. /** @hidden */
  106479. _height: number;
  106480. /** @hidden */
  106481. _minX: number;
  106482. /** @hidden */
  106483. _maxX: number;
  106484. /** @hidden */
  106485. _minZ: number;
  106486. /** @hidden */
  106487. _maxZ: number;
  106488. constructor(name: string, scene: Scene);
  106489. /**
  106490. * "GroundMesh"
  106491. * @returns "GroundMesh"
  106492. */
  106493. getClassName(): string;
  106494. /**
  106495. * The minimum of x and y subdivisions
  106496. */
  106497. get subdivisions(): number;
  106498. /**
  106499. * X subdivisions
  106500. */
  106501. get subdivisionsX(): number;
  106502. /**
  106503. * Y subdivisions
  106504. */
  106505. get subdivisionsY(): number;
  106506. /**
  106507. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  106508. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  106509. * @param chunksCount the number of subdivisions for x and y
  106510. * @param octreeBlocksSize (Default: 32)
  106511. */
  106512. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  106513. /**
  106514. * Returns a height (y) value in the Worl system :
  106515. * the ground altitude at the coordinates (x, z) expressed in the World system.
  106516. * @param x x coordinate
  106517. * @param z z coordinate
  106518. * @returns the ground y position if (x, z) are outside the ground surface.
  106519. */
  106520. getHeightAtCoordinates(x: number, z: number): number;
  106521. /**
  106522. * Returns a normalized vector (Vector3) orthogonal to the ground
  106523. * at the ground coordinates (x, z) expressed in the World system.
  106524. * @param x x coordinate
  106525. * @param z z coordinate
  106526. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  106527. */
  106528. getNormalAtCoordinates(x: number, z: number): Vector3;
  106529. /**
  106530. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  106531. * at the ground coordinates (x, z) expressed in the World system.
  106532. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  106533. * @param x x coordinate
  106534. * @param z z coordinate
  106535. * @param ref vector to store the result
  106536. * @returns the GroundMesh.
  106537. */
  106538. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  106539. /**
  106540. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  106541. * if the ground has been updated.
  106542. * This can be used in the render loop.
  106543. * @returns the GroundMesh.
  106544. */
  106545. updateCoordinateHeights(): GroundMesh;
  106546. private _getFacetAt;
  106547. private _initHeightQuads;
  106548. private _computeHeightQuads;
  106549. /**
  106550. * Serializes this ground mesh
  106551. * @param serializationObject object to write serialization to
  106552. */
  106553. serialize(serializationObject: any): void;
  106554. /**
  106555. * Parses a serialized ground mesh
  106556. * @param parsedMesh the serialized mesh
  106557. * @param scene the scene to create the ground mesh in
  106558. * @returns the created ground mesh
  106559. */
  106560. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  106561. }
  106562. }
  106563. declare module BABYLON {
  106564. /**
  106565. * Interface for Physics-Joint data
  106566. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106567. */
  106568. export interface PhysicsJointData {
  106569. /**
  106570. * The main pivot of the joint
  106571. */
  106572. mainPivot?: Vector3;
  106573. /**
  106574. * The connected pivot of the joint
  106575. */
  106576. connectedPivot?: Vector3;
  106577. /**
  106578. * The main axis of the joint
  106579. */
  106580. mainAxis?: Vector3;
  106581. /**
  106582. * The connected axis of the joint
  106583. */
  106584. connectedAxis?: Vector3;
  106585. /**
  106586. * The collision of the joint
  106587. */
  106588. collision?: boolean;
  106589. /**
  106590. * Native Oimo/Cannon/Energy data
  106591. */
  106592. nativeParams?: any;
  106593. }
  106594. /**
  106595. * This is a holder class for the physics joint created by the physics plugin
  106596. * It holds a set of functions to control the underlying joint
  106597. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106598. */
  106599. export class PhysicsJoint {
  106600. /**
  106601. * The type of the physics joint
  106602. */
  106603. type: number;
  106604. /**
  106605. * The data for the physics joint
  106606. */
  106607. jointData: PhysicsJointData;
  106608. private _physicsJoint;
  106609. protected _physicsPlugin: IPhysicsEnginePlugin;
  106610. /**
  106611. * Initializes the physics joint
  106612. * @param type The type of the physics joint
  106613. * @param jointData The data for the physics joint
  106614. */
  106615. constructor(
  106616. /**
  106617. * The type of the physics joint
  106618. */
  106619. type: number,
  106620. /**
  106621. * The data for the physics joint
  106622. */
  106623. jointData: PhysicsJointData);
  106624. /**
  106625. * Gets the physics joint
  106626. */
  106627. get physicsJoint(): any;
  106628. /**
  106629. * Sets the physics joint
  106630. */
  106631. set physicsJoint(newJoint: any);
  106632. /**
  106633. * Sets the physics plugin
  106634. */
  106635. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  106636. /**
  106637. * Execute a function that is physics-plugin specific.
  106638. * @param {Function} func the function that will be executed.
  106639. * It accepts two parameters: the physics world and the physics joint
  106640. */
  106641. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  106642. /**
  106643. * Distance-Joint type
  106644. */
  106645. static DistanceJoint: number;
  106646. /**
  106647. * Hinge-Joint type
  106648. */
  106649. static HingeJoint: number;
  106650. /**
  106651. * Ball-and-Socket joint type
  106652. */
  106653. static BallAndSocketJoint: number;
  106654. /**
  106655. * Wheel-Joint type
  106656. */
  106657. static WheelJoint: number;
  106658. /**
  106659. * Slider-Joint type
  106660. */
  106661. static SliderJoint: number;
  106662. /**
  106663. * Prismatic-Joint type
  106664. */
  106665. static PrismaticJoint: number;
  106666. /**
  106667. * Universal-Joint type
  106668. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  106669. */
  106670. static UniversalJoint: number;
  106671. /**
  106672. * Hinge-Joint 2 type
  106673. */
  106674. static Hinge2Joint: number;
  106675. /**
  106676. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  106677. */
  106678. static PointToPointJoint: number;
  106679. /**
  106680. * Spring-Joint type
  106681. */
  106682. static SpringJoint: number;
  106683. /**
  106684. * Lock-Joint type
  106685. */
  106686. static LockJoint: number;
  106687. }
  106688. /**
  106689. * A class representing a physics distance joint
  106690. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106691. */
  106692. export class DistanceJoint extends PhysicsJoint {
  106693. /**
  106694. *
  106695. * @param jointData The data for the Distance-Joint
  106696. */
  106697. constructor(jointData: DistanceJointData);
  106698. /**
  106699. * Update the predefined distance.
  106700. * @param maxDistance The maximum preferred distance
  106701. * @param minDistance The minimum preferred distance
  106702. */
  106703. updateDistance(maxDistance: number, minDistance?: number): void;
  106704. }
  106705. /**
  106706. * Represents a Motor-Enabled Joint
  106707. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106708. */
  106709. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  106710. /**
  106711. * Initializes the Motor-Enabled Joint
  106712. * @param type The type of the joint
  106713. * @param jointData The physica joint data for the joint
  106714. */
  106715. constructor(type: number, jointData: PhysicsJointData);
  106716. /**
  106717. * Set the motor values.
  106718. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106719. * @param force the force to apply
  106720. * @param maxForce max force for this motor.
  106721. */
  106722. setMotor(force?: number, maxForce?: number): void;
  106723. /**
  106724. * Set the motor's limits.
  106725. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106726. * @param upperLimit The upper limit of the motor
  106727. * @param lowerLimit The lower limit of the motor
  106728. */
  106729. setLimit(upperLimit: number, lowerLimit?: number): void;
  106730. }
  106731. /**
  106732. * This class represents a single physics Hinge-Joint
  106733. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106734. */
  106735. export class HingeJoint extends MotorEnabledJoint {
  106736. /**
  106737. * Initializes the Hinge-Joint
  106738. * @param jointData The joint data for the Hinge-Joint
  106739. */
  106740. constructor(jointData: PhysicsJointData);
  106741. /**
  106742. * Set the motor values.
  106743. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106744. * @param {number} force the force to apply
  106745. * @param {number} maxForce max force for this motor.
  106746. */
  106747. setMotor(force?: number, maxForce?: number): void;
  106748. /**
  106749. * Set the motor's limits.
  106750. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106751. * @param upperLimit The upper limit of the motor
  106752. * @param lowerLimit The lower limit of the motor
  106753. */
  106754. setLimit(upperLimit: number, lowerLimit?: number): void;
  106755. }
  106756. /**
  106757. * This class represents a dual hinge physics joint (same as wheel joint)
  106758. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106759. */
  106760. export class Hinge2Joint extends MotorEnabledJoint {
  106761. /**
  106762. * Initializes the Hinge2-Joint
  106763. * @param jointData The joint data for the Hinge2-Joint
  106764. */
  106765. constructor(jointData: PhysicsJointData);
  106766. /**
  106767. * Set the motor values.
  106768. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106769. * @param {number} targetSpeed the speed the motor is to reach
  106770. * @param {number} maxForce max force for this motor.
  106771. * @param {motorIndex} the motor's index, 0 or 1.
  106772. */
  106773. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  106774. /**
  106775. * Set the motor limits.
  106776. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106777. * @param {number} upperLimit the upper limit
  106778. * @param {number} lowerLimit lower limit
  106779. * @param {motorIndex} the motor's index, 0 or 1.
  106780. */
  106781. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106782. }
  106783. /**
  106784. * Interface for a motor enabled joint
  106785. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106786. */
  106787. export interface IMotorEnabledJoint {
  106788. /**
  106789. * Physics joint
  106790. */
  106791. physicsJoint: any;
  106792. /**
  106793. * Sets the motor of the motor-enabled joint
  106794. * @param force The force of the motor
  106795. * @param maxForce The maximum force of the motor
  106796. * @param motorIndex The index of the motor
  106797. */
  106798. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  106799. /**
  106800. * Sets the limit of the motor
  106801. * @param upperLimit The upper limit of the motor
  106802. * @param lowerLimit The lower limit of the motor
  106803. * @param motorIndex The index of the motor
  106804. */
  106805. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106806. }
  106807. /**
  106808. * Joint data for a Distance-Joint
  106809. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106810. */
  106811. export interface DistanceJointData extends PhysicsJointData {
  106812. /**
  106813. * Max distance the 2 joint objects can be apart
  106814. */
  106815. maxDistance: number;
  106816. }
  106817. /**
  106818. * Joint data from a spring joint
  106819. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106820. */
  106821. export interface SpringJointData extends PhysicsJointData {
  106822. /**
  106823. * Length of the spring
  106824. */
  106825. length: number;
  106826. /**
  106827. * Stiffness of the spring
  106828. */
  106829. stiffness: number;
  106830. /**
  106831. * Damping of the spring
  106832. */
  106833. damping: number;
  106834. /** this callback will be called when applying the force to the impostors. */
  106835. forceApplicationCallback: () => void;
  106836. }
  106837. }
  106838. declare module BABYLON {
  106839. /**
  106840. * Holds the data for the raycast result
  106841. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106842. */
  106843. export class PhysicsRaycastResult {
  106844. private _hasHit;
  106845. private _hitDistance;
  106846. private _hitNormalWorld;
  106847. private _hitPointWorld;
  106848. private _rayFromWorld;
  106849. private _rayToWorld;
  106850. /**
  106851. * Gets if there was a hit
  106852. */
  106853. get hasHit(): boolean;
  106854. /**
  106855. * Gets the distance from the hit
  106856. */
  106857. get hitDistance(): number;
  106858. /**
  106859. * Gets the hit normal/direction in the world
  106860. */
  106861. get hitNormalWorld(): Vector3;
  106862. /**
  106863. * Gets the hit point in the world
  106864. */
  106865. get hitPointWorld(): Vector3;
  106866. /**
  106867. * Gets the ray "start point" of the ray in the world
  106868. */
  106869. get rayFromWorld(): Vector3;
  106870. /**
  106871. * Gets the ray "end point" of the ray in the world
  106872. */
  106873. get rayToWorld(): Vector3;
  106874. /**
  106875. * Sets the hit data (normal & point in world space)
  106876. * @param hitNormalWorld defines the normal in world space
  106877. * @param hitPointWorld defines the point in world space
  106878. */
  106879. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  106880. /**
  106881. * Sets the distance from the start point to the hit point
  106882. * @param distance
  106883. */
  106884. setHitDistance(distance: number): void;
  106885. /**
  106886. * Calculates the distance manually
  106887. */
  106888. calculateHitDistance(): void;
  106889. /**
  106890. * Resets all the values to default
  106891. * @param from The from point on world space
  106892. * @param to The to point on world space
  106893. */
  106894. reset(from?: Vector3, to?: Vector3): void;
  106895. }
  106896. /**
  106897. * Interface for the size containing width and height
  106898. */
  106899. interface IXYZ {
  106900. /**
  106901. * X
  106902. */
  106903. x: number;
  106904. /**
  106905. * Y
  106906. */
  106907. y: number;
  106908. /**
  106909. * Z
  106910. */
  106911. z: number;
  106912. }
  106913. }
  106914. declare module BABYLON {
  106915. /**
  106916. * Interface used to describe a physics joint
  106917. */
  106918. export interface PhysicsImpostorJoint {
  106919. /** Defines the main impostor to which the joint is linked */
  106920. mainImpostor: PhysicsImpostor;
  106921. /** Defines the impostor that is connected to the main impostor using this joint */
  106922. connectedImpostor: PhysicsImpostor;
  106923. /** Defines the joint itself */
  106924. joint: PhysicsJoint;
  106925. }
  106926. /** @hidden */
  106927. export interface IPhysicsEnginePlugin {
  106928. world: any;
  106929. name: string;
  106930. setGravity(gravity: Vector3): void;
  106931. setTimeStep(timeStep: number): void;
  106932. getTimeStep(): number;
  106933. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  106934. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106935. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106936. generatePhysicsBody(impostor: PhysicsImpostor): void;
  106937. removePhysicsBody(impostor: PhysicsImpostor): void;
  106938. generateJoint(joint: PhysicsImpostorJoint): void;
  106939. removeJoint(joint: PhysicsImpostorJoint): void;
  106940. isSupported(): boolean;
  106941. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  106942. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  106943. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106944. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106945. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106946. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106947. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  106948. getBodyMass(impostor: PhysicsImpostor): number;
  106949. getBodyFriction(impostor: PhysicsImpostor): number;
  106950. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  106951. getBodyRestitution(impostor: PhysicsImpostor): number;
  106952. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  106953. getBodyPressure?(impostor: PhysicsImpostor): number;
  106954. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  106955. getBodyStiffness?(impostor: PhysicsImpostor): number;
  106956. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  106957. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  106958. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  106959. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  106960. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  106961. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106962. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106963. sleepBody(impostor: PhysicsImpostor): void;
  106964. wakeUpBody(impostor: PhysicsImpostor): void;
  106965. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  106966. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  106967. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  106968. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106969. getRadius(impostor: PhysicsImpostor): number;
  106970. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  106971. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  106972. dispose(): void;
  106973. }
  106974. /**
  106975. * Interface used to define a physics engine
  106976. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106977. */
  106978. export interface IPhysicsEngine {
  106979. /**
  106980. * Gets the gravity vector used by the simulation
  106981. */
  106982. gravity: Vector3;
  106983. /**
  106984. * Sets the gravity vector used by the simulation
  106985. * @param gravity defines the gravity vector to use
  106986. */
  106987. setGravity(gravity: Vector3): void;
  106988. /**
  106989. * Set the time step of the physics engine.
  106990. * Default is 1/60.
  106991. * To slow it down, enter 1/600 for example.
  106992. * To speed it up, 1/30
  106993. * @param newTimeStep the new timestep to apply to this world.
  106994. */
  106995. setTimeStep(newTimeStep: number): void;
  106996. /**
  106997. * Get the time step of the physics engine.
  106998. * @returns the current time step
  106999. */
  107000. getTimeStep(): number;
  107001. /**
  107002. * Set the sub time step of the physics engine.
  107003. * Default is 0 meaning there is no sub steps
  107004. * To increase physics resolution precision, set a small value (like 1 ms)
  107005. * @param subTimeStep defines the new sub timestep used for physics resolution.
  107006. */
  107007. setSubTimeStep(subTimeStep: number): void;
  107008. /**
  107009. * Get the sub time step of the physics engine.
  107010. * @returns the current sub time step
  107011. */
  107012. getSubTimeStep(): number;
  107013. /**
  107014. * Release all resources
  107015. */
  107016. dispose(): void;
  107017. /**
  107018. * Gets the name of the current physics plugin
  107019. * @returns the name of the plugin
  107020. */
  107021. getPhysicsPluginName(): string;
  107022. /**
  107023. * Adding a new impostor for the impostor tracking.
  107024. * This will be done by the impostor itself.
  107025. * @param impostor the impostor to add
  107026. */
  107027. addImpostor(impostor: PhysicsImpostor): void;
  107028. /**
  107029. * Remove an impostor from the engine.
  107030. * This impostor and its mesh will not longer be updated by the physics engine.
  107031. * @param impostor the impostor to remove
  107032. */
  107033. removeImpostor(impostor: PhysicsImpostor): void;
  107034. /**
  107035. * Add a joint to the physics engine
  107036. * @param mainImpostor defines the main impostor to which the joint is added.
  107037. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  107038. * @param joint defines the joint that will connect both impostors.
  107039. */
  107040. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107041. /**
  107042. * Removes a joint from the simulation
  107043. * @param mainImpostor defines the impostor used with the joint
  107044. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  107045. * @param joint defines the joint to remove
  107046. */
  107047. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107048. /**
  107049. * Gets the current plugin used to run the simulation
  107050. * @returns current plugin
  107051. */
  107052. getPhysicsPlugin(): IPhysicsEnginePlugin;
  107053. /**
  107054. * Gets the list of physic impostors
  107055. * @returns an array of PhysicsImpostor
  107056. */
  107057. getImpostors(): Array<PhysicsImpostor>;
  107058. /**
  107059. * Gets the impostor for a physics enabled object
  107060. * @param object defines the object impersonated by the impostor
  107061. * @returns the PhysicsImpostor or null if not found
  107062. */
  107063. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107064. /**
  107065. * Gets the impostor for a physics body object
  107066. * @param body defines physics body used by the impostor
  107067. * @returns the PhysicsImpostor or null if not found
  107068. */
  107069. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  107070. /**
  107071. * Does a raycast in the physics world
  107072. * @param from when should the ray start?
  107073. * @param to when should the ray end?
  107074. * @returns PhysicsRaycastResult
  107075. */
  107076. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  107077. /**
  107078. * Called by the scene. No need to call it.
  107079. * @param delta defines the timespam between frames
  107080. */
  107081. _step(delta: number): void;
  107082. }
  107083. }
  107084. declare module BABYLON {
  107085. /**
  107086. * The interface for the physics imposter parameters
  107087. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107088. */
  107089. export interface PhysicsImpostorParameters {
  107090. /**
  107091. * The mass of the physics imposter
  107092. */
  107093. mass: number;
  107094. /**
  107095. * The friction of the physics imposter
  107096. */
  107097. friction?: number;
  107098. /**
  107099. * The coefficient of restitution of the physics imposter
  107100. */
  107101. restitution?: number;
  107102. /**
  107103. * The native options of the physics imposter
  107104. */
  107105. nativeOptions?: any;
  107106. /**
  107107. * Specifies if the parent should be ignored
  107108. */
  107109. ignoreParent?: boolean;
  107110. /**
  107111. * Specifies if bi-directional transformations should be disabled
  107112. */
  107113. disableBidirectionalTransformation?: boolean;
  107114. /**
  107115. * The pressure inside the physics imposter, soft object only
  107116. */
  107117. pressure?: number;
  107118. /**
  107119. * The stiffness the physics imposter, soft object only
  107120. */
  107121. stiffness?: number;
  107122. /**
  107123. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  107124. */
  107125. velocityIterations?: number;
  107126. /**
  107127. * The number of iterations used in maintaining consistent vertex positions, soft object only
  107128. */
  107129. positionIterations?: number;
  107130. /**
  107131. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  107132. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  107133. * Add to fix multiple points
  107134. */
  107135. fixedPoints?: number;
  107136. /**
  107137. * The collision margin around a soft object
  107138. */
  107139. margin?: number;
  107140. /**
  107141. * The collision margin around a soft object
  107142. */
  107143. damping?: number;
  107144. /**
  107145. * The path for a rope based on an extrusion
  107146. */
  107147. path?: any;
  107148. /**
  107149. * The shape of an extrusion used for a rope based on an extrusion
  107150. */
  107151. shape?: any;
  107152. }
  107153. /**
  107154. * Interface for a physics-enabled object
  107155. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107156. */
  107157. export interface IPhysicsEnabledObject {
  107158. /**
  107159. * The position of the physics-enabled object
  107160. */
  107161. position: Vector3;
  107162. /**
  107163. * The rotation of the physics-enabled object
  107164. */
  107165. rotationQuaternion: Nullable<Quaternion>;
  107166. /**
  107167. * The scale of the physics-enabled object
  107168. */
  107169. scaling: Vector3;
  107170. /**
  107171. * The rotation of the physics-enabled object
  107172. */
  107173. rotation?: Vector3;
  107174. /**
  107175. * The parent of the physics-enabled object
  107176. */
  107177. parent?: any;
  107178. /**
  107179. * The bounding info of the physics-enabled object
  107180. * @returns The bounding info of the physics-enabled object
  107181. */
  107182. getBoundingInfo(): BoundingInfo;
  107183. /**
  107184. * Computes the world matrix
  107185. * @param force Specifies if the world matrix should be computed by force
  107186. * @returns A world matrix
  107187. */
  107188. computeWorldMatrix(force: boolean): Matrix;
  107189. /**
  107190. * Gets the world matrix
  107191. * @returns A world matrix
  107192. */
  107193. getWorldMatrix?(): Matrix;
  107194. /**
  107195. * Gets the child meshes
  107196. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  107197. * @returns An array of abstract meshes
  107198. */
  107199. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  107200. /**
  107201. * Gets the vertex data
  107202. * @param kind The type of vertex data
  107203. * @returns A nullable array of numbers, or a float32 array
  107204. */
  107205. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  107206. /**
  107207. * Gets the indices from the mesh
  107208. * @returns A nullable array of index arrays
  107209. */
  107210. getIndices?(): Nullable<IndicesArray>;
  107211. /**
  107212. * Gets the scene from the mesh
  107213. * @returns the indices array or null
  107214. */
  107215. getScene?(): Scene;
  107216. /**
  107217. * Gets the absolute position from the mesh
  107218. * @returns the absolute position
  107219. */
  107220. getAbsolutePosition(): Vector3;
  107221. /**
  107222. * Gets the absolute pivot point from the mesh
  107223. * @returns the absolute pivot point
  107224. */
  107225. getAbsolutePivotPoint(): Vector3;
  107226. /**
  107227. * Rotates the mesh
  107228. * @param axis The axis of rotation
  107229. * @param amount The amount of rotation
  107230. * @param space The space of the rotation
  107231. * @returns The rotation transform node
  107232. */
  107233. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  107234. /**
  107235. * Translates the mesh
  107236. * @param axis The axis of translation
  107237. * @param distance The distance of translation
  107238. * @param space The space of the translation
  107239. * @returns The transform node
  107240. */
  107241. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  107242. /**
  107243. * Sets the absolute position of the mesh
  107244. * @param absolutePosition The absolute position of the mesh
  107245. * @returns The transform node
  107246. */
  107247. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  107248. /**
  107249. * Gets the class name of the mesh
  107250. * @returns The class name
  107251. */
  107252. getClassName(): string;
  107253. }
  107254. /**
  107255. * Represents a physics imposter
  107256. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107257. */
  107258. export class PhysicsImpostor {
  107259. /**
  107260. * The physics-enabled object used as the physics imposter
  107261. */
  107262. object: IPhysicsEnabledObject;
  107263. /**
  107264. * The type of the physics imposter
  107265. */
  107266. type: number;
  107267. private _options;
  107268. private _scene?;
  107269. /**
  107270. * The default object size of the imposter
  107271. */
  107272. static DEFAULT_OBJECT_SIZE: Vector3;
  107273. /**
  107274. * The identity quaternion of the imposter
  107275. */
  107276. static IDENTITY_QUATERNION: Quaternion;
  107277. /** @hidden */
  107278. _pluginData: any;
  107279. private _physicsEngine;
  107280. private _physicsBody;
  107281. private _bodyUpdateRequired;
  107282. private _onBeforePhysicsStepCallbacks;
  107283. private _onAfterPhysicsStepCallbacks;
  107284. /** @hidden */
  107285. _onPhysicsCollideCallbacks: Array<{
  107286. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  107287. otherImpostors: Array<PhysicsImpostor>;
  107288. }>;
  107289. private _deltaPosition;
  107290. private _deltaRotation;
  107291. private _deltaRotationConjugated;
  107292. /** @hidden */
  107293. _isFromLine: boolean;
  107294. private _parent;
  107295. private _isDisposed;
  107296. private static _tmpVecs;
  107297. private static _tmpQuat;
  107298. /**
  107299. * Specifies if the physics imposter is disposed
  107300. */
  107301. get isDisposed(): boolean;
  107302. /**
  107303. * Gets the mass of the physics imposter
  107304. */
  107305. get mass(): number;
  107306. set mass(value: number);
  107307. /**
  107308. * Gets the coefficient of friction
  107309. */
  107310. get friction(): number;
  107311. /**
  107312. * Sets the coefficient of friction
  107313. */
  107314. set friction(value: number);
  107315. /**
  107316. * Gets the coefficient of restitution
  107317. */
  107318. get restitution(): number;
  107319. /**
  107320. * Sets the coefficient of restitution
  107321. */
  107322. set restitution(value: number);
  107323. /**
  107324. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  107325. */
  107326. get pressure(): number;
  107327. /**
  107328. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  107329. */
  107330. set pressure(value: number);
  107331. /**
  107332. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107333. */
  107334. get stiffness(): number;
  107335. /**
  107336. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107337. */
  107338. set stiffness(value: number);
  107339. /**
  107340. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107341. */
  107342. get velocityIterations(): number;
  107343. /**
  107344. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107345. */
  107346. set velocityIterations(value: number);
  107347. /**
  107348. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107349. */
  107350. get positionIterations(): number;
  107351. /**
  107352. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107353. */
  107354. set positionIterations(value: number);
  107355. /**
  107356. * The unique id of the physics imposter
  107357. * set by the physics engine when adding this impostor to the array
  107358. */
  107359. uniqueId: number;
  107360. /**
  107361. * @hidden
  107362. */
  107363. soft: boolean;
  107364. /**
  107365. * @hidden
  107366. */
  107367. segments: number;
  107368. private _joints;
  107369. /**
  107370. * Initializes the physics imposter
  107371. * @param object The physics-enabled object used as the physics imposter
  107372. * @param type The type of the physics imposter
  107373. * @param _options The options for the physics imposter
  107374. * @param _scene The Babylon scene
  107375. */
  107376. constructor(
  107377. /**
  107378. * The physics-enabled object used as the physics imposter
  107379. */
  107380. object: IPhysicsEnabledObject,
  107381. /**
  107382. * The type of the physics imposter
  107383. */
  107384. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  107385. /**
  107386. * This function will completly initialize this impostor.
  107387. * It will create a new body - but only if this mesh has no parent.
  107388. * If it has, this impostor will not be used other than to define the impostor
  107389. * of the child mesh.
  107390. * @hidden
  107391. */
  107392. _init(): void;
  107393. private _getPhysicsParent;
  107394. /**
  107395. * Should a new body be generated.
  107396. * @returns boolean specifying if body initialization is required
  107397. */
  107398. isBodyInitRequired(): boolean;
  107399. /**
  107400. * Sets the updated scaling
  107401. * @param updated Specifies if the scaling is updated
  107402. */
  107403. setScalingUpdated(): void;
  107404. /**
  107405. * Force a regeneration of this or the parent's impostor's body.
  107406. * Use under cautious - This will remove all joints already implemented.
  107407. */
  107408. forceUpdate(): void;
  107409. /**
  107410. * Gets the body that holds this impostor. Either its own, or its parent.
  107411. */
  107412. get physicsBody(): any;
  107413. /**
  107414. * Get the parent of the physics imposter
  107415. * @returns Physics imposter or null
  107416. */
  107417. get parent(): Nullable<PhysicsImpostor>;
  107418. /**
  107419. * Sets the parent of the physics imposter
  107420. */
  107421. set parent(value: Nullable<PhysicsImpostor>);
  107422. /**
  107423. * Set the physics body. Used mainly by the physics engine/plugin
  107424. */
  107425. set physicsBody(physicsBody: any);
  107426. /**
  107427. * Resets the update flags
  107428. */
  107429. resetUpdateFlags(): void;
  107430. /**
  107431. * Gets the object extend size
  107432. * @returns the object extend size
  107433. */
  107434. getObjectExtendSize(): Vector3;
  107435. /**
  107436. * Gets the object center
  107437. * @returns The object center
  107438. */
  107439. getObjectCenter(): Vector3;
  107440. /**
  107441. * Get a specific parameter from the options parameters
  107442. * @param paramName The object parameter name
  107443. * @returns The object parameter
  107444. */
  107445. getParam(paramName: string): any;
  107446. /**
  107447. * Sets a specific parameter in the options given to the physics plugin
  107448. * @param paramName The parameter name
  107449. * @param value The value of the parameter
  107450. */
  107451. setParam(paramName: string, value: number): void;
  107452. /**
  107453. * Specifically change the body's mass option. Won't recreate the physics body object
  107454. * @param mass The mass of the physics imposter
  107455. */
  107456. setMass(mass: number): void;
  107457. /**
  107458. * Gets the linear velocity
  107459. * @returns linear velocity or null
  107460. */
  107461. getLinearVelocity(): Nullable<Vector3>;
  107462. /**
  107463. * Sets the linear velocity
  107464. * @param velocity linear velocity or null
  107465. */
  107466. setLinearVelocity(velocity: Nullable<Vector3>): void;
  107467. /**
  107468. * Gets the angular velocity
  107469. * @returns angular velocity or null
  107470. */
  107471. getAngularVelocity(): Nullable<Vector3>;
  107472. /**
  107473. * Sets the angular velocity
  107474. * @param velocity The velocity or null
  107475. */
  107476. setAngularVelocity(velocity: Nullable<Vector3>): void;
  107477. /**
  107478. * Execute a function with the physics plugin native code
  107479. * Provide a function the will have two variables - the world object and the physics body object
  107480. * @param func The function to execute with the physics plugin native code
  107481. */
  107482. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  107483. /**
  107484. * Register a function that will be executed before the physics world is stepping forward
  107485. * @param func The function to execute before the physics world is stepped forward
  107486. */
  107487. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107488. /**
  107489. * Unregister a function that will be executed before the physics world is stepping forward
  107490. * @param func The function to execute before the physics world is stepped forward
  107491. */
  107492. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107493. /**
  107494. * Register a function that will be executed after the physics step
  107495. * @param func The function to execute after physics step
  107496. */
  107497. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107498. /**
  107499. * Unregisters a function that will be executed after the physics step
  107500. * @param func The function to execute after physics step
  107501. */
  107502. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107503. /**
  107504. * register a function that will be executed when this impostor collides against a different body
  107505. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  107506. * @param func Callback that is executed on collision
  107507. */
  107508. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  107509. /**
  107510. * Unregisters the physics imposter on contact
  107511. * @param collideAgainst The physics object to collide against
  107512. * @param func Callback to execute on collision
  107513. */
  107514. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  107515. private _tmpQuat;
  107516. private _tmpQuat2;
  107517. /**
  107518. * Get the parent rotation
  107519. * @returns The parent rotation
  107520. */
  107521. getParentsRotation(): Quaternion;
  107522. /**
  107523. * this function is executed by the physics engine.
  107524. */
  107525. beforeStep: () => void;
  107526. /**
  107527. * this function is executed by the physics engine
  107528. */
  107529. afterStep: () => void;
  107530. /**
  107531. * Legacy collision detection event support
  107532. */
  107533. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  107534. /**
  107535. * event and body object due to cannon's event-based architecture.
  107536. */
  107537. onCollide: (e: {
  107538. body: any;
  107539. }) => void;
  107540. /**
  107541. * Apply a force
  107542. * @param force The force to apply
  107543. * @param contactPoint The contact point for the force
  107544. * @returns The physics imposter
  107545. */
  107546. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107547. /**
  107548. * Apply an impulse
  107549. * @param force The impulse force
  107550. * @param contactPoint The contact point for the impulse force
  107551. * @returns The physics imposter
  107552. */
  107553. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107554. /**
  107555. * A help function to create a joint
  107556. * @param otherImpostor A physics imposter used to create a joint
  107557. * @param jointType The type of joint
  107558. * @param jointData The data for the joint
  107559. * @returns The physics imposter
  107560. */
  107561. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  107562. /**
  107563. * Add a joint to this impostor with a different impostor
  107564. * @param otherImpostor A physics imposter used to add a joint
  107565. * @param joint The joint to add
  107566. * @returns The physics imposter
  107567. */
  107568. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  107569. /**
  107570. * Add an anchor to a cloth impostor
  107571. * @param otherImpostor rigid impostor to anchor to
  107572. * @param width ratio across width from 0 to 1
  107573. * @param height ratio up height from 0 to 1
  107574. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  107575. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  107576. * @returns impostor the soft imposter
  107577. */
  107578. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107579. /**
  107580. * Add a hook to a rope impostor
  107581. * @param otherImpostor rigid impostor to anchor to
  107582. * @param length ratio across rope from 0 to 1
  107583. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  107584. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  107585. * @returns impostor the rope imposter
  107586. */
  107587. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107588. /**
  107589. * Will keep this body still, in a sleep mode.
  107590. * @returns the physics imposter
  107591. */
  107592. sleep(): PhysicsImpostor;
  107593. /**
  107594. * Wake the body up.
  107595. * @returns The physics imposter
  107596. */
  107597. wakeUp(): PhysicsImpostor;
  107598. /**
  107599. * Clones the physics imposter
  107600. * @param newObject The physics imposter clones to this physics-enabled object
  107601. * @returns A nullable physics imposter
  107602. */
  107603. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107604. /**
  107605. * Disposes the physics imposter
  107606. */
  107607. dispose(): void;
  107608. /**
  107609. * Sets the delta position
  107610. * @param position The delta position amount
  107611. */
  107612. setDeltaPosition(position: Vector3): void;
  107613. /**
  107614. * Sets the delta rotation
  107615. * @param rotation The delta rotation amount
  107616. */
  107617. setDeltaRotation(rotation: Quaternion): void;
  107618. /**
  107619. * Gets the box size of the physics imposter and stores the result in the input parameter
  107620. * @param result Stores the box size
  107621. * @returns The physics imposter
  107622. */
  107623. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  107624. /**
  107625. * Gets the radius of the physics imposter
  107626. * @returns Radius of the physics imposter
  107627. */
  107628. getRadius(): number;
  107629. /**
  107630. * Sync a bone with this impostor
  107631. * @param bone The bone to sync to the impostor.
  107632. * @param boneMesh The mesh that the bone is influencing.
  107633. * @param jointPivot The pivot of the joint / bone in local space.
  107634. * @param distToJoint Optional distance from the impostor to the joint.
  107635. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107636. */
  107637. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  107638. /**
  107639. * Sync impostor to a bone
  107640. * @param bone The bone that the impostor will be synced to.
  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. * @param boneAxis Optional vector3 axis the bone is aligned with
  107646. */
  107647. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  107648. /**
  107649. * No-Imposter type
  107650. */
  107651. static NoImpostor: number;
  107652. /**
  107653. * Sphere-Imposter type
  107654. */
  107655. static SphereImpostor: number;
  107656. /**
  107657. * Box-Imposter type
  107658. */
  107659. static BoxImpostor: number;
  107660. /**
  107661. * Plane-Imposter type
  107662. */
  107663. static PlaneImpostor: number;
  107664. /**
  107665. * Mesh-imposter type
  107666. */
  107667. static MeshImpostor: number;
  107668. /**
  107669. * Capsule-Impostor type (Ammo.js plugin only)
  107670. */
  107671. static CapsuleImpostor: number;
  107672. /**
  107673. * Cylinder-Imposter type
  107674. */
  107675. static CylinderImpostor: number;
  107676. /**
  107677. * Particle-Imposter type
  107678. */
  107679. static ParticleImpostor: number;
  107680. /**
  107681. * Heightmap-Imposter type
  107682. */
  107683. static HeightmapImpostor: number;
  107684. /**
  107685. * ConvexHull-Impostor type (Ammo.js plugin only)
  107686. */
  107687. static ConvexHullImpostor: number;
  107688. /**
  107689. * Custom-Imposter type (Ammo.js plugin only)
  107690. */
  107691. static CustomImpostor: number;
  107692. /**
  107693. * Rope-Imposter type
  107694. */
  107695. static RopeImpostor: number;
  107696. /**
  107697. * Cloth-Imposter type
  107698. */
  107699. static ClothImpostor: number;
  107700. /**
  107701. * Softbody-Imposter type
  107702. */
  107703. static SoftbodyImpostor: number;
  107704. }
  107705. }
  107706. declare module BABYLON {
  107707. /**
  107708. * @hidden
  107709. **/
  107710. export class _CreationDataStorage {
  107711. closePath?: boolean;
  107712. closeArray?: boolean;
  107713. idx: number[];
  107714. dashSize: number;
  107715. gapSize: number;
  107716. path3D: Path3D;
  107717. pathArray: Vector3[][];
  107718. arc: number;
  107719. radius: number;
  107720. cap: number;
  107721. tessellation: number;
  107722. }
  107723. /**
  107724. * @hidden
  107725. **/
  107726. class _InstanceDataStorage {
  107727. visibleInstances: any;
  107728. batchCache: _InstancesBatch;
  107729. instancesBufferSize: number;
  107730. instancesBuffer: Nullable<Buffer>;
  107731. instancesData: Float32Array;
  107732. overridenInstanceCount: number;
  107733. isFrozen: boolean;
  107734. previousBatch: Nullable<_InstancesBatch>;
  107735. hardwareInstancedRendering: boolean;
  107736. sideOrientation: number;
  107737. manualUpdate: boolean;
  107738. }
  107739. /**
  107740. * @hidden
  107741. **/
  107742. export class _InstancesBatch {
  107743. mustReturn: boolean;
  107744. visibleInstances: Nullable<InstancedMesh[]>[];
  107745. renderSelf: boolean[];
  107746. hardwareInstancedRendering: boolean[];
  107747. }
  107748. /**
  107749. * @hidden
  107750. **/
  107751. class _ThinInstanceDataStorage {
  107752. instancesCount: number;
  107753. matrixBuffer: Nullable<Buffer>;
  107754. matrixBufferSize: number;
  107755. matrixData: Nullable<Float32Array>;
  107756. boundingVectors: Array<Vector3>;
  107757. worldMatrices: Nullable<Matrix[]>;
  107758. }
  107759. /**
  107760. * Class used to represent renderable models
  107761. */
  107762. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  107763. /**
  107764. * Mesh side orientation : usually the external or front surface
  107765. */
  107766. static readonly FRONTSIDE: number;
  107767. /**
  107768. * Mesh side orientation : usually the internal or back surface
  107769. */
  107770. static readonly BACKSIDE: number;
  107771. /**
  107772. * Mesh side orientation : both internal and external or front and back surfaces
  107773. */
  107774. static readonly DOUBLESIDE: number;
  107775. /**
  107776. * Mesh side orientation : by default, `FRONTSIDE`
  107777. */
  107778. static readonly DEFAULTSIDE: number;
  107779. /**
  107780. * Mesh cap setting : no cap
  107781. */
  107782. static readonly NO_CAP: number;
  107783. /**
  107784. * Mesh cap setting : one cap at the beginning of the mesh
  107785. */
  107786. static readonly CAP_START: number;
  107787. /**
  107788. * Mesh cap setting : one cap at the end of the mesh
  107789. */
  107790. static readonly CAP_END: number;
  107791. /**
  107792. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  107793. */
  107794. static readonly CAP_ALL: number;
  107795. /**
  107796. * Mesh pattern setting : no flip or rotate
  107797. */
  107798. static readonly NO_FLIP: number;
  107799. /**
  107800. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  107801. */
  107802. static readonly FLIP_TILE: number;
  107803. /**
  107804. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  107805. */
  107806. static readonly ROTATE_TILE: number;
  107807. /**
  107808. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  107809. */
  107810. static readonly FLIP_ROW: number;
  107811. /**
  107812. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  107813. */
  107814. static readonly ROTATE_ROW: number;
  107815. /**
  107816. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  107817. */
  107818. static readonly FLIP_N_ROTATE_TILE: number;
  107819. /**
  107820. * Mesh pattern setting : rotate pattern and rotate
  107821. */
  107822. static readonly FLIP_N_ROTATE_ROW: number;
  107823. /**
  107824. * Mesh tile positioning : part tiles same on left/right or top/bottom
  107825. */
  107826. static readonly CENTER: number;
  107827. /**
  107828. * Mesh tile positioning : part tiles on left
  107829. */
  107830. static readonly LEFT: number;
  107831. /**
  107832. * Mesh tile positioning : part tiles on right
  107833. */
  107834. static readonly RIGHT: number;
  107835. /**
  107836. * Mesh tile positioning : part tiles on top
  107837. */
  107838. static readonly TOP: number;
  107839. /**
  107840. * Mesh tile positioning : part tiles on bottom
  107841. */
  107842. static readonly BOTTOM: number;
  107843. /**
  107844. * Gets the default side orientation.
  107845. * @param orientation the orientation to value to attempt to get
  107846. * @returns the default orientation
  107847. * @hidden
  107848. */
  107849. static _GetDefaultSideOrientation(orientation?: number): number;
  107850. private _internalMeshDataInfo;
  107851. get computeBonesUsingShaders(): boolean;
  107852. set computeBonesUsingShaders(value: boolean);
  107853. /**
  107854. * An event triggered before rendering the mesh
  107855. */
  107856. get onBeforeRenderObservable(): Observable<Mesh>;
  107857. /**
  107858. * An event triggered before binding the mesh
  107859. */
  107860. get onBeforeBindObservable(): Observable<Mesh>;
  107861. /**
  107862. * An event triggered after rendering the mesh
  107863. */
  107864. get onAfterRenderObservable(): Observable<Mesh>;
  107865. /**
  107866. * An event triggered before drawing the mesh
  107867. */
  107868. get onBeforeDrawObservable(): Observable<Mesh>;
  107869. private _onBeforeDrawObserver;
  107870. /**
  107871. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  107872. */
  107873. set onBeforeDraw(callback: () => void);
  107874. get hasInstances(): boolean;
  107875. get hasThinInstances(): boolean;
  107876. /**
  107877. * Gets the delay loading state of the mesh (when delay loading is turned on)
  107878. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  107879. */
  107880. delayLoadState: number;
  107881. /**
  107882. * Gets the list of instances created from this mesh
  107883. * it is not supposed to be modified manually.
  107884. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  107885. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  107886. */
  107887. instances: InstancedMesh[];
  107888. /**
  107889. * Gets the file containing delay loading data for this mesh
  107890. */
  107891. delayLoadingFile: string;
  107892. /** @hidden */
  107893. _binaryInfo: any;
  107894. /**
  107895. * User defined function used to change how LOD level selection is done
  107896. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107897. */
  107898. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  107899. /**
  107900. * Gets or sets the morph target manager
  107901. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  107902. */
  107903. get morphTargetManager(): Nullable<MorphTargetManager>;
  107904. set morphTargetManager(value: Nullable<MorphTargetManager>);
  107905. /** @hidden */
  107906. _creationDataStorage: Nullable<_CreationDataStorage>;
  107907. /** @hidden */
  107908. _geometry: Nullable<Geometry>;
  107909. /** @hidden */
  107910. _delayInfo: Array<string>;
  107911. /** @hidden */
  107912. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  107913. /** @hidden */
  107914. _instanceDataStorage: _InstanceDataStorage;
  107915. /** @hidden */
  107916. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  107917. private _effectiveMaterial;
  107918. /** @hidden */
  107919. _shouldGenerateFlatShading: boolean;
  107920. /** @hidden */
  107921. _originalBuilderSideOrientation: number;
  107922. /**
  107923. * Use this property to change the original side orientation defined at construction time
  107924. */
  107925. overrideMaterialSideOrientation: Nullable<number>;
  107926. /**
  107927. * Gets the source mesh (the one used to clone this one from)
  107928. */
  107929. get source(): Nullable<Mesh>;
  107930. /**
  107931. * Gets the list of clones of this mesh
  107932. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  107933. * Note that useClonedMeshMap=true is the default setting
  107934. */
  107935. get cloneMeshMap(): Nullable<{
  107936. [id: string]: Mesh | undefined;
  107937. }>;
  107938. /**
  107939. * Gets or sets a boolean indicating that this mesh does not use index buffer
  107940. */
  107941. get isUnIndexed(): boolean;
  107942. set isUnIndexed(value: boolean);
  107943. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  107944. get worldMatrixInstancedBuffer(): Float32Array;
  107945. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  107946. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  107947. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  107948. /**
  107949. * @constructor
  107950. * @param name The value used by scene.getMeshByName() to do a lookup.
  107951. * @param scene The scene to add this mesh to.
  107952. * @param parent The parent of this mesh, if it has one
  107953. * @param source An optional Mesh from which geometry is shared, cloned.
  107954. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  107955. * When false, achieved by calling a clone(), also passing False.
  107956. * This will make creation of children, recursive.
  107957. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  107958. */
  107959. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  107960. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  107961. doNotInstantiate: boolean;
  107962. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  107963. /**
  107964. * Gets the class name
  107965. * @returns the string "Mesh".
  107966. */
  107967. getClassName(): string;
  107968. /** @hidden */
  107969. get _isMesh(): boolean;
  107970. /**
  107971. * Returns a description of this mesh
  107972. * @param fullDetails define if full details about this mesh must be used
  107973. * @returns a descriptive string representing this mesh
  107974. */
  107975. toString(fullDetails?: boolean): string;
  107976. /** @hidden */
  107977. _unBindEffect(): void;
  107978. /**
  107979. * Gets a boolean indicating if this mesh has LOD
  107980. */
  107981. get hasLODLevels(): boolean;
  107982. /**
  107983. * Gets the list of MeshLODLevel associated with the current mesh
  107984. * @returns an array of MeshLODLevel
  107985. */
  107986. getLODLevels(): MeshLODLevel[];
  107987. private _sortLODLevels;
  107988. /**
  107989. * Add a mesh as LOD level triggered at the given distance.
  107990. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107991. * @param distance The distance from the center of the object to show this level
  107992. * @param mesh The mesh to be added as LOD level (can be null)
  107993. * @return This mesh (for chaining)
  107994. */
  107995. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  107996. /**
  107997. * Returns the LOD level mesh at the passed distance or null if not found.
  107998. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107999. * @param distance The distance from the center of the object to show this level
  108000. * @returns a Mesh or `null`
  108001. */
  108002. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  108003. /**
  108004. * Remove a mesh from the LOD array
  108005. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108006. * @param mesh defines the mesh to be removed
  108007. * @return This mesh (for chaining)
  108008. */
  108009. removeLODLevel(mesh: Mesh): Mesh;
  108010. /**
  108011. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  108012. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108013. * @param camera defines the camera to use to compute distance
  108014. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  108015. * @return This mesh (for chaining)
  108016. */
  108017. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  108018. /**
  108019. * Gets the mesh internal Geometry object
  108020. */
  108021. get geometry(): Nullable<Geometry>;
  108022. /**
  108023. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  108024. * @returns the total number of vertices
  108025. */
  108026. getTotalVertices(): number;
  108027. /**
  108028. * Returns the content of an associated vertex buffer
  108029. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108030. * - VertexBuffer.PositionKind
  108031. * - VertexBuffer.UVKind
  108032. * - VertexBuffer.UV2Kind
  108033. * - VertexBuffer.UV3Kind
  108034. * - VertexBuffer.UV4Kind
  108035. * - VertexBuffer.UV5Kind
  108036. * - VertexBuffer.UV6Kind
  108037. * - VertexBuffer.ColorKind
  108038. * - VertexBuffer.MatricesIndicesKind
  108039. * - VertexBuffer.MatricesIndicesExtraKind
  108040. * - VertexBuffer.MatricesWeightsKind
  108041. * - VertexBuffer.MatricesWeightsExtraKind
  108042. * @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
  108043. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  108044. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  108045. */
  108046. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  108047. /**
  108048. * Returns the mesh VertexBuffer object from the requested `kind`
  108049. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108050. * - VertexBuffer.PositionKind
  108051. * - VertexBuffer.NormalKind
  108052. * - VertexBuffer.UVKind
  108053. * - VertexBuffer.UV2Kind
  108054. * - VertexBuffer.UV3Kind
  108055. * - VertexBuffer.UV4Kind
  108056. * - VertexBuffer.UV5Kind
  108057. * - VertexBuffer.UV6Kind
  108058. * - VertexBuffer.ColorKind
  108059. * - VertexBuffer.MatricesIndicesKind
  108060. * - VertexBuffer.MatricesIndicesExtraKind
  108061. * - VertexBuffer.MatricesWeightsKind
  108062. * - VertexBuffer.MatricesWeightsExtraKind
  108063. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  108064. */
  108065. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  108066. /**
  108067. * Tests if a specific vertex buffer is associated with this mesh
  108068. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108069. * - VertexBuffer.PositionKind
  108070. * - VertexBuffer.NormalKind
  108071. * - VertexBuffer.UVKind
  108072. * - VertexBuffer.UV2Kind
  108073. * - VertexBuffer.UV3Kind
  108074. * - VertexBuffer.UV4Kind
  108075. * - VertexBuffer.UV5Kind
  108076. * - VertexBuffer.UV6Kind
  108077. * - VertexBuffer.ColorKind
  108078. * - VertexBuffer.MatricesIndicesKind
  108079. * - VertexBuffer.MatricesIndicesExtraKind
  108080. * - VertexBuffer.MatricesWeightsKind
  108081. * - VertexBuffer.MatricesWeightsExtraKind
  108082. * @returns a boolean
  108083. */
  108084. isVerticesDataPresent(kind: string): boolean;
  108085. /**
  108086. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  108087. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108088. * - VertexBuffer.PositionKind
  108089. * - VertexBuffer.UVKind
  108090. * - VertexBuffer.UV2Kind
  108091. * - VertexBuffer.UV3Kind
  108092. * - VertexBuffer.UV4Kind
  108093. * - VertexBuffer.UV5Kind
  108094. * - VertexBuffer.UV6Kind
  108095. * - VertexBuffer.ColorKind
  108096. * - VertexBuffer.MatricesIndicesKind
  108097. * - VertexBuffer.MatricesIndicesExtraKind
  108098. * - VertexBuffer.MatricesWeightsKind
  108099. * - VertexBuffer.MatricesWeightsExtraKind
  108100. * @returns a boolean
  108101. */
  108102. isVertexBufferUpdatable(kind: string): boolean;
  108103. /**
  108104. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  108105. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108106. * - VertexBuffer.PositionKind
  108107. * - VertexBuffer.NormalKind
  108108. * - VertexBuffer.UVKind
  108109. * - VertexBuffer.UV2Kind
  108110. * - VertexBuffer.UV3Kind
  108111. * - VertexBuffer.UV4Kind
  108112. * - VertexBuffer.UV5Kind
  108113. * - VertexBuffer.UV6Kind
  108114. * - VertexBuffer.ColorKind
  108115. * - VertexBuffer.MatricesIndicesKind
  108116. * - VertexBuffer.MatricesIndicesExtraKind
  108117. * - VertexBuffer.MatricesWeightsKind
  108118. * - VertexBuffer.MatricesWeightsExtraKind
  108119. * @returns an array of strings
  108120. */
  108121. getVerticesDataKinds(): string[];
  108122. /**
  108123. * Returns a positive integer : the total number of indices in this mesh geometry.
  108124. * @returns the numner of indices or zero if the mesh has no geometry.
  108125. */
  108126. getTotalIndices(): number;
  108127. /**
  108128. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  108129. * @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.
  108130. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  108131. * @returns the indices array or an empty array if the mesh has no geometry
  108132. */
  108133. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  108134. get isBlocked(): boolean;
  108135. /**
  108136. * Determine if the current mesh is ready to be rendered
  108137. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  108138. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  108139. * @returns true if all associated assets are ready (material, textures, shaders)
  108140. */
  108141. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  108142. /**
  108143. * 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.
  108144. */
  108145. get areNormalsFrozen(): boolean;
  108146. /**
  108147. * 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.
  108148. * @returns the current mesh
  108149. */
  108150. freezeNormals(): Mesh;
  108151. /**
  108152. * 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
  108153. * @returns the current mesh
  108154. */
  108155. unfreezeNormals(): Mesh;
  108156. /**
  108157. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  108158. */
  108159. set overridenInstanceCount(count: number);
  108160. /** @hidden */
  108161. _preActivate(): Mesh;
  108162. /** @hidden */
  108163. _preActivateForIntermediateRendering(renderId: number): Mesh;
  108164. /** @hidden */
  108165. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  108166. protected _afterComputeWorldMatrix(): void;
  108167. /** @hidden */
  108168. _postActivate(): void;
  108169. /**
  108170. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  108171. * This means the mesh underlying bounding box and sphere are recomputed.
  108172. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  108173. * @returns the current mesh
  108174. */
  108175. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  108176. /** @hidden */
  108177. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  108178. /**
  108179. * This function will subdivide the mesh into multiple submeshes
  108180. * @param count defines the expected number of submeshes
  108181. */
  108182. subdivide(count: number): void;
  108183. /**
  108184. * Copy a FloatArray into a specific associated vertex buffer
  108185. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108186. * - VertexBuffer.PositionKind
  108187. * - VertexBuffer.UVKind
  108188. * - VertexBuffer.UV2Kind
  108189. * - VertexBuffer.UV3Kind
  108190. * - VertexBuffer.UV4Kind
  108191. * - VertexBuffer.UV5Kind
  108192. * - VertexBuffer.UV6Kind
  108193. * - VertexBuffer.ColorKind
  108194. * - VertexBuffer.MatricesIndicesKind
  108195. * - VertexBuffer.MatricesIndicesExtraKind
  108196. * - VertexBuffer.MatricesWeightsKind
  108197. * - VertexBuffer.MatricesWeightsExtraKind
  108198. * @param data defines the data source
  108199. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108200. * @param stride defines the data stride size (can be null)
  108201. * @returns the current mesh
  108202. */
  108203. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  108204. /**
  108205. * Delete a vertex buffer associated with this mesh
  108206. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  108207. * - VertexBuffer.PositionKind
  108208. * - VertexBuffer.UVKind
  108209. * - VertexBuffer.UV2Kind
  108210. * - VertexBuffer.UV3Kind
  108211. * - VertexBuffer.UV4Kind
  108212. * - VertexBuffer.UV5Kind
  108213. * - VertexBuffer.UV6Kind
  108214. * - VertexBuffer.ColorKind
  108215. * - VertexBuffer.MatricesIndicesKind
  108216. * - VertexBuffer.MatricesIndicesExtraKind
  108217. * - VertexBuffer.MatricesWeightsKind
  108218. * - VertexBuffer.MatricesWeightsExtraKind
  108219. */
  108220. removeVerticesData(kind: string): void;
  108221. /**
  108222. * Flags an associated vertex buffer as updatable
  108223. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  108224. * - VertexBuffer.PositionKind
  108225. * - VertexBuffer.UVKind
  108226. * - VertexBuffer.UV2Kind
  108227. * - VertexBuffer.UV3Kind
  108228. * - VertexBuffer.UV4Kind
  108229. * - VertexBuffer.UV5Kind
  108230. * - VertexBuffer.UV6Kind
  108231. * - VertexBuffer.ColorKind
  108232. * - VertexBuffer.MatricesIndicesKind
  108233. * - VertexBuffer.MatricesIndicesExtraKind
  108234. * - VertexBuffer.MatricesWeightsKind
  108235. * - VertexBuffer.MatricesWeightsExtraKind
  108236. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108237. */
  108238. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  108239. /**
  108240. * Sets the mesh global Vertex Buffer
  108241. * @param buffer defines the buffer to use
  108242. * @returns the current mesh
  108243. */
  108244. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  108245. /**
  108246. * Update a specific associated vertex buffer
  108247. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108248. * - VertexBuffer.PositionKind
  108249. * - VertexBuffer.UVKind
  108250. * - VertexBuffer.UV2Kind
  108251. * - VertexBuffer.UV3Kind
  108252. * - VertexBuffer.UV4Kind
  108253. * - VertexBuffer.UV5Kind
  108254. * - VertexBuffer.UV6Kind
  108255. * - VertexBuffer.ColorKind
  108256. * - VertexBuffer.MatricesIndicesKind
  108257. * - VertexBuffer.MatricesIndicesExtraKind
  108258. * - VertexBuffer.MatricesWeightsKind
  108259. * - VertexBuffer.MatricesWeightsExtraKind
  108260. * @param data defines the data source
  108261. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  108262. * @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)
  108263. * @returns the current mesh
  108264. */
  108265. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  108266. /**
  108267. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  108268. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  108269. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  108270. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  108271. * @returns the current mesh
  108272. */
  108273. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  108274. /**
  108275. * Creates a un-shared specific occurence of the geometry for the mesh.
  108276. * @returns the current mesh
  108277. */
  108278. makeGeometryUnique(): Mesh;
  108279. /**
  108280. * Set the index buffer of this mesh
  108281. * @param indices defines the source data
  108282. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  108283. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  108284. * @returns the current mesh
  108285. */
  108286. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  108287. /**
  108288. * Update the current index buffer
  108289. * @param indices defines the source data
  108290. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  108291. * @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)
  108292. * @returns the current mesh
  108293. */
  108294. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  108295. /**
  108296. * Invert the geometry to move from a right handed system to a left handed one.
  108297. * @returns the current mesh
  108298. */
  108299. toLeftHanded(): Mesh;
  108300. /** @hidden */
  108301. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  108302. /** @hidden */
  108303. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  108304. /**
  108305. * Registers for this mesh a javascript function called just before the rendering process
  108306. * @param func defines the function to call before rendering this mesh
  108307. * @returns the current mesh
  108308. */
  108309. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108310. /**
  108311. * Disposes a previously registered javascript function called before the rendering
  108312. * @param func defines the function to remove
  108313. * @returns the current mesh
  108314. */
  108315. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108316. /**
  108317. * Registers for this mesh a javascript function called just after the rendering is complete
  108318. * @param func defines the function to call after rendering this mesh
  108319. * @returns the current mesh
  108320. */
  108321. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108322. /**
  108323. * Disposes a previously registered javascript function called after the rendering.
  108324. * @param func defines the function to remove
  108325. * @returns the current mesh
  108326. */
  108327. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108328. /** @hidden */
  108329. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  108330. /** @hidden */
  108331. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  108332. /** @hidden */
  108333. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  108334. /** @hidden */
  108335. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  108336. /** @hidden */
  108337. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  108338. /** @hidden */
  108339. _rebuild(): void;
  108340. /** @hidden */
  108341. _freeze(): void;
  108342. /** @hidden */
  108343. _unFreeze(): void;
  108344. /**
  108345. * 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
  108346. * @param subMesh defines the subMesh to render
  108347. * @param enableAlphaMode defines if alpha mode can be changed
  108348. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  108349. * @returns the current mesh
  108350. */
  108351. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  108352. private _onBeforeDraw;
  108353. /**
  108354. * Renormalize the mesh and patch it up if there are no weights
  108355. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  108356. * However in the case of zero weights then we set just a single influence to 1.
  108357. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  108358. */
  108359. cleanMatrixWeights(): void;
  108360. private normalizeSkinFourWeights;
  108361. private normalizeSkinWeightsAndExtra;
  108362. /**
  108363. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  108364. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  108365. * the user know there was an issue with importing the mesh
  108366. * @returns a validation object with skinned, valid and report string
  108367. */
  108368. validateSkinning(): {
  108369. skinned: boolean;
  108370. valid: boolean;
  108371. report: string;
  108372. };
  108373. /** @hidden */
  108374. _checkDelayState(): Mesh;
  108375. private _queueLoad;
  108376. /**
  108377. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  108378. * A mesh is in the frustum if its bounding box intersects the frustum
  108379. * @param frustumPlanes defines the frustum to test
  108380. * @returns true if the mesh is in the frustum planes
  108381. */
  108382. isInFrustum(frustumPlanes: Plane[]): boolean;
  108383. /**
  108384. * Sets the mesh material by the material or multiMaterial `id` property
  108385. * @param id is a string identifying the material or the multiMaterial
  108386. * @returns the current mesh
  108387. */
  108388. setMaterialByID(id: string): Mesh;
  108389. /**
  108390. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  108391. * @returns an array of IAnimatable
  108392. */
  108393. getAnimatables(): IAnimatable[];
  108394. /**
  108395. * Modifies the mesh geometry according to the passed transformation matrix.
  108396. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  108397. * The mesh normals are modified using the same transformation.
  108398. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108399. * @param transform defines the transform matrix to use
  108400. * @see https://doc.babylonjs.com/resources/baking_transformations
  108401. * @returns the current mesh
  108402. */
  108403. bakeTransformIntoVertices(transform: Matrix): Mesh;
  108404. /**
  108405. * Modifies the mesh geometry according to its own current World Matrix.
  108406. * The mesh World Matrix is then reset.
  108407. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  108408. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108409. * @see https://doc.babylonjs.com/resources/baking_transformations
  108410. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  108411. * @returns the current mesh
  108412. */
  108413. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  108414. /** @hidden */
  108415. get _positions(): Nullable<Vector3[]>;
  108416. /** @hidden */
  108417. _resetPointsArrayCache(): Mesh;
  108418. /** @hidden */
  108419. _generatePointsArray(): boolean;
  108420. /**
  108421. * Returns a new Mesh object generated from the current mesh properties.
  108422. * This method must not get confused with createInstance()
  108423. * @param name is a string, the name given to the new mesh
  108424. * @param newParent can be any Node object (default `null`)
  108425. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  108426. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  108427. * @returns a new mesh
  108428. */
  108429. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  108430. /**
  108431. * Releases resources associated with this mesh.
  108432. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  108433. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  108434. */
  108435. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  108436. /** @hidden */
  108437. _disposeInstanceSpecificData(): void;
  108438. /** @hidden */
  108439. _disposeThinInstanceSpecificData(): void;
  108440. /**
  108441. * Modifies the mesh geometry according to a displacement map.
  108442. * 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.
  108443. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108444. * @param url is a string, the URL from the image file is to be downloaded.
  108445. * @param minHeight is the lower limit of the displacement.
  108446. * @param maxHeight is the upper limit of the displacement.
  108447. * @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.
  108448. * @param uvOffset is an optional vector2 used to offset UV.
  108449. * @param uvScale is an optional vector2 used to scale UV.
  108450. * @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.
  108451. * @returns the Mesh.
  108452. */
  108453. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108454. /**
  108455. * Modifies the mesh geometry according to a displacementMap buffer.
  108456. * 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.
  108457. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108458. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  108459. * @param heightMapWidth is the width of the buffer image.
  108460. * @param heightMapHeight is the height of the buffer image.
  108461. * @param minHeight is the lower limit of the displacement.
  108462. * @param maxHeight is the upper limit of the displacement.
  108463. * @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.
  108464. * @param uvOffset is an optional vector2 used to offset UV.
  108465. * @param uvScale is an optional vector2 used to scale UV.
  108466. * @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.
  108467. * @returns the Mesh.
  108468. */
  108469. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108470. /**
  108471. * Modify the mesh to get a flat shading rendering.
  108472. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  108473. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  108474. * @returns current mesh
  108475. */
  108476. convertToFlatShadedMesh(): Mesh;
  108477. /**
  108478. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  108479. * In other words, more vertices, no more indices and a single bigger VBO.
  108480. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  108481. * @returns current mesh
  108482. */
  108483. convertToUnIndexedMesh(): Mesh;
  108484. /**
  108485. * Inverses facet orientations.
  108486. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108487. * @param flipNormals will also inverts the normals
  108488. * @returns current mesh
  108489. */
  108490. flipFaces(flipNormals?: boolean): Mesh;
  108491. /**
  108492. * Increase the number of facets and hence vertices in a mesh
  108493. * Vertex normals are interpolated from existing vertex normals
  108494. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108495. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  108496. */
  108497. increaseVertices(numberPerEdge: number): void;
  108498. /**
  108499. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  108500. * This will undo any application of covertToFlatShadedMesh
  108501. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108502. */
  108503. forceSharedVertices(): void;
  108504. /** @hidden */
  108505. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  108506. /** @hidden */
  108507. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  108508. /**
  108509. * Creates a new InstancedMesh object from the mesh model.
  108510. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  108511. * @param name defines the name of the new instance
  108512. * @returns a new InstancedMesh
  108513. */
  108514. createInstance(name: string): InstancedMesh;
  108515. /**
  108516. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  108517. * After this call, all the mesh instances have the same submeshes than the current mesh.
  108518. * @returns the current mesh
  108519. */
  108520. synchronizeInstances(): Mesh;
  108521. /**
  108522. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  108523. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  108524. * This should be used together with the simplification to avoid disappearing triangles.
  108525. * @param successCallback an optional success callback to be called after the optimization finished.
  108526. * @returns the current mesh
  108527. */
  108528. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  108529. /**
  108530. * Serialize current mesh
  108531. * @param serializationObject defines the object which will receive the serialization data
  108532. */
  108533. serialize(serializationObject: any): void;
  108534. /** @hidden */
  108535. _syncGeometryWithMorphTargetManager(): void;
  108536. /** @hidden */
  108537. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  108538. /**
  108539. * Returns a new Mesh object parsed from the source provided.
  108540. * @param parsedMesh is the source
  108541. * @param scene defines the hosting scene
  108542. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  108543. * @returns a new Mesh
  108544. */
  108545. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  108546. /**
  108547. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  108548. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108549. * @param name defines the name of the mesh to create
  108550. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  108551. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  108552. * @param closePath creates a seam between the first and the last points of each path of the path array
  108553. * @param offset is taken in account only if the `pathArray` is containing a single path
  108554. * @param scene defines the hosting scene
  108555. * @param updatable defines if the mesh must be flagged as updatable
  108556. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108557. * @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)
  108558. * @returns a new Mesh
  108559. */
  108560. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108561. /**
  108562. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  108563. * @param name defines the name of the mesh to create
  108564. * @param radius sets the radius size (float) of the polygon (default 0.5)
  108565. * @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
  108566. * @param scene defines the hosting scene
  108567. * @param updatable defines if the mesh must be flagged as updatable
  108568. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108569. * @returns a new Mesh
  108570. */
  108571. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108572. /**
  108573. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  108574. * @param name defines the name of the mesh to create
  108575. * @param size sets the size (float) of each box side (default 1)
  108576. * @param scene defines the hosting scene
  108577. * @param updatable defines if the mesh must be flagged as updatable
  108578. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108579. * @returns a new Mesh
  108580. */
  108581. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108582. /**
  108583. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  108584. * @param name defines the name of the mesh to create
  108585. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108586. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108587. * @param scene defines the hosting scene
  108588. * @param updatable defines if the mesh must be flagged as updatable
  108589. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108590. * @returns a new Mesh
  108591. */
  108592. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108593. /**
  108594. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  108595. * @param name defines the name of the mesh to create
  108596. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108597. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108598. * @param scene defines the hosting scene
  108599. * @returns a new Mesh
  108600. */
  108601. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  108602. /**
  108603. * Creates a cylinder or a cone 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 height sets the height size (float) of the cylinder/cone (float, default 2)
  108606. * @param diameterTop set the top cap diameter (floats, default 1)
  108607. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  108608. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  108609. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  108610. * @param scene defines the hosting scene
  108611. * @param updatable defines if the mesh must be flagged as updatable
  108612. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108613. * @returns a new Mesh
  108614. */
  108615. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  108616. /**
  108617. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  108618. * @param name defines the name of the mesh to create
  108619. * @param diameter sets the diameter size (float) of the torus (default 1)
  108620. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  108621. * @param tessellation sets the number of torus sides (postive integer, default 16)
  108622. * @param scene defines the hosting scene
  108623. * @param updatable defines if the mesh must be flagged as updatable
  108624. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108625. * @returns a new Mesh
  108626. */
  108627. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108628. /**
  108629. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  108630. * @param name defines the name of the mesh to create
  108631. * @param radius sets the global radius size (float) of the torus knot (default 2)
  108632. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  108633. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  108634. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  108635. * @param p the number of windings on X axis (positive integers, default 2)
  108636. * @param q the number of windings on Y axis (positive integers, default 3)
  108637. * @param scene defines the hosting scene
  108638. * @param updatable defines if the mesh must be flagged as updatable
  108639. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108640. * @returns a new Mesh
  108641. */
  108642. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108643. /**
  108644. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  108645. * @param name defines the name of the mesh to create
  108646. * @param points is an array successive Vector3
  108647. * @param scene defines the hosting scene
  108648. * @param updatable defines if the mesh must be flagged as updatable
  108649. * @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).
  108650. * @returns a new Mesh
  108651. */
  108652. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  108653. /**
  108654. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  108655. * @param name defines the name of the mesh to create
  108656. * @param points is an array successive Vector3
  108657. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  108658. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  108659. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  108660. * @param scene defines the hosting scene
  108661. * @param updatable defines if the mesh must be flagged as updatable
  108662. * @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)
  108663. * @returns a new Mesh
  108664. */
  108665. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  108666. /**
  108667. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  108668. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  108669. * 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.
  108670. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108671. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108672. * Remember you can only change the shape positions, not their number when updating a polygon.
  108673. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  108674. * @param name defines the name of the mesh to create
  108675. * @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
  108676. * @param scene defines the hosting scene
  108677. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108678. * @param updatable defines if the mesh must be flagged as updatable
  108679. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108680. * @param earcutInjection can be used to inject your own earcut reference
  108681. * @returns a new Mesh
  108682. */
  108683. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108684. /**
  108685. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  108686. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  108687. * @param name defines the name of the mesh to create
  108688. * @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
  108689. * @param depth defines the height of extrusion
  108690. * @param scene defines the hosting scene
  108691. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108692. * @param updatable defines if the mesh must be flagged as updatable
  108693. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108694. * @param earcutInjection can be used to inject your own earcut reference
  108695. * @returns a new Mesh
  108696. */
  108697. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108698. /**
  108699. * Creates an extruded shape mesh.
  108700. * 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
  108701. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108702. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108703. * @param name defines the name of the mesh to create
  108704. * @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
  108705. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108706. * @param scale is the value to scale the shape
  108707. * @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
  108708. * @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
  108709. * @param scene defines the hosting scene
  108710. * @param updatable defines if the mesh must be flagged as updatable
  108711. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108712. * @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)
  108713. * @returns a new Mesh
  108714. */
  108715. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108716. /**
  108717. * Creates an custom extruded shape mesh.
  108718. * The custom extrusion is a parametric shape.
  108719. * It has no predefined shape. Its final shape will depend on the input parameters.
  108720. * Please consider using the same method from the MeshBuilder class instead
  108721. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108722. * @param name defines the name of the mesh to create
  108723. * @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
  108724. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108725. * @param scaleFunction is a custom Javascript function called on each path point
  108726. * @param rotationFunction is a custom Javascript function called on each path point
  108727. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  108728. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  108729. * @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
  108730. * @param scene defines the hosting scene
  108731. * @param updatable defines if the mesh must be flagged as updatable
  108732. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108733. * @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)
  108734. * @returns a new Mesh
  108735. */
  108736. 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;
  108737. /**
  108738. * Creates lathe mesh.
  108739. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  108740. * Please consider using the same method from the MeshBuilder class instead
  108741. * @param name defines the name of the mesh to create
  108742. * @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
  108743. * @param radius is the radius value of the lathe
  108744. * @param tessellation is the side number of the lathe.
  108745. * @param scene defines the hosting scene
  108746. * @param updatable defines if the mesh must be flagged as updatable
  108747. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108748. * @returns a new Mesh
  108749. */
  108750. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108751. /**
  108752. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  108753. * @param name defines the name of the mesh to create
  108754. * @param size sets the size (float) of both sides of the plane at once (default 1)
  108755. * @param scene defines the hosting scene
  108756. * @param updatable defines if the mesh must be flagged as updatable
  108757. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108758. * @returns a new Mesh
  108759. */
  108760. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108761. /**
  108762. * Creates a ground mesh.
  108763. * Please consider using the same method from the MeshBuilder class instead
  108764. * @param name defines the name of the mesh to create
  108765. * @param width set the width of the ground
  108766. * @param height set the height of the ground
  108767. * @param subdivisions sets the number of subdivisions per side
  108768. * @param scene defines the hosting scene
  108769. * @param updatable defines if the mesh must be flagged as updatable
  108770. * @returns a new Mesh
  108771. */
  108772. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  108773. /**
  108774. * Creates a tiled ground mesh.
  108775. * Please consider using the same method from the MeshBuilder class instead
  108776. * @param name defines the name of the mesh to create
  108777. * @param xmin set the ground minimum X coordinate
  108778. * @param zmin set the ground minimum Y coordinate
  108779. * @param xmax set the ground maximum X coordinate
  108780. * @param zmax set the ground maximum Z coordinate
  108781. * @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
  108782. * @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
  108783. * @param scene defines the hosting scene
  108784. * @param updatable defines if the mesh must be flagged as updatable
  108785. * @returns a new Mesh
  108786. */
  108787. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  108788. w: number;
  108789. h: number;
  108790. }, precision: {
  108791. w: number;
  108792. h: number;
  108793. }, scene: Scene, updatable?: boolean): Mesh;
  108794. /**
  108795. * Creates a ground mesh from a height map.
  108796. * Please consider using the same method from the MeshBuilder class instead
  108797. * @see https://doc.babylonjs.com/babylon101/height_map
  108798. * @param name defines the name of the mesh to create
  108799. * @param url sets the URL of the height map image resource
  108800. * @param width set the ground width size
  108801. * @param height set the ground height size
  108802. * @param subdivisions sets the number of subdivision per side
  108803. * @param minHeight is the minimum altitude on the ground
  108804. * @param maxHeight is the maximum altitude on the ground
  108805. * @param scene defines the hosting scene
  108806. * @param updatable defines if the mesh must be flagged as updatable
  108807. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  108808. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  108809. * @returns a new Mesh
  108810. */
  108811. 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;
  108812. /**
  108813. * Creates a tube mesh.
  108814. * The tube is a parametric shape.
  108815. * It has no predefined shape. Its final shape will depend on the input parameters.
  108816. * Please consider using the same method from the MeshBuilder class instead
  108817. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108818. * @param name defines the name of the mesh to create
  108819. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  108820. * @param radius sets the tube radius size
  108821. * @param tessellation is the number of sides on the tubular surface
  108822. * @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
  108823. * @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
  108824. * @param scene defines the hosting scene
  108825. * @param updatable defines if the mesh must be flagged as updatable
  108826. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108827. * @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)
  108828. * @returns a new Mesh
  108829. */
  108830. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  108831. (i: number, distance: number): number;
  108832. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108833. /**
  108834. * Creates a polyhedron mesh.
  108835. * Please consider using the same method from the MeshBuilder class instead.
  108836. * * 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
  108837. * * The parameter `size` (positive float, default 1) sets the polygon size
  108838. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  108839. * * 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`
  108840. * * 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
  108841. * * 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)`)
  108842. * * 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
  108843. * * 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
  108844. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108845. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108846. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108847. * @param name defines the name of the mesh to create
  108848. * @param options defines the options used to create the mesh
  108849. * @param scene defines the hosting scene
  108850. * @returns a new Mesh
  108851. */
  108852. static CreatePolyhedron(name: string, options: {
  108853. type?: number;
  108854. size?: number;
  108855. sizeX?: number;
  108856. sizeY?: number;
  108857. sizeZ?: number;
  108858. custom?: any;
  108859. faceUV?: Vector4[];
  108860. faceColors?: Color4[];
  108861. updatable?: boolean;
  108862. sideOrientation?: number;
  108863. }, scene: Scene): Mesh;
  108864. /**
  108865. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  108866. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  108867. * * 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`)
  108868. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  108869. * * 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
  108870. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108871. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108872. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108873. * @param name defines the name of the mesh
  108874. * @param options defines the options used to create the mesh
  108875. * @param scene defines the hosting scene
  108876. * @returns a new Mesh
  108877. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  108878. */
  108879. static CreateIcoSphere(name: string, options: {
  108880. radius?: number;
  108881. flat?: boolean;
  108882. subdivisions?: number;
  108883. sideOrientation?: number;
  108884. updatable?: boolean;
  108885. }, scene: Scene): Mesh;
  108886. /**
  108887. * Creates a decal mesh.
  108888. * Please consider using the same method from the MeshBuilder class instead.
  108889. * A decal is a mesh usually applied as a model onto the surface of another mesh
  108890. * @param name defines the name of the mesh
  108891. * @param sourceMesh defines the mesh receiving the decal
  108892. * @param position sets the position of the decal in world coordinates
  108893. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  108894. * @param size sets the decal scaling
  108895. * @param angle sets the angle to rotate the decal
  108896. * @returns a new Mesh
  108897. */
  108898. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  108899. /**
  108900. * Prepare internal position array for software CPU skinning
  108901. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  108902. */
  108903. setPositionsForCPUSkinning(): Float32Array;
  108904. /**
  108905. * Prepare internal normal array for software CPU skinning
  108906. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  108907. */
  108908. setNormalsForCPUSkinning(): Float32Array;
  108909. /**
  108910. * Updates the vertex buffer by applying transformation from the bones
  108911. * @param skeleton defines the skeleton to apply to current mesh
  108912. * @returns the current mesh
  108913. */
  108914. applySkeleton(skeleton: Skeleton): Mesh;
  108915. /**
  108916. * 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
  108917. * @param meshes defines the list of meshes to scan
  108918. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  108919. */
  108920. static MinMax(meshes: AbstractMesh[]): {
  108921. min: Vector3;
  108922. max: Vector3;
  108923. };
  108924. /**
  108925. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  108926. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  108927. * @returns a vector3
  108928. */
  108929. static Center(meshesOrMinMaxVector: {
  108930. min: Vector3;
  108931. max: Vector3;
  108932. } | AbstractMesh[]): Vector3;
  108933. /**
  108934. * Merge the array of meshes into a single mesh for performance reasons.
  108935. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  108936. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  108937. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  108938. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  108939. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  108940. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  108941. * @returns a new mesh
  108942. */
  108943. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  108944. /** @hidden */
  108945. addInstance(instance: InstancedMesh): void;
  108946. /** @hidden */
  108947. removeInstance(instance: InstancedMesh): void;
  108948. }
  108949. }
  108950. declare module BABYLON {
  108951. /**
  108952. * This is the base class of all the camera used in the application.
  108953. * @see https://doc.babylonjs.com/features/cameras
  108954. */
  108955. export class Camera extends Node {
  108956. /** @hidden */
  108957. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  108958. /**
  108959. * This is the default projection mode used by the cameras.
  108960. * It helps recreating a feeling of perspective and better appreciate depth.
  108961. * This is the best way to simulate real life cameras.
  108962. */
  108963. static readonly PERSPECTIVE_CAMERA: number;
  108964. /**
  108965. * This helps creating camera with an orthographic mode.
  108966. * 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.
  108967. */
  108968. static readonly ORTHOGRAPHIC_CAMERA: number;
  108969. /**
  108970. * This is the default FOV mode for perspective cameras.
  108971. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  108972. */
  108973. static readonly FOVMODE_VERTICAL_FIXED: number;
  108974. /**
  108975. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  108976. */
  108977. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  108978. /**
  108979. * This specifies ther is no need for a camera rig.
  108980. * Basically only one eye is rendered corresponding to the camera.
  108981. */
  108982. static readonly RIG_MODE_NONE: number;
  108983. /**
  108984. * Simulates a camera Rig with one blue eye and one red eye.
  108985. * This can be use with 3d blue and red glasses.
  108986. */
  108987. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  108988. /**
  108989. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  108990. */
  108991. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  108992. /**
  108993. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  108994. */
  108995. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  108996. /**
  108997. * Defines that both eyes of the camera will be rendered over under each other.
  108998. */
  108999. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  109000. /**
  109001. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  109002. */
  109003. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  109004. /**
  109005. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  109006. */
  109007. static readonly RIG_MODE_VR: number;
  109008. /**
  109009. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  109010. */
  109011. static readonly RIG_MODE_WEBVR: number;
  109012. /**
  109013. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  109014. */
  109015. static readonly RIG_MODE_CUSTOM: number;
  109016. /**
  109017. * Defines if by default attaching controls should prevent the default javascript event to continue.
  109018. */
  109019. static ForceAttachControlToAlwaysPreventDefault: boolean;
  109020. /**
  109021. * Define the input manager associated with the camera.
  109022. */
  109023. inputs: CameraInputsManager<Camera>;
  109024. /** @hidden */
  109025. _position: Vector3;
  109026. /**
  109027. * Define the current local position of the camera in the scene
  109028. */
  109029. get position(): Vector3;
  109030. set position(newPosition: Vector3);
  109031. protected _upVector: Vector3;
  109032. /**
  109033. * The vector the camera should consider as up.
  109034. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  109035. */
  109036. set upVector(vec: Vector3);
  109037. get upVector(): Vector3;
  109038. /**
  109039. * Define the current limit on the left side for an orthographic camera
  109040. * In scene unit
  109041. */
  109042. orthoLeft: Nullable<number>;
  109043. /**
  109044. * Define the current limit on the right side for an orthographic camera
  109045. * In scene unit
  109046. */
  109047. orthoRight: Nullable<number>;
  109048. /**
  109049. * Define the current limit on the bottom side for an orthographic camera
  109050. * In scene unit
  109051. */
  109052. orthoBottom: Nullable<number>;
  109053. /**
  109054. * Define the current limit on the top side for an orthographic camera
  109055. * In scene unit
  109056. */
  109057. orthoTop: Nullable<number>;
  109058. /**
  109059. * Field Of View is set in Radians. (default is 0.8)
  109060. */
  109061. fov: number;
  109062. /**
  109063. * Define the minimum distance the camera can see from.
  109064. * This is important to note that the depth buffer are not infinite and the closer it starts
  109065. * the more your scene might encounter depth fighting issue.
  109066. */
  109067. minZ: number;
  109068. /**
  109069. * Define the maximum distance the camera can see to.
  109070. * This is important to note that the depth buffer are not infinite and the further it end
  109071. * the more your scene might encounter depth fighting issue.
  109072. */
  109073. maxZ: number;
  109074. /**
  109075. * Define the default inertia of the camera.
  109076. * This helps giving a smooth feeling to the camera movement.
  109077. */
  109078. inertia: number;
  109079. /**
  109080. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  109081. */
  109082. mode: number;
  109083. /**
  109084. * Define whether the camera is intermediate.
  109085. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  109086. */
  109087. isIntermediate: boolean;
  109088. /**
  109089. * Define the viewport of the camera.
  109090. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  109091. */
  109092. viewport: Viewport;
  109093. /**
  109094. * Restricts the camera to viewing objects with the same layerMask.
  109095. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  109096. */
  109097. layerMask: number;
  109098. /**
  109099. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  109100. */
  109101. fovMode: number;
  109102. /**
  109103. * Rig mode of the camera.
  109104. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  109105. * This is normally controlled byt the camera themselves as internal use.
  109106. */
  109107. cameraRigMode: number;
  109108. /**
  109109. * Defines the distance between both "eyes" in case of a RIG
  109110. */
  109111. interaxialDistance: number;
  109112. /**
  109113. * Defines if stereoscopic rendering is done side by side or over under.
  109114. */
  109115. isStereoscopicSideBySide: boolean;
  109116. /**
  109117. * 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
  109118. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  109119. * else in the scene. (Eg. security camera)
  109120. *
  109121. * 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)
  109122. */
  109123. customRenderTargets: RenderTargetTexture[];
  109124. /**
  109125. * When set, the camera will render to this render target instead of the default canvas
  109126. *
  109127. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  109128. */
  109129. outputRenderTarget: Nullable<RenderTargetTexture>;
  109130. /**
  109131. * Observable triggered when the camera view matrix has changed.
  109132. */
  109133. onViewMatrixChangedObservable: Observable<Camera>;
  109134. /**
  109135. * Observable triggered when the camera Projection matrix has changed.
  109136. */
  109137. onProjectionMatrixChangedObservable: Observable<Camera>;
  109138. /**
  109139. * Observable triggered when the inputs have been processed.
  109140. */
  109141. onAfterCheckInputsObservable: Observable<Camera>;
  109142. /**
  109143. * Observable triggered when reset has been called and applied to the camera.
  109144. */
  109145. onRestoreStateObservable: Observable<Camera>;
  109146. /**
  109147. * Is this camera a part of a rig system?
  109148. */
  109149. isRigCamera: boolean;
  109150. /**
  109151. * If isRigCamera set to true this will be set with the parent camera.
  109152. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  109153. */
  109154. rigParent?: Camera;
  109155. /** @hidden */
  109156. _cameraRigParams: any;
  109157. /** @hidden */
  109158. _rigCameras: Camera[];
  109159. /** @hidden */
  109160. _rigPostProcess: Nullable<PostProcess>;
  109161. protected _webvrViewMatrix: Matrix;
  109162. /** @hidden */
  109163. _skipRendering: boolean;
  109164. /** @hidden */
  109165. _projectionMatrix: Matrix;
  109166. /** @hidden */
  109167. _postProcesses: Nullable<PostProcess>[];
  109168. /** @hidden */
  109169. _activeMeshes: SmartArray<AbstractMesh>;
  109170. protected _globalPosition: Vector3;
  109171. /** @hidden */
  109172. _computedViewMatrix: Matrix;
  109173. private _doNotComputeProjectionMatrix;
  109174. private _transformMatrix;
  109175. private _frustumPlanes;
  109176. private _refreshFrustumPlanes;
  109177. private _storedFov;
  109178. private _stateStored;
  109179. /**
  109180. * Instantiates a new camera object.
  109181. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  109182. * @see https://doc.babylonjs.com/features/cameras
  109183. * @param name Defines the name of the camera in the scene
  109184. * @param position Defines the position of the camera
  109185. * @param scene Defines the scene the camera belongs too
  109186. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  109187. */
  109188. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  109189. /**
  109190. * Store current camera state (fov, position, etc..)
  109191. * @returns the camera
  109192. */
  109193. storeState(): Camera;
  109194. /**
  109195. * Restores the camera state values if it has been stored. You must call storeState() first
  109196. */
  109197. protected _restoreStateValues(): boolean;
  109198. /**
  109199. * Restored camera state. You must call storeState() first.
  109200. * @returns true if restored and false otherwise
  109201. */
  109202. restoreState(): boolean;
  109203. /**
  109204. * Gets the class name of the camera.
  109205. * @returns the class name
  109206. */
  109207. getClassName(): string;
  109208. /** @hidden */
  109209. readonly _isCamera: boolean;
  109210. /**
  109211. * Gets a string representation of the camera useful for debug purpose.
  109212. * @param fullDetails Defines that a more verboe level of logging is required
  109213. * @returns the string representation
  109214. */
  109215. toString(fullDetails?: boolean): string;
  109216. /**
  109217. * Gets the current world space position of the camera.
  109218. */
  109219. get globalPosition(): Vector3;
  109220. /**
  109221. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  109222. * @returns the active meshe list
  109223. */
  109224. getActiveMeshes(): SmartArray<AbstractMesh>;
  109225. /**
  109226. * Check whether a mesh is part of the current active mesh list of the camera
  109227. * @param mesh Defines the mesh to check
  109228. * @returns true if active, false otherwise
  109229. */
  109230. isActiveMesh(mesh: Mesh): boolean;
  109231. /**
  109232. * Is this camera ready to be used/rendered
  109233. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  109234. * @return true if the camera is ready
  109235. */
  109236. isReady(completeCheck?: boolean): boolean;
  109237. /** @hidden */
  109238. _initCache(): void;
  109239. /** @hidden */
  109240. _updateCache(ignoreParentClass?: boolean): void;
  109241. /** @hidden */
  109242. _isSynchronized(): boolean;
  109243. /** @hidden */
  109244. _isSynchronizedViewMatrix(): boolean;
  109245. /** @hidden */
  109246. _isSynchronizedProjectionMatrix(): boolean;
  109247. /**
  109248. * Attach the input controls to a specific dom element to get the input from.
  109249. * @param element Defines the element the controls should be listened from
  109250. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  109251. */
  109252. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  109253. /**
  109254. * Detach the current controls from the specified dom element.
  109255. * @param element Defines the element to stop listening the inputs from
  109256. */
  109257. detachControl(element: HTMLElement): void;
  109258. /**
  109259. * Update the camera state according to the different inputs gathered during the frame.
  109260. */
  109261. update(): void;
  109262. /** @hidden */
  109263. _checkInputs(): void;
  109264. /** @hidden */
  109265. get rigCameras(): Camera[];
  109266. /**
  109267. * Gets the post process used by the rig cameras
  109268. */
  109269. get rigPostProcess(): Nullable<PostProcess>;
  109270. /**
  109271. * Internal, gets the first post proces.
  109272. * @returns the first post process to be run on this camera.
  109273. */
  109274. _getFirstPostProcess(): Nullable<PostProcess>;
  109275. private _cascadePostProcessesToRigCams;
  109276. /**
  109277. * Attach a post process to the camera.
  109278. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109279. * @param postProcess The post process to attach to the camera
  109280. * @param insertAt The position of the post process in case several of them are in use in the scene
  109281. * @returns the position the post process has been inserted at
  109282. */
  109283. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  109284. /**
  109285. * Detach a post process to the camera.
  109286. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109287. * @param postProcess The post process to detach from the camera
  109288. */
  109289. detachPostProcess(postProcess: PostProcess): void;
  109290. /**
  109291. * Gets the current world matrix of the camera
  109292. */
  109293. getWorldMatrix(): Matrix;
  109294. /** @hidden */
  109295. _getViewMatrix(): Matrix;
  109296. /**
  109297. * Gets the current view matrix of the camera.
  109298. * @param force forces the camera to recompute the matrix without looking at the cached state
  109299. * @returns the view matrix
  109300. */
  109301. getViewMatrix(force?: boolean): Matrix;
  109302. /**
  109303. * Freeze the projection matrix.
  109304. * It will prevent the cache check of the camera projection compute and can speed up perf
  109305. * if no parameter of the camera are meant to change
  109306. * @param projection Defines manually a projection if necessary
  109307. */
  109308. freezeProjectionMatrix(projection?: Matrix): void;
  109309. /**
  109310. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  109311. */
  109312. unfreezeProjectionMatrix(): void;
  109313. /**
  109314. * Gets the current projection matrix of the camera.
  109315. * @param force forces the camera to recompute the matrix without looking at the cached state
  109316. * @returns the projection matrix
  109317. */
  109318. getProjectionMatrix(force?: boolean): Matrix;
  109319. /**
  109320. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  109321. * @returns a Matrix
  109322. */
  109323. getTransformationMatrix(): Matrix;
  109324. private _updateFrustumPlanes;
  109325. /**
  109326. * Checks if a cullable object (mesh...) is in the camera frustum
  109327. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  109328. * @param target The object to check
  109329. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  109330. * @returns true if the object is in frustum otherwise false
  109331. */
  109332. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  109333. /**
  109334. * Checks if a cullable object (mesh...) is in the camera frustum
  109335. * Unlike isInFrustum this cheks the full bounding box
  109336. * @param target The object to check
  109337. * @returns true if the object is in frustum otherwise false
  109338. */
  109339. isCompletelyInFrustum(target: ICullable): boolean;
  109340. /**
  109341. * Gets a ray in the forward direction from the camera.
  109342. * @param length Defines the length of the ray to create
  109343. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109344. * @param origin Defines the start point of the ray which defaults to the camera position
  109345. * @returns the forward ray
  109346. */
  109347. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109348. /**
  109349. * Gets a ray in the forward direction from the camera.
  109350. * @param refRay the ray to (re)use when setting the values
  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. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109357. /**
  109358. * Releases resources associated with this node.
  109359. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  109360. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  109361. */
  109362. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  109363. /** @hidden */
  109364. _isLeftCamera: boolean;
  109365. /**
  109366. * Gets the left camera of a rig setup in case of Rigged Camera
  109367. */
  109368. get isLeftCamera(): boolean;
  109369. /** @hidden */
  109370. _isRightCamera: boolean;
  109371. /**
  109372. * Gets the right camera of a rig setup in case of Rigged Camera
  109373. */
  109374. get isRightCamera(): boolean;
  109375. /**
  109376. * Gets the left camera of a rig setup in case of Rigged Camera
  109377. */
  109378. get leftCamera(): Nullable<FreeCamera>;
  109379. /**
  109380. * Gets the right camera of a rig setup in case of Rigged Camera
  109381. */
  109382. get rightCamera(): Nullable<FreeCamera>;
  109383. /**
  109384. * Gets the left camera target of a rig setup in case of Rigged Camera
  109385. * @returns the target position
  109386. */
  109387. getLeftTarget(): Nullable<Vector3>;
  109388. /**
  109389. * Gets the right camera target of a rig setup in case of Rigged Camera
  109390. * @returns the target position
  109391. */
  109392. getRightTarget(): Nullable<Vector3>;
  109393. /**
  109394. * @hidden
  109395. */
  109396. setCameraRigMode(mode: number, rigParams: any): void;
  109397. /** @hidden */
  109398. static _setStereoscopicRigMode(camera: Camera): void;
  109399. /** @hidden */
  109400. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  109401. /** @hidden */
  109402. static _setVRRigMode(camera: Camera, rigParams: any): void;
  109403. /** @hidden */
  109404. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  109405. /** @hidden */
  109406. _getVRProjectionMatrix(): Matrix;
  109407. protected _updateCameraRotationMatrix(): void;
  109408. protected _updateWebVRCameraRotationMatrix(): void;
  109409. /**
  109410. * This function MUST be overwritten by the different WebVR cameras available.
  109411. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109412. * @hidden
  109413. */
  109414. _getWebVRProjectionMatrix(): Matrix;
  109415. /**
  109416. * This function MUST be overwritten by the different WebVR cameras available.
  109417. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109418. * @hidden
  109419. */
  109420. _getWebVRViewMatrix(): Matrix;
  109421. /** @hidden */
  109422. setCameraRigParameter(name: string, value: any): void;
  109423. /**
  109424. * needs to be overridden by children so sub has required properties to be copied
  109425. * @hidden
  109426. */
  109427. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  109428. /**
  109429. * May need to be overridden by children
  109430. * @hidden
  109431. */
  109432. _updateRigCameras(): void;
  109433. /** @hidden */
  109434. _setupInputs(): void;
  109435. /**
  109436. * Serialiaze the camera setup to a json represention
  109437. * @returns the JSON representation
  109438. */
  109439. serialize(): any;
  109440. /**
  109441. * Clones the current camera.
  109442. * @param name The cloned camera name
  109443. * @returns the cloned camera
  109444. */
  109445. clone(name: string): Camera;
  109446. /**
  109447. * Gets the direction of the camera relative to a given local axis.
  109448. * @param localAxis Defines the reference axis to provide a relative direction.
  109449. * @return the direction
  109450. */
  109451. getDirection(localAxis: Vector3): Vector3;
  109452. /**
  109453. * Returns the current camera absolute rotation
  109454. */
  109455. get absoluteRotation(): Quaternion;
  109456. /**
  109457. * Gets the direction of the camera relative to a given local axis into a passed vector.
  109458. * @param localAxis Defines the reference axis to provide a relative direction.
  109459. * @param result Defines the vector to store the result in
  109460. */
  109461. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  109462. /**
  109463. * Gets a camera constructor for a given camera type
  109464. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  109465. * @param name The name of the camera the result will be able to instantiate
  109466. * @param scene The scene the result will construct the camera in
  109467. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  109468. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  109469. * @returns a factory method to construc the camera
  109470. */
  109471. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  109472. /**
  109473. * Compute the world matrix of the camera.
  109474. * @returns the camera world matrix
  109475. */
  109476. computeWorldMatrix(): Matrix;
  109477. /**
  109478. * Parse a JSON and creates the camera from the parsed information
  109479. * @param parsedCamera The JSON to parse
  109480. * @param scene The scene to instantiate the camera in
  109481. * @returns the newly constructed camera
  109482. */
  109483. static Parse(parsedCamera: any, scene: Scene): Camera;
  109484. }
  109485. }
  109486. declare module BABYLON {
  109487. /**
  109488. * Class containing static functions to help procedurally build meshes
  109489. */
  109490. export class DiscBuilder {
  109491. /**
  109492. * Creates a plane polygonal mesh. By default, this is a disc
  109493. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  109494. * * 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
  109495. * * 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
  109496. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109497. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109498. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109499. * @param name defines the name of the mesh
  109500. * @param options defines the options used to create the mesh
  109501. * @param scene defines the hosting scene
  109502. * @returns the plane polygonal mesh
  109503. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  109504. */
  109505. static CreateDisc(name: string, options: {
  109506. radius?: number;
  109507. tessellation?: number;
  109508. arc?: number;
  109509. updatable?: boolean;
  109510. sideOrientation?: number;
  109511. frontUVs?: Vector4;
  109512. backUVs?: Vector4;
  109513. }, scene?: Nullable<Scene>): Mesh;
  109514. }
  109515. }
  109516. declare module BABYLON {
  109517. /**
  109518. * Options to be used when creating a FresnelParameters.
  109519. */
  109520. export type IFresnelParametersCreationOptions = {
  109521. /**
  109522. * Define the color used on edges (grazing angle)
  109523. */
  109524. leftColor?: Color3;
  109525. /**
  109526. * Define the color used on center
  109527. */
  109528. rightColor?: Color3;
  109529. /**
  109530. * Define bias applied to computed fresnel term
  109531. */
  109532. bias?: number;
  109533. /**
  109534. * Defined the power exponent applied to fresnel term
  109535. */
  109536. power?: number;
  109537. /**
  109538. * Define if the fresnel effect is enable or not.
  109539. */
  109540. isEnabled?: boolean;
  109541. };
  109542. /**
  109543. * Serialized format for FresnelParameters.
  109544. */
  109545. export type IFresnelParametersSerialized = {
  109546. /**
  109547. * Define the color used on edges (grazing angle) [as an array]
  109548. */
  109549. leftColor: number[];
  109550. /**
  109551. * Define the color used on center [as an array]
  109552. */
  109553. rightColor: number[];
  109554. /**
  109555. * Define bias applied to computed fresnel term
  109556. */
  109557. bias: number;
  109558. /**
  109559. * Defined the power exponent applied to fresnel term
  109560. */
  109561. power?: number;
  109562. /**
  109563. * Define if the fresnel effect is enable or not.
  109564. */
  109565. isEnabled: boolean;
  109566. };
  109567. /**
  109568. * This represents all the required information to add a fresnel effect on a material:
  109569. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109570. */
  109571. export class FresnelParameters {
  109572. private _isEnabled;
  109573. /**
  109574. * Define if the fresnel effect is enable or not.
  109575. */
  109576. get isEnabled(): boolean;
  109577. set isEnabled(value: boolean);
  109578. /**
  109579. * Define the color used on edges (grazing angle)
  109580. */
  109581. leftColor: Color3;
  109582. /**
  109583. * Define the color used on center
  109584. */
  109585. rightColor: Color3;
  109586. /**
  109587. * Define bias applied to computed fresnel term
  109588. */
  109589. bias: number;
  109590. /**
  109591. * Defined the power exponent applied to fresnel term
  109592. */
  109593. power: number;
  109594. /**
  109595. * Creates a new FresnelParameters object.
  109596. *
  109597. * @param options provide your own settings to optionally to override defaults
  109598. */
  109599. constructor(options?: IFresnelParametersCreationOptions);
  109600. /**
  109601. * Clones the current fresnel and its valuues
  109602. * @returns a clone fresnel configuration
  109603. */
  109604. clone(): FresnelParameters;
  109605. /**
  109606. * Determines equality between FresnelParameters objects
  109607. * @param otherFresnelParameters defines the second operand
  109608. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  109609. */
  109610. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  109611. /**
  109612. * Serializes the current fresnel parameters to a JSON representation.
  109613. * @return the JSON serialization
  109614. */
  109615. serialize(): IFresnelParametersSerialized;
  109616. /**
  109617. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  109618. * @param parsedFresnelParameters Define the JSON representation
  109619. * @returns the parsed parameters
  109620. */
  109621. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  109622. }
  109623. }
  109624. declare module BABYLON {
  109625. /**
  109626. * This groups all the flags used to control the materials channel.
  109627. */
  109628. export class MaterialFlags {
  109629. private static _DiffuseTextureEnabled;
  109630. /**
  109631. * Are diffuse textures enabled in the application.
  109632. */
  109633. static get DiffuseTextureEnabled(): boolean;
  109634. static set DiffuseTextureEnabled(value: boolean);
  109635. private static _DetailTextureEnabled;
  109636. /**
  109637. * Are detail textures enabled in the application.
  109638. */
  109639. static get DetailTextureEnabled(): boolean;
  109640. static set DetailTextureEnabled(value: boolean);
  109641. private static _AmbientTextureEnabled;
  109642. /**
  109643. * Are ambient textures enabled in the application.
  109644. */
  109645. static get AmbientTextureEnabled(): boolean;
  109646. static set AmbientTextureEnabled(value: boolean);
  109647. private static _OpacityTextureEnabled;
  109648. /**
  109649. * Are opacity textures enabled in the application.
  109650. */
  109651. static get OpacityTextureEnabled(): boolean;
  109652. static set OpacityTextureEnabled(value: boolean);
  109653. private static _ReflectionTextureEnabled;
  109654. /**
  109655. * Are reflection textures enabled in the application.
  109656. */
  109657. static get ReflectionTextureEnabled(): boolean;
  109658. static set ReflectionTextureEnabled(value: boolean);
  109659. private static _EmissiveTextureEnabled;
  109660. /**
  109661. * Are emissive textures enabled in the application.
  109662. */
  109663. static get EmissiveTextureEnabled(): boolean;
  109664. static set EmissiveTextureEnabled(value: boolean);
  109665. private static _SpecularTextureEnabled;
  109666. /**
  109667. * Are specular textures enabled in the application.
  109668. */
  109669. static get SpecularTextureEnabled(): boolean;
  109670. static set SpecularTextureEnabled(value: boolean);
  109671. private static _BumpTextureEnabled;
  109672. /**
  109673. * Are bump textures enabled in the application.
  109674. */
  109675. static get BumpTextureEnabled(): boolean;
  109676. static set BumpTextureEnabled(value: boolean);
  109677. private static _LightmapTextureEnabled;
  109678. /**
  109679. * Are lightmap textures enabled in the application.
  109680. */
  109681. static get LightmapTextureEnabled(): boolean;
  109682. static set LightmapTextureEnabled(value: boolean);
  109683. private static _RefractionTextureEnabled;
  109684. /**
  109685. * Are refraction textures enabled in the application.
  109686. */
  109687. static get RefractionTextureEnabled(): boolean;
  109688. static set RefractionTextureEnabled(value: boolean);
  109689. private static _ColorGradingTextureEnabled;
  109690. /**
  109691. * Are color grading textures enabled in the application.
  109692. */
  109693. static get ColorGradingTextureEnabled(): boolean;
  109694. static set ColorGradingTextureEnabled(value: boolean);
  109695. private static _FresnelEnabled;
  109696. /**
  109697. * Are fresnels enabled in the application.
  109698. */
  109699. static get FresnelEnabled(): boolean;
  109700. static set FresnelEnabled(value: boolean);
  109701. private static _ClearCoatTextureEnabled;
  109702. /**
  109703. * Are clear coat textures enabled in the application.
  109704. */
  109705. static get ClearCoatTextureEnabled(): boolean;
  109706. static set ClearCoatTextureEnabled(value: boolean);
  109707. private static _ClearCoatBumpTextureEnabled;
  109708. /**
  109709. * Are clear coat bump textures enabled in the application.
  109710. */
  109711. static get ClearCoatBumpTextureEnabled(): boolean;
  109712. static set ClearCoatBumpTextureEnabled(value: boolean);
  109713. private static _ClearCoatTintTextureEnabled;
  109714. /**
  109715. * Are clear coat tint textures enabled in the application.
  109716. */
  109717. static get ClearCoatTintTextureEnabled(): boolean;
  109718. static set ClearCoatTintTextureEnabled(value: boolean);
  109719. private static _SheenTextureEnabled;
  109720. /**
  109721. * Are sheen textures enabled in the application.
  109722. */
  109723. static get SheenTextureEnabled(): boolean;
  109724. static set SheenTextureEnabled(value: boolean);
  109725. private static _AnisotropicTextureEnabled;
  109726. /**
  109727. * Are anisotropic textures enabled in the application.
  109728. */
  109729. static get AnisotropicTextureEnabled(): boolean;
  109730. static set AnisotropicTextureEnabled(value: boolean);
  109731. private static _ThicknessTextureEnabled;
  109732. /**
  109733. * Are thickness textures enabled in the application.
  109734. */
  109735. static get ThicknessTextureEnabled(): boolean;
  109736. static set ThicknessTextureEnabled(value: boolean);
  109737. }
  109738. }
  109739. declare module BABYLON {
  109740. /** @hidden */
  109741. export var defaultFragmentDeclaration: {
  109742. name: string;
  109743. shader: string;
  109744. };
  109745. }
  109746. declare module BABYLON {
  109747. /** @hidden */
  109748. export var defaultUboDeclaration: {
  109749. name: string;
  109750. shader: string;
  109751. };
  109752. }
  109753. declare module BABYLON {
  109754. /** @hidden */
  109755. export var prePassDeclaration: {
  109756. name: string;
  109757. shader: string;
  109758. };
  109759. }
  109760. declare module BABYLON {
  109761. /** @hidden */
  109762. export var lightFragmentDeclaration: {
  109763. name: string;
  109764. shader: string;
  109765. };
  109766. }
  109767. declare module BABYLON {
  109768. /** @hidden */
  109769. export var lightUboDeclaration: {
  109770. name: string;
  109771. shader: string;
  109772. };
  109773. }
  109774. declare module BABYLON {
  109775. /** @hidden */
  109776. export var lightsFragmentFunctions: {
  109777. name: string;
  109778. shader: string;
  109779. };
  109780. }
  109781. declare module BABYLON {
  109782. /** @hidden */
  109783. export var shadowsFragmentFunctions: {
  109784. name: string;
  109785. shader: string;
  109786. };
  109787. }
  109788. declare module BABYLON {
  109789. /** @hidden */
  109790. export var fresnelFunction: {
  109791. name: string;
  109792. shader: string;
  109793. };
  109794. }
  109795. declare module BABYLON {
  109796. /** @hidden */
  109797. export var bumpFragmentMainFunctions: {
  109798. name: string;
  109799. shader: string;
  109800. };
  109801. }
  109802. declare module BABYLON {
  109803. /** @hidden */
  109804. export var bumpFragmentFunctions: {
  109805. name: string;
  109806. shader: string;
  109807. };
  109808. }
  109809. declare module BABYLON {
  109810. /** @hidden */
  109811. export var logDepthDeclaration: {
  109812. name: string;
  109813. shader: string;
  109814. };
  109815. }
  109816. declare module BABYLON {
  109817. /** @hidden */
  109818. export var bumpFragment: {
  109819. name: string;
  109820. shader: string;
  109821. };
  109822. }
  109823. declare module BABYLON {
  109824. /** @hidden */
  109825. export var depthPrePass: {
  109826. name: string;
  109827. shader: string;
  109828. };
  109829. }
  109830. declare module BABYLON {
  109831. /** @hidden */
  109832. export var lightFragment: {
  109833. name: string;
  109834. shader: string;
  109835. };
  109836. }
  109837. declare module BABYLON {
  109838. /** @hidden */
  109839. export var logDepthFragment: {
  109840. name: string;
  109841. shader: string;
  109842. };
  109843. }
  109844. declare module BABYLON {
  109845. /** @hidden */
  109846. export var defaultPixelShader: {
  109847. name: string;
  109848. shader: string;
  109849. };
  109850. }
  109851. declare module BABYLON {
  109852. /** @hidden */
  109853. export var defaultVertexDeclaration: {
  109854. name: string;
  109855. shader: string;
  109856. };
  109857. }
  109858. declare module BABYLON {
  109859. /** @hidden */
  109860. export var bumpVertexDeclaration: {
  109861. name: string;
  109862. shader: string;
  109863. };
  109864. }
  109865. declare module BABYLON {
  109866. /** @hidden */
  109867. export var bumpVertex: {
  109868. name: string;
  109869. shader: string;
  109870. };
  109871. }
  109872. declare module BABYLON {
  109873. /** @hidden */
  109874. export var fogVertex: {
  109875. name: string;
  109876. shader: string;
  109877. };
  109878. }
  109879. declare module BABYLON {
  109880. /** @hidden */
  109881. export var shadowsVertex: {
  109882. name: string;
  109883. shader: string;
  109884. };
  109885. }
  109886. declare module BABYLON {
  109887. /** @hidden */
  109888. export var pointCloudVertex: {
  109889. name: string;
  109890. shader: string;
  109891. };
  109892. }
  109893. declare module BABYLON {
  109894. /** @hidden */
  109895. export var logDepthVertex: {
  109896. name: string;
  109897. shader: string;
  109898. };
  109899. }
  109900. declare module BABYLON {
  109901. /** @hidden */
  109902. export var defaultVertexShader: {
  109903. name: string;
  109904. shader: string;
  109905. };
  109906. }
  109907. declare module BABYLON {
  109908. /**
  109909. * @hidden
  109910. */
  109911. export interface IMaterialDetailMapDefines {
  109912. DETAIL: boolean;
  109913. DETAILDIRECTUV: number;
  109914. DETAIL_NORMALBLENDMETHOD: number;
  109915. /** @hidden */
  109916. _areTexturesDirty: boolean;
  109917. }
  109918. /**
  109919. * Define the code related to the detail map parameters of a material
  109920. *
  109921. * Inspired from:
  109922. * 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
  109923. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  109924. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  109925. */
  109926. export class DetailMapConfiguration {
  109927. private _texture;
  109928. /**
  109929. * The detail texture of the material.
  109930. */
  109931. texture: Nullable<BaseTexture>;
  109932. /**
  109933. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  109934. * Bigger values mean stronger blending
  109935. */
  109936. diffuseBlendLevel: number;
  109937. /**
  109938. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  109939. * Bigger values mean stronger blending. Only used with PBR materials
  109940. */
  109941. roughnessBlendLevel: number;
  109942. /**
  109943. * Defines how strong the bump effect from the detail map is
  109944. * Bigger values mean stronger effect
  109945. */
  109946. bumpLevel: number;
  109947. private _normalBlendMethod;
  109948. /**
  109949. * The method used to blend the bump and detail normals together
  109950. */
  109951. normalBlendMethod: number;
  109952. private _isEnabled;
  109953. /**
  109954. * Enable or disable the detail map on this material
  109955. */
  109956. isEnabled: boolean;
  109957. /** @hidden */
  109958. private _internalMarkAllSubMeshesAsTexturesDirty;
  109959. /** @hidden */
  109960. _markAllSubMeshesAsTexturesDirty(): void;
  109961. /**
  109962. * Instantiate a new detail map
  109963. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  109964. */
  109965. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  109966. /**
  109967. * Gets whether the submesh is ready to be used or not.
  109968. * @param defines the list of "defines" to update.
  109969. * @param scene defines the scene the material belongs to.
  109970. * @returns - boolean indicating that the submesh is ready or not.
  109971. */
  109972. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  109973. /**
  109974. * Update the defines for detail map usage
  109975. * @param defines the list of "defines" to update.
  109976. * @param scene defines the scene the material belongs to.
  109977. */
  109978. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  109979. /**
  109980. * Binds the material data.
  109981. * @param uniformBuffer defines the Uniform buffer to fill in.
  109982. * @param scene defines the scene the material belongs to.
  109983. * @param isFrozen defines whether the material is frozen or not.
  109984. */
  109985. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  109986. /**
  109987. * Checks to see if a texture is used in the material.
  109988. * @param texture - Base texture to use.
  109989. * @returns - Boolean specifying if a texture is used in the material.
  109990. */
  109991. hasTexture(texture: BaseTexture): boolean;
  109992. /**
  109993. * Returns an array of the actively used textures.
  109994. * @param activeTextures Array of BaseTextures
  109995. */
  109996. getActiveTextures(activeTextures: BaseTexture[]): void;
  109997. /**
  109998. * Returns the animatable textures.
  109999. * @param animatables Array of animatable textures.
  110000. */
  110001. getAnimatables(animatables: IAnimatable[]): void;
  110002. /**
  110003. * Disposes the resources of the material.
  110004. * @param forceDisposeTextures - Forces the disposal of all textures.
  110005. */
  110006. dispose(forceDisposeTextures?: boolean): void;
  110007. /**
  110008. * Get the current class name useful for serialization or dynamic coding.
  110009. * @returns "DetailMap"
  110010. */
  110011. getClassName(): string;
  110012. /**
  110013. * Add the required uniforms to the current list.
  110014. * @param uniforms defines the current uniform list.
  110015. */
  110016. static AddUniforms(uniforms: string[]): void;
  110017. /**
  110018. * Add the required samplers to the current list.
  110019. * @param samplers defines the current sampler list.
  110020. */
  110021. static AddSamplers(samplers: string[]): void;
  110022. /**
  110023. * Add the required uniforms to the current buffer.
  110024. * @param uniformBuffer defines the current uniform buffer.
  110025. */
  110026. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  110027. /**
  110028. * Makes a duplicate of the current instance into another one.
  110029. * @param detailMap define the instance where to copy the info
  110030. */
  110031. copyTo(detailMap: DetailMapConfiguration): void;
  110032. /**
  110033. * Serializes this detail map instance
  110034. * @returns - An object with the serialized instance.
  110035. */
  110036. serialize(): any;
  110037. /**
  110038. * Parses a detail map setting from a serialized object.
  110039. * @param source - Serialized object.
  110040. * @param scene Defines the scene we are parsing for
  110041. * @param rootUrl Defines the rootUrl to load from
  110042. */
  110043. parse(source: any, scene: Scene, rootUrl: string): void;
  110044. }
  110045. }
  110046. declare module BABYLON {
  110047. /** @hidden */
  110048. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  110049. MAINUV1: boolean;
  110050. MAINUV2: boolean;
  110051. DIFFUSE: boolean;
  110052. DIFFUSEDIRECTUV: number;
  110053. DETAIL: boolean;
  110054. DETAILDIRECTUV: number;
  110055. DETAIL_NORMALBLENDMETHOD: number;
  110056. AMBIENT: boolean;
  110057. AMBIENTDIRECTUV: number;
  110058. OPACITY: boolean;
  110059. OPACITYDIRECTUV: number;
  110060. OPACITYRGB: boolean;
  110061. REFLECTION: boolean;
  110062. EMISSIVE: boolean;
  110063. EMISSIVEDIRECTUV: number;
  110064. SPECULAR: boolean;
  110065. SPECULARDIRECTUV: number;
  110066. BUMP: boolean;
  110067. BUMPDIRECTUV: number;
  110068. PARALLAX: boolean;
  110069. PARALLAXOCCLUSION: boolean;
  110070. SPECULAROVERALPHA: boolean;
  110071. CLIPPLANE: boolean;
  110072. CLIPPLANE2: boolean;
  110073. CLIPPLANE3: boolean;
  110074. CLIPPLANE4: boolean;
  110075. CLIPPLANE5: boolean;
  110076. CLIPPLANE6: boolean;
  110077. ALPHATEST: boolean;
  110078. DEPTHPREPASS: boolean;
  110079. ALPHAFROMDIFFUSE: boolean;
  110080. POINTSIZE: boolean;
  110081. FOG: boolean;
  110082. SPECULARTERM: boolean;
  110083. DIFFUSEFRESNEL: boolean;
  110084. OPACITYFRESNEL: boolean;
  110085. REFLECTIONFRESNEL: boolean;
  110086. REFRACTIONFRESNEL: boolean;
  110087. EMISSIVEFRESNEL: boolean;
  110088. FRESNEL: boolean;
  110089. NORMAL: boolean;
  110090. UV1: boolean;
  110091. UV2: boolean;
  110092. VERTEXCOLOR: boolean;
  110093. VERTEXALPHA: boolean;
  110094. NUM_BONE_INFLUENCERS: number;
  110095. BonesPerMesh: number;
  110096. BONETEXTURE: boolean;
  110097. INSTANCES: boolean;
  110098. THIN_INSTANCES: boolean;
  110099. GLOSSINESS: boolean;
  110100. ROUGHNESS: boolean;
  110101. EMISSIVEASILLUMINATION: boolean;
  110102. LINKEMISSIVEWITHDIFFUSE: boolean;
  110103. REFLECTIONFRESNELFROMSPECULAR: boolean;
  110104. LIGHTMAP: boolean;
  110105. LIGHTMAPDIRECTUV: number;
  110106. OBJECTSPACE_NORMALMAP: boolean;
  110107. USELIGHTMAPASSHADOWMAP: boolean;
  110108. REFLECTIONMAP_3D: boolean;
  110109. REFLECTIONMAP_SPHERICAL: boolean;
  110110. REFLECTIONMAP_PLANAR: boolean;
  110111. REFLECTIONMAP_CUBIC: boolean;
  110112. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  110113. REFLECTIONMAP_PROJECTION: boolean;
  110114. REFLECTIONMAP_SKYBOX: boolean;
  110115. REFLECTIONMAP_EXPLICIT: boolean;
  110116. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  110117. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  110118. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  110119. INVERTCUBICMAP: boolean;
  110120. LOGARITHMICDEPTH: boolean;
  110121. REFRACTION: boolean;
  110122. REFRACTIONMAP_3D: boolean;
  110123. REFLECTIONOVERALPHA: boolean;
  110124. TWOSIDEDLIGHTING: boolean;
  110125. SHADOWFLOAT: boolean;
  110126. MORPHTARGETS: boolean;
  110127. MORPHTARGETS_NORMAL: boolean;
  110128. MORPHTARGETS_TANGENT: boolean;
  110129. MORPHTARGETS_UV: boolean;
  110130. NUM_MORPH_INFLUENCERS: number;
  110131. NONUNIFORMSCALING: boolean;
  110132. PREMULTIPLYALPHA: boolean;
  110133. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  110134. ALPHABLEND: boolean;
  110135. PREPASS: boolean;
  110136. SCENE_MRT_COUNT: number;
  110137. RGBDLIGHTMAP: boolean;
  110138. RGBDREFLECTION: boolean;
  110139. RGBDREFRACTION: boolean;
  110140. IMAGEPROCESSING: boolean;
  110141. VIGNETTE: boolean;
  110142. VIGNETTEBLENDMODEMULTIPLY: boolean;
  110143. VIGNETTEBLENDMODEOPAQUE: boolean;
  110144. TONEMAPPING: boolean;
  110145. TONEMAPPING_ACES: boolean;
  110146. CONTRAST: boolean;
  110147. COLORCURVES: boolean;
  110148. COLORGRADING: boolean;
  110149. COLORGRADING3D: boolean;
  110150. SAMPLER3DGREENDEPTH: boolean;
  110151. SAMPLER3DBGRMAP: boolean;
  110152. IMAGEPROCESSINGPOSTPROCESS: boolean;
  110153. MULTIVIEW: boolean;
  110154. /**
  110155. * If the reflection texture on this material is in linear color space
  110156. * @hidden
  110157. */
  110158. IS_REFLECTION_LINEAR: boolean;
  110159. /**
  110160. * If the refraction texture on this material is in linear color space
  110161. * @hidden
  110162. */
  110163. IS_REFRACTION_LINEAR: boolean;
  110164. EXPOSURE: boolean;
  110165. constructor();
  110166. setReflectionMode(modeToEnable: string): void;
  110167. }
  110168. /**
  110169. * This is the default material used in Babylon. It is the best trade off between quality
  110170. * and performances.
  110171. * @see https://doc.babylonjs.com/babylon101/materials
  110172. */
  110173. export class StandardMaterial extends PushMaterial {
  110174. private _diffuseTexture;
  110175. /**
  110176. * The basic texture of the material as viewed under a light.
  110177. */
  110178. diffuseTexture: Nullable<BaseTexture>;
  110179. private _ambientTexture;
  110180. /**
  110181. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  110182. */
  110183. ambientTexture: Nullable<BaseTexture>;
  110184. private _opacityTexture;
  110185. /**
  110186. * Define the transparency of the material from a texture.
  110187. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  110188. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  110189. */
  110190. opacityTexture: Nullable<BaseTexture>;
  110191. private _reflectionTexture;
  110192. /**
  110193. * Define the texture used to display the reflection.
  110194. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110195. */
  110196. reflectionTexture: Nullable<BaseTexture>;
  110197. private _emissiveTexture;
  110198. /**
  110199. * Define texture of the material as if self lit.
  110200. * This will be mixed in the final result even in the absence of light.
  110201. */
  110202. emissiveTexture: Nullable<BaseTexture>;
  110203. private _specularTexture;
  110204. /**
  110205. * Define how the color and intensity of the highlight given by the light in the material.
  110206. */
  110207. specularTexture: Nullable<BaseTexture>;
  110208. private _bumpTexture;
  110209. /**
  110210. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  110211. * 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.
  110212. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  110213. */
  110214. bumpTexture: Nullable<BaseTexture>;
  110215. private _lightmapTexture;
  110216. /**
  110217. * Complex lighting can be computationally expensive to compute at runtime.
  110218. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  110219. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  110220. */
  110221. lightmapTexture: Nullable<BaseTexture>;
  110222. private _refractionTexture;
  110223. /**
  110224. * Define the texture used to display the refraction.
  110225. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110226. */
  110227. refractionTexture: Nullable<BaseTexture>;
  110228. /**
  110229. * The color of the material lit by the environmental background lighting.
  110230. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  110231. */
  110232. ambientColor: Color3;
  110233. /**
  110234. * The basic color of the material as viewed under a light.
  110235. */
  110236. diffuseColor: Color3;
  110237. /**
  110238. * Define how the color and intensity of the highlight given by the light in the material.
  110239. */
  110240. specularColor: Color3;
  110241. /**
  110242. * Define the color of the material as if self lit.
  110243. * This will be mixed in the final result even in the absence of light.
  110244. */
  110245. emissiveColor: Color3;
  110246. /**
  110247. * Defines how sharp are the highlights in the material.
  110248. * The bigger the value the sharper giving a more glossy feeling to the result.
  110249. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  110250. */
  110251. specularPower: number;
  110252. private _useAlphaFromDiffuseTexture;
  110253. /**
  110254. * Does the transparency come from the diffuse texture alpha channel.
  110255. */
  110256. useAlphaFromDiffuseTexture: boolean;
  110257. private _useEmissiveAsIllumination;
  110258. /**
  110259. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  110260. */
  110261. useEmissiveAsIllumination: boolean;
  110262. private _linkEmissiveWithDiffuse;
  110263. /**
  110264. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  110265. * the emissive level when the final color is close to one.
  110266. */
  110267. linkEmissiveWithDiffuse: boolean;
  110268. private _useSpecularOverAlpha;
  110269. /**
  110270. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  110271. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  110272. */
  110273. useSpecularOverAlpha: boolean;
  110274. private _useReflectionOverAlpha;
  110275. /**
  110276. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  110277. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  110278. */
  110279. useReflectionOverAlpha: boolean;
  110280. private _disableLighting;
  110281. /**
  110282. * Does lights from the scene impacts this material.
  110283. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  110284. */
  110285. disableLighting: boolean;
  110286. private _useObjectSpaceNormalMap;
  110287. /**
  110288. * Allows using an object space normal map (instead of tangent space).
  110289. */
  110290. useObjectSpaceNormalMap: boolean;
  110291. private _useParallax;
  110292. /**
  110293. * Is parallax enabled or not.
  110294. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110295. */
  110296. useParallax: boolean;
  110297. private _useParallaxOcclusion;
  110298. /**
  110299. * Is parallax occlusion enabled or not.
  110300. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  110301. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110302. */
  110303. useParallaxOcclusion: boolean;
  110304. /**
  110305. * 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.
  110306. */
  110307. parallaxScaleBias: number;
  110308. private _roughness;
  110309. /**
  110310. * Helps to define how blurry the reflections should appears in the material.
  110311. */
  110312. roughness: number;
  110313. /**
  110314. * In case of refraction, define the value of the index of refraction.
  110315. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110316. */
  110317. indexOfRefraction: number;
  110318. /**
  110319. * Invert the refraction texture alongside the y axis.
  110320. * It can be useful with procedural textures or probe for instance.
  110321. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110322. */
  110323. invertRefractionY: boolean;
  110324. /**
  110325. * Defines the alpha limits in alpha test mode.
  110326. */
  110327. alphaCutOff: number;
  110328. private _useLightmapAsShadowmap;
  110329. /**
  110330. * In case of light mapping, define whether the map contains light or shadow informations.
  110331. */
  110332. useLightmapAsShadowmap: boolean;
  110333. private _diffuseFresnelParameters;
  110334. /**
  110335. * Define the diffuse fresnel parameters of the material.
  110336. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110337. */
  110338. diffuseFresnelParameters: FresnelParameters;
  110339. private _opacityFresnelParameters;
  110340. /**
  110341. * Define the opacity fresnel parameters of the material.
  110342. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110343. */
  110344. opacityFresnelParameters: FresnelParameters;
  110345. private _reflectionFresnelParameters;
  110346. /**
  110347. * Define the reflection fresnel parameters of the material.
  110348. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110349. */
  110350. reflectionFresnelParameters: FresnelParameters;
  110351. private _refractionFresnelParameters;
  110352. /**
  110353. * Define the refraction fresnel parameters of the material.
  110354. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110355. */
  110356. refractionFresnelParameters: FresnelParameters;
  110357. private _emissiveFresnelParameters;
  110358. /**
  110359. * Define the emissive fresnel parameters of the material.
  110360. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110361. */
  110362. emissiveFresnelParameters: FresnelParameters;
  110363. private _useReflectionFresnelFromSpecular;
  110364. /**
  110365. * If true automatically deducts the fresnels values from the material specularity.
  110366. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110367. */
  110368. useReflectionFresnelFromSpecular: boolean;
  110369. private _useGlossinessFromSpecularMapAlpha;
  110370. /**
  110371. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  110372. */
  110373. useGlossinessFromSpecularMapAlpha: boolean;
  110374. private _maxSimultaneousLights;
  110375. /**
  110376. * Defines the maximum number of lights that can be used in the material
  110377. */
  110378. maxSimultaneousLights: number;
  110379. private _invertNormalMapX;
  110380. /**
  110381. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  110382. */
  110383. invertNormalMapX: boolean;
  110384. private _invertNormalMapY;
  110385. /**
  110386. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  110387. */
  110388. invertNormalMapY: boolean;
  110389. private _twoSidedLighting;
  110390. /**
  110391. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  110392. */
  110393. twoSidedLighting: boolean;
  110394. /**
  110395. * Default configuration related to image processing available in the standard Material.
  110396. */
  110397. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  110398. /**
  110399. * Gets the image processing configuration used either in this material.
  110400. */
  110401. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  110402. /**
  110403. * Sets the Default image processing configuration used either in the this material.
  110404. *
  110405. * If sets to null, the scene one is in use.
  110406. */
  110407. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  110408. /**
  110409. * Keep track of the image processing observer to allow dispose and replace.
  110410. */
  110411. private _imageProcessingObserver;
  110412. /**
  110413. * Attaches a new image processing configuration to the Standard Material.
  110414. * @param configuration
  110415. */
  110416. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  110417. /**
  110418. * Gets wether the color curves effect is enabled.
  110419. */
  110420. get cameraColorCurvesEnabled(): boolean;
  110421. /**
  110422. * Sets wether the color curves effect is enabled.
  110423. */
  110424. set cameraColorCurvesEnabled(value: boolean);
  110425. /**
  110426. * Gets wether the color grading effect is enabled.
  110427. */
  110428. get cameraColorGradingEnabled(): boolean;
  110429. /**
  110430. * Gets wether the color grading effect is enabled.
  110431. */
  110432. set cameraColorGradingEnabled(value: boolean);
  110433. /**
  110434. * Gets wether tonemapping is enabled or not.
  110435. */
  110436. get cameraToneMappingEnabled(): boolean;
  110437. /**
  110438. * Sets wether tonemapping is enabled or not
  110439. */
  110440. set cameraToneMappingEnabled(value: boolean);
  110441. /**
  110442. * The camera exposure used on this material.
  110443. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110444. * This corresponds to a photographic exposure.
  110445. */
  110446. get cameraExposure(): number;
  110447. /**
  110448. * The camera exposure used on this material.
  110449. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110450. * This corresponds to a photographic exposure.
  110451. */
  110452. set cameraExposure(value: number);
  110453. /**
  110454. * Gets The camera contrast used on this material.
  110455. */
  110456. get cameraContrast(): number;
  110457. /**
  110458. * Sets The camera contrast used on this material.
  110459. */
  110460. set cameraContrast(value: number);
  110461. /**
  110462. * Gets the Color Grading 2D Lookup Texture.
  110463. */
  110464. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  110465. /**
  110466. * Sets the Color Grading 2D Lookup Texture.
  110467. */
  110468. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  110469. /**
  110470. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110471. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110472. * 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;
  110473. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110474. */
  110475. get cameraColorCurves(): Nullable<ColorCurves>;
  110476. /**
  110477. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110478. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110479. * 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;
  110480. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110481. */
  110482. set cameraColorCurves(value: Nullable<ColorCurves>);
  110483. /**
  110484. * Can this material render to several textures at once
  110485. */
  110486. get canRenderToMRT(): boolean;
  110487. /**
  110488. * Defines the detail map parameters for the material.
  110489. */
  110490. readonly detailMap: DetailMapConfiguration;
  110491. protected _renderTargets: SmartArray<RenderTargetTexture>;
  110492. protected _worldViewProjectionMatrix: Matrix;
  110493. protected _globalAmbientColor: Color3;
  110494. protected _useLogarithmicDepth: boolean;
  110495. protected _rebuildInParallel: boolean;
  110496. /**
  110497. * Instantiates a new standard material.
  110498. * This is the default material used in Babylon. It is the best trade off between quality
  110499. * and performances.
  110500. * @see https://doc.babylonjs.com/babylon101/materials
  110501. * @param name Define the name of the material in the scene
  110502. * @param scene Define the scene the material belong to
  110503. */
  110504. constructor(name: string, scene: Scene);
  110505. /**
  110506. * Gets a boolean indicating that current material needs to register RTT
  110507. */
  110508. get hasRenderTargetTextures(): boolean;
  110509. /**
  110510. * Gets the current class name of the material e.g. "StandardMaterial"
  110511. * Mainly use in serialization.
  110512. * @returns the class name
  110513. */
  110514. getClassName(): string;
  110515. /**
  110516. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  110517. * You can try switching to logarithmic depth.
  110518. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  110519. */
  110520. get useLogarithmicDepth(): boolean;
  110521. set useLogarithmicDepth(value: boolean);
  110522. /**
  110523. * Specifies if the material will require alpha blending
  110524. * @returns a boolean specifying if alpha blending is needed
  110525. */
  110526. needAlphaBlending(): boolean;
  110527. /**
  110528. * Specifies if this material should be rendered in alpha test mode
  110529. * @returns a boolean specifying if an alpha test is needed.
  110530. */
  110531. needAlphaTesting(): boolean;
  110532. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  110533. /**
  110534. * Get the texture used for alpha test purpose.
  110535. * @returns the diffuse texture in case of the standard material.
  110536. */
  110537. getAlphaTestTexture(): Nullable<BaseTexture>;
  110538. /**
  110539. * Get if the submesh is ready to be used and all its information available.
  110540. * Child classes can use it to update shaders
  110541. * @param mesh defines the mesh to check
  110542. * @param subMesh defines which submesh to check
  110543. * @param useInstances specifies that instances should be used
  110544. * @returns a boolean indicating that the submesh is ready or not
  110545. */
  110546. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  110547. /**
  110548. * Builds the material UBO layouts.
  110549. * Used internally during the effect preparation.
  110550. */
  110551. buildUniformLayout(): void;
  110552. /**
  110553. * Unbinds the material from the mesh
  110554. */
  110555. unbind(): void;
  110556. /**
  110557. * Binds the submesh to this material by preparing the effect and shader to draw
  110558. * @param world defines the world transformation matrix
  110559. * @param mesh defines the mesh containing the submesh
  110560. * @param subMesh defines the submesh to bind the material to
  110561. */
  110562. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  110563. /**
  110564. * Get the list of animatables in the material.
  110565. * @returns the list of animatables object used in the material
  110566. */
  110567. getAnimatables(): IAnimatable[];
  110568. /**
  110569. * Gets the active textures from the material
  110570. * @returns an array of textures
  110571. */
  110572. getActiveTextures(): BaseTexture[];
  110573. /**
  110574. * Specifies if the material uses a texture
  110575. * @param texture defines the texture to check against the material
  110576. * @returns a boolean specifying if the material uses the texture
  110577. */
  110578. hasTexture(texture: BaseTexture): boolean;
  110579. /**
  110580. * Disposes the material
  110581. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  110582. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  110583. */
  110584. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  110585. /**
  110586. * Makes a duplicate of the material, and gives it a new name
  110587. * @param name defines the new name for the duplicated material
  110588. * @returns the cloned material
  110589. */
  110590. clone(name: string): StandardMaterial;
  110591. /**
  110592. * Serializes this material in a JSON representation
  110593. * @returns the serialized material object
  110594. */
  110595. serialize(): any;
  110596. /**
  110597. * Creates a standard material from parsed material data
  110598. * @param source defines the JSON representation of the material
  110599. * @param scene defines the hosting scene
  110600. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  110601. * @returns a new standard material
  110602. */
  110603. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  110604. /**
  110605. * Are diffuse textures enabled in the application.
  110606. */
  110607. static get DiffuseTextureEnabled(): boolean;
  110608. static set DiffuseTextureEnabled(value: boolean);
  110609. /**
  110610. * Are detail textures enabled in the application.
  110611. */
  110612. static get DetailTextureEnabled(): boolean;
  110613. static set DetailTextureEnabled(value: boolean);
  110614. /**
  110615. * Are ambient textures enabled in the application.
  110616. */
  110617. static get AmbientTextureEnabled(): boolean;
  110618. static set AmbientTextureEnabled(value: boolean);
  110619. /**
  110620. * Are opacity textures enabled in the application.
  110621. */
  110622. static get OpacityTextureEnabled(): boolean;
  110623. static set OpacityTextureEnabled(value: boolean);
  110624. /**
  110625. * Are reflection textures enabled in the application.
  110626. */
  110627. static get ReflectionTextureEnabled(): boolean;
  110628. static set ReflectionTextureEnabled(value: boolean);
  110629. /**
  110630. * Are emissive textures enabled in the application.
  110631. */
  110632. static get EmissiveTextureEnabled(): boolean;
  110633. static set EmissiveTextureEnabled(value: boolean);
  110634. /**
  110635. * Are specular textures enabled in the application.
  110636. */
  110637. static get SpecularTextureEnabled(): boolean;
  110638. static set SpecularTextureEnabled(value: boolean);
  110639. /**
  110640. * Are bump textures enabled in the application.
  110641. */
  110642. static get BumpTextureEnabled(): boolean;
  110643. static set BumpTextureEnabled(value: boolean);
  110644. /**
  110645. * Are lightmap textures enabled in the application.
  110646. */
  110647. static get LightmapTextureEnabled(): boolean;
  110648. static set LightmapTextureEnabled(value: boolean);
  110649. /**
  110650. * Are refraction textures enabled in the application.
  110651. */
  110652. static get RefractionTextureEnabled(): boolean;
  110653. static set RefractionTextureEnabled(value: boolean);
  110654. /**
  110655. * Are color grading textures enabled in the application.
  110656. */
  110657. static get ColorGradingTextureEnabled(): boolean;
  110658. static set ColorGradingTextureEnabled(value: boolean);
  110659. /**
  110660. * Are fresnels enabled in the application.
  110661. */
  110662. static get FresnelEnabled(): boolean;
  110663. static set FresnelEnabled(value: boolean);
  110664. }
  110665. }
  110666. declare module BABYLON {
  110667. /**
  110668. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  110669. *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.
  110670. * The SPS is also a particle system. It provides some methods to manage the particles.
  110671. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  110672. *
  110673. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  110674. */
  110675. export class SolidParticleSystem implements IDisposable {
  110676. /**
  110677. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  110678. * Example : var p = SPS.particles[i];
  110679. */
  110680. particles: SolidParticle[];
  110681. /**
  110682. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  110683. */
  110684. nbParticles: number;
  110685. /**
  110686. * If the particles must ever face the camera (default false). Useful for planar particles.
  110687. */
  110688. billboard: boolean;
  110689. /**
  110690. * Recompute normals when adding a shape
  110691. */
  110692. recomputeNormals: boolean;
  110693. /**
  110694. * This a counter ofr your own usage. It's not set by any SPS functions.
  110695. */
  110696. counter: number;
  110697. /**
  110698. * The SPS name. This name is also given to the underlying mesh.
  110699. */
  110700. name: string;
  110701. /**
  110702. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  110703. */
  110704. mesh: Mesh;
  110705. /**
  110706. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  110707. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  110708. */
  110709. vars: any;
  110710. /**
  110711. * This array is populated when the SPS is set as 'pickable'.
  110712. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  110713. * Each element of this array is an object `{idx: int, faceId: int}`.
  110714. * `idx` is the picked particle index in the `SPS.particles` array
  110715. * `faceId` is the picked face index counted within this particle.
  110716. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  110717. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  110718. * Use the method SPS.pickedParticle(pickingInfo) instead.
  110719. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110720. */
  110721. pickedParticles: {
  110722. idx: number;
  110723. faceId: number;
  110724. }[];
  110725. /**
  110726. * This array is populated when the SPS is set as 'pickable'
  110727. * Each key of this array is a submesh index.
  110728. * Each element of this array is a second array defined like this :
  110729. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  110730. * Each element of this second array is an object `{idx: int, faceId: int}`.
  110731. * `idx` is the picked particle index in the `SPS.particles` array
  110732. * `faceId` is the picked face index counted within this particle.
  110733. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  110734. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110735. */
  110736. pickedBySubMesh: {
  110737. idx: number;
  110738. faceId: number;
  110739. }[][];
  110740. /**
  110741. * This array is populated when `enableDepthSort` is set to true.
  110742. * Each element of this array is an instance of the class DepthSortedParticle.
  110743. */
  110744. depthSortedParticles: DepthSortedParticle[];
  110745. /**
  110746. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  110747. * @hidden
  110748. */
  110749. _bSphereOnly: boolean;
  110750. /**
  110751. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  110752. * @hidden
  110753. */
  110754. _bSphereRadiusFactor: number;
  110755. private _scene;
  110756. private _positions;
  110757. private _indices;
  110758. private _normals;
  110759. private _colors;
  110760. private _uvs;
  110761. private _indices32;
  110762. private _positions32;
  110763. private _normals32;
  110764. private _fixedNormal32;
  110765. private _colors32;
  110766. private _uvs32;
  110767. private _index;
  110768. private _updatable;
  110769. private _pickable;
  110770. private _isVisibilityBoxLocked;
  110771. private _alwaysVisible;
  110772. private _depthSort;
  110773. private _expandable;
  110774. private _shapeCounter;
  110775. private _copy;
  110776. private _color;
  110777. private _computeParticleColor;
  110778. private _computeParticleTexture;
  110779. private _computeParticleRotation;
  110780. private _computeParticleVertex;
  110781. private _computeBoundingBox;
  110782. private _depthSortParticles;
  110783. private _camera;
  110784. private _mustUnrotateFixedNormals;
  110785. private _particlesIntersect;
  110786. private _needs32Bits;
  110787. private _isNotBuilt;
  110788. private _lastParticleId;
  110789. private _idxOfId;
  110790. private _multimaterialEnabled;
  110791. private _useModelMaterial;
  110792. private _indicesByMaterial;
  110793. private _materialIndexes;
  110794. private _depthSortFunction;
  110795. private _materialSortFunction;
  110796. private _materials;
  110797. private _multimaterial;
  110798. private _materialIndexesById;
  110799. private _defaultMaterial;
  110800. private _autoUpdateSubMeshes;
  110801. private _tmpVertex;
  110802. /**
  110803. * Creates a SPS (Solid Particle System) object.
  110804. * @param name (String) is the SPS name, this will be the underlying mesh name.
  110805. * @param scene (Scene) is the scene in which the SPS is added.
  110806. * @param options defines the options of the sps e.g.
  110807. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  110808. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  110809. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  110810. * * 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.
  110811. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  110812. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  110813. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  110814. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  110815. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  110816. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  110817. */
  110818. constructor(name: string, scene: Scene, options?: {
  110819. updatable?: boolean;
  110820. isPickable?: boolean;
  110821. enableDepthSort?: boolean;
  110822. particleIntersection?: boolean;
  110823. boundingSphereOnly?: boolean;
  110824. bSphereRadiusFactor?: number;
  110825. expandable?: boolean;
  110826. useModelMaterial?: boolean;
  110827. enableMultiMaterial?: boolean;
  110828. });
  110829. /**
  110830. * Builds the SPS underlying mesh. Returns a standard Mesh.
  110831. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  110832. * @returns the created mesh
  110833. */
  110834. buildMesh(): Mesh;
  110835. /**
  110836. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  110837. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  110838. * Thus the particles generated from `digest()` have their property `position` set yet.
  110839. * @param mesh ( Mesh ) is the mesh to be digested
  110840. * @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
  110841. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  110842. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  110843. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110844. * @returns the current SPS
  110845. */
  110846. digest(mesh: Mesh, options?: {
  110847. facetNb?: number;
  110848. number?: number;
  110849. delta?: number;
  110850. storage?: [];
  110851. }): SolidParticleSystem;
  110852. /**
  110853. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  110854. * @hidden
  110855. */
  110856. private _unrotateFixedNormals;
  110857. /**
  110858. * Resets the temporary working copy particle
  110859. * @hidden
  110860. */
  110861. private _resetCopy;
  110862. /**
  110863. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  110864. * @param p the current index in the positions array to be updated
  110865. * @param ind the current index in the indices array
  110866. * @param shape a Vector3 array, the shape geometry
  110867. * @param positions the positions array to be updated
  110868. * @param meshInd the shape indices array
  110869. * @param indices the indices array to be updated
  110870. * @param meshUV the shape uv array
  110871. * @param uvs the uv array to be updated
  110872. * @param meshCol the shape color array
  110873. * @param colors the color array to be updated
  110874. * @param meshNor the shape normals array
  110875. * @param normals the normals array to be updated
  110876. * @param idx the particle index
  110877. * @param idxInShape the particle index in its shape
  110878. * @param options the addShape() method passed options
  110879. * @model the particle model
  110880. * @hidden
  110881. */
  110882. private _meshBuilder;
  110883. /**
  110884. * Returns a shape Vector3 array from positions float array
  110885. * @param positions float array
  110886. * @returns a vector3 array
  110887. * @hidden
  110888. */
  110889. private _posToShape;
  110890. /**
  110891. * Returns a shapeUV array from a float uvs (array deep copy)
  110892. * @param uvs as a float array
  110893. * @returns a shapeUV array
  110894. * @hidden
  110895. */
  110896. private _uvsToShapeUV;
  110897. /**
  110898. * Adds a new particle object in the particles array
  110899. * @param idx particle index in particles array
  110900. * @param id particle id
  110901. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  110902. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  110903. * @param model particle ModelShape object
  110904. * @param shapeId model shape identifier
  110905. * @param idxInShape index of the particle in the current model
  110906. * @param bInfo model bounding info object
  110907. * @param storage target storage array, if any
  110908. * @hidden
  110909. */
  110910. private _addParticle;
  110911. /**
  110912. * Adds some particles to the SPS from the model shape. Returns the shape id.
  110913. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  110914. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  110915. * @param nb (positive integer) the number of particles to be created from this model
  110916. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  110917. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  110918. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110919. * @returns the number of shapes in the system
  110920. */
  110921. addShape(mesh: Mesh, nb: number, options?: {
  110922. positionFunction?: any;
  110923. vertexFunction?: any;
  110924. storage?: [];
  110925. }): number;
  110926. /**
  110927. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  110928. * @hidden
  110929. */
  110930. private _rebuildParticle;
  110931. /**
  110932. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  110933. * @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.
  110934. * @returns the SPS.
  110935. */
  110936. rebuildMesh(reset?: boolean): SolidParticleSystem;
  110937. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  110938. * Returns an array with the removed particles.
  110939. * 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.
  110940. * The SPS can't be empty so at least one particle needs to remain in place.
  110941. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  110942. * @param start index of the first particle to remove
  110943. * @param end index of the last particle to remove (included)
  110944. * @returns an array populated with the removed particles
  110945. */
  110946. removeParticles(start: number, end: number): SolidParticle[];
  110947. /**
  110948. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  110949. * @param solidParticleArray an array populated with Solid Particles objects
  110950. * @returns the SPS
  110951. */
  110952. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  110953. /**
  110954. * Creates a new particle and modifies the SPS mesh geometry :
  110955. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  110956. * - calls _addParticle() to populate the particle array
  110957. * factorized code from addShape() and insertParticlesFromArray()
  110958. * @param idx particle index in the particles array
  110959. * @param i particle index in its shape
  110960. * @param modelShape particle ModelShape object
  110961. * @param shape shape vertex array
  110962. * @param meshInd shape indices array
  110963. * @param meshUV shape uv array
  110964. * @param meshCol shape color array
  110965. * @param meshNor shape normals array
  110966. * @param bbInfo shape bounding info
  110967. * @param storage target particle storage
  110968. * @options addShape() passed options
  110969. * @hidden
  110970. */
  110971. private _insertNewParticle;
  110972. /**
  110973. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  110974. * This method calls `updateParticle()` for each particle of the SPS.
  110975. * For an animated SPS, it is usually called within the render loop.
  110976. * 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.
  110977. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  110978. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  110979. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  110980. * @returns the SPS.
  110981. */
  110982. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  110983. /**
  110984. * Disposes the SPS.
  110985. */
  110986. dispose(): void;
  110987. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  110988. * idx is the particle index in the SPS
  110989. * faceId is the picked face index counted within this particle.
  110990. * Returns null if the pickInfo can't identify a picked particle.
  110991. * @param pickingInfo (PickingInfo object)
  110992. * @returns {idx: number, faceId: number} or null
  110993. */
  110994. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  110995. idx: number;
  110996. faceId: number;
  110997. }>;
  110998. /**
  110999. * Returns a SolidParticle object from its identifier : particle.id
  111000. * @param id (integer) the particle Id
  111001. * @returns the searched particle or null if not found in the SPS.
  111002. */
  111003. getParticleById(id: number): Nullable<SolidParticle>;
  111004. /**
  111005. * Returns a new array populated with the particles having the passed shapeId.
  111006. * @param shapeId (integer) the shape identifier
  111007. * @returns a new solid particle array
  111008. */
  111009. getParticlesByShapeId(shapeId: number): SolidParticle[];
  111010. /**
  111011. * Populates the passed array "ref" with the particles having the passed shapeId.
  111012. * @param shapeId the shape identifier
  111013. * @returns the SPS
  111014. * @param ref
  111015. */
  111016. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  111017. /**
  111018. * Computes the required SubMeshes according the materials assigned to the particles.
  111019. * @returns the solid particle system.
  111020. * Does nothing if called before the SPS mesh is built.
  111021. */
  111022. computeSubMeshes(): SolidParticleSystem;
  111023. /**
  111024. * Sorts the solid particles by material when MultiMaterial is enabled.
  111025. * Updates the indices32 array.
  111026. * Updates the indicesByMaterial array.
  111027. * Updates the mesh indices array.
  111028. * @returns the SPS
  111029. * @hidden
  111030. */
  111031. private _sortParticlesByMaterial;
  111032. /**
  111033. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  111034. * @hidden
  111035. */
  111036. private _setMaterialIndexesById;
  111037. /**
  111038. * Returns an array with unique values of Materials from the passed array
  111039. * @param array the material array to be checked and filtered
  111040. * @hidden
  111041. */
  111042. private _filterUniqueMaterialId;
  111043. /**
  111044. * Sets a new Standard Material as _defaultMaterial if not already set.
  111045. * @hidden
  111046. */
  111047. private _setDefaultMaterial;
  111048. /**
  111049. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  111050. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111051. * @returns the SPS.
  111052. */
  111053. refreshVisibleSize(): SolidParticleSystem;
  111054. /**
  111055. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  111056. * @param size the size (float) of the visibility box
  111057. * note : this doesn't lock the SPS mesh bounding box.
  111058. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111059. */
  111060. setVisibilityBox(size: number): void;
  111061. /**
  111062. * Gets whether the SPS as always visible or not
  111063. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111064. */
  111065. get isAlwaysVisible(): boolean;
  111066. /**
  111067. * Sets the SPS as always visible or not
  111068. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111069. */
  111070. set isAlwaysVisible(val: boolean);
  111071. /**
  111072. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111073. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111074. */
  111075. set isVisibilityBoxLocked(val: boolean);
  111076. /**
  111077. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111078. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111079. */
  111080. get isVisibilityBoxLocked(): boolean;
  111081. /**
  111082. * Tells to `setParticles()` to compute the particle rotations or not.
  111083. * Default value : true. The SPS is faster when it's set to false.
  111084. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111085. */
  111086. set computeParticleRotation(val: boolean);
  111087. /**
  111088. * Tells to `setParticles()` to compute the particle colors or not.
  111089. * Default value : true. The SPS is faster when it's set to false.
  111090. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111091. */
  111092. set computeParticleColor(val: boolean);
  111093. set computeParticleTexture(val: boolean);
  111094. /**
  111095. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  111096. * Default value : false. The SPS is faster when it's set to false.
  111097. * Note : the particle custom vertex positions aren't stored values.
  111098. */
  111099. set computeParticleVertex(val: boolean);
  111100. /**
  111101. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  111102. */
  111103. set computeBoundingBox(val: boolean);
  111104. /**
  111105. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  111106. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111107. * Default : `true`
  111108. */
  111109. set depthSortParticles(val: boolean);
  111110. /**
  111111. * Gets if `setParticles()` computes the particle rotations or not.
  111112. * Default value : true. The SPS is faster when it's set to false.
  111113. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111114. */
  111115. get computeParticleRotation(): boolean;
  111116. /**
  111117. * Gets if `setParticles()` computes the particle colors or not.
  111118. * Default value : true. The SPS is faster when it's set to false.
  111119. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111120. */
  111121. get computeParticleColor(): boolean;
  111122. /**
  111123. * Gets if `setParticles()` computes the particle textures or not.
  111124. * Default value : true. The SPS is faster when it's set to false.
  111125. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  111126. */
  111127. get computeParticleTexture(): boolean;
  111128. /**
  111129. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  111130. * Default value : false. The SPS is faster when it's set to false.
  111131. * Note : the particle custom vertex positions aren't stored values.
  111132. */
  111133. get computeParticleVertex(): boolean;
  111134. /**
  111135. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  111136. */
  111137. get computeBoundingBox(): boolean;
  111138. /**
  111139. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  111140. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111141. * Default : `true`
  111142. */
  111143. get depthSortParticles(): boolean;
  111144. /**
  111145. * Gets if the SPS is created as expandable at construction time.
  111146. * Default : `false`
  111147. */
  111148. get expandable(): boolean;
  111149. /**
  111150. * Gets if the SPS supports the Multi Materials
  111151. */
  111152. get multimaterialEnabled(): boolean;
  111153. /**
  111154. * Gets if the SPS uses the model materials for its own multimaterial.
  111155. */
  111156. get useModelMaterial(): boolean;
  111157. /**
  111158. * The SPS used material array.
  111159. */
  111160. get materials(): Material[];
  111161. /**
  111162. * Sets the SPS MultiMaterial from the passed materials.
  111163. * Note : the passed array is internally copied and not used then by reference.
  111164. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  111165. */
  111166. setMultiMaterial(materials: Material[]): void;
  111167. /**
  111168. * The SPS computed multimaterial object
  111169. */
  111170. get multimaterial(): MultiMaterial;
  111171. set multimaterial(mm: MultiMaterial);
  111172. /**
  111173. * If the subMeshes must be updated on the next call to setParticles()
  111174. */
  111175. get autoUpdateSubMeshes(): boolean;
  111176. set autoUpdateSubMeshes(val: boolean);
  111177. /**
  111178. * This function does nothing. It may be overwritten to set all the particle first values.
  111179. * The SPS doesn't call this function, you may have to call it by your own.
  111180. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111181. */
  111182. initParticles(): void;
  111183. /**
  111184. * This function does nothing. It may be overwritten to recycle a particle.
  111185. * The SPS doesn't call this function, you may have to call it by your own.
  111186. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111187. * @param particle The particle to recycle
  111188. * @returns the recycled particle
  111189. */
  111190. recycleParticle(particle: SolidParticle): SolidParticle;
  111191. /**
  111192. * Updates a particle : this function should be overwritten by the user.
  111193. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  111194. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111195. * @example : just set a particle position or velocity and recycle conditions
  111196. * @param particle The particle to update
  111197. * @returns the updated particle
  111198. */
  111199. updateParticle(particle: SolidParticle): SolidParticle;
  111200. /**
  111201. * Updates a vertex of a particle : it can be overwritten by the user.
  111202. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  111203. * @param particle the current particle
  111204. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  111205. * @param pt the index of the current vertex in the particle shape
  111206. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  111207. * @example : just set a vertex particle position or color
  111208. * @returns the sps
  111209. */
  111210. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  111211. /**
  111212. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  111213. * This does nothing and may be overwritten by the user.
  111214. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111215. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111216. * @param update the boolean update value actually passed to setParticles()
  111217. */
  111218. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111219. /**
  111220. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  111221. * This 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. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111228. }
  111229. }
  111230. declare module BABYLON {
  111231. /**
  111232. * Represents one particle of a solid particle system.
  111233. */
  111234. export class SolidParticle {
  111235. /**
  111236. * particle global index
  111237. */
  111238. idx: number;
  111239. /**
  111240. * particle identifier
  111241. */
  111242. id: number;
  111243. /**
  111244. * The color of the particle
  111245. */
  111246. color: Nullable<Color4>;
  111247. /**
  111248. * The world space position of the particle.
  111249. */
  111250. position: Vector3;
  111251. /**
  111252. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  111253. */
  111254. rotation: Vector3;
  111255. /**
  111256. * The world space rotation quaternion of the particle.
  111257. */
  111258. rotationQuaternion: Nullable<Quaternion>;
  111259. /**
  111260. * The scaling of the particle.
  111261. */
  111262. scaling: Vector3;
  111263. /**
  111264. * The uvs of the particle.
  111265. */
  111266. uvs: Vector4;
  111267. /**
  111268. * The current speed of the particle.
  111269. */
  111270. velocity: Vector3;
  111271. /**
  111272. * The pivot point in the particle local space.
  111273. */
  111274. pivot: Vector3;
  111275. /**
  111276. * Must the particle be translated from its pivot point in its local space ?
  111277. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  111278. * Default : false
  111279. */
  111280. translateFromPivot: boolean;
  111281. /**
  111282. * Is the particle active or not ?
  111283. */
  111284. alive: boolean;
  111285. /**
  111286. * Is the particle visible or not ?
  111287. */
  111288. isVisible: boolean;
  111289. /**
  111290. * Index of this particle in the global "positions" array (Internal use)
  111291. * @hidden
  111292. */
  111293. _pos: number;
  111294. /**
  111295. * @hidden Index of this particle in the global "indices" array (Internal use)
  111296. */
  111297. _ind: number;
  111298. /**
  111299. * @hidden ModelShape of this particle (Internal use)
  111300. */
  111301. _model: ModelShape;
  111302. /**
  111303. * ModelShape id of this particle
  111304. */
  111305. shapeId: number;
  111306. /**
  111307. * Index of the particle in its shape id
  111308. */
  111309. idxInShape: number;
  111310. /**
  111311. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  111312. */
  111313. _modelBoundingInfo: BoundingInfo;
  111314. /**
  111315. * @hidden Particle BoundingInfo object (Internal use)
  111316. */
  111317. _boundingInfo: BoundingInfo;
  111318. /**
  111319. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  111320. */
  111321. _sps: SolidParticleSystem;
  111322. /**
  111323. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  111324. */
  111325. _stillInvisible: boolean;
  111326. /**
  111327. * @hidden Last computed particle rotation matrix
  111328. */
  111329. _rotationMatrix: number[];
  111330. /**
  111331. * Parent particle Id, if any.
  111332. * Default null.
  111333. */
  111334. parentId: Nullable<number>;
  111335. /**
  111336. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  111337. */
  111338. materialIndex: Nullable<number>;
  111339. /**
  111340. * Custom object or properties.
  111341. */
  111342. props: Nullable<any>;
  111343. /**
  111344. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  111345. * The possible values are :
  111346. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111347. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111348. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111349. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111350. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111351. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  111352. * */
  111353. cullingStrategy: number;
  111354. /**
  111355. * @hidden Internal global position in the SPS.
  111356. */
  111357. _globalPosition: Vector3;
  111358. /**
  111359. * Creates a Solid Particle object.
  111360. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  111361. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  111362. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  111363. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  111364. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  111365. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  111366. * @param shapeId (integer) is the model shape identifier in the SPS.
  111367. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  111368. * @param sps defines the sps it is associated to
  111369. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  111370. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  111371. */
  111372. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  111373. /**
  111374. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  111375. * @param target the particle target
  111376. * @returns the current particle
  111377. */
  111378. copyToRef(target: SolidParticle): SolidParticle;
  111379. /**
  111380. * Legacy support, changed scale to scaling
  111381. */
  111382. get scale(): Vector3;
  111383. /**
  111384. * Legacy support, changed scale to scaling
  111385. */
  111386. set scale(scale: Vector3);
  111387. /**
  111388. * Legacy support, changed quaternion to rotationQuaternion
  111389. */
  111390. get quaternion(): Nullable<Quaternion>;
  111391. /**
  111392. * Legacy support, changed quaternion to rotationQuaternion
  111393. */
  111394. set quaternion(q: Nullable<Quaternion>);
  111395. /**
  111396. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  111397. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  111398. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  111399. * @returns true if it intersects
  111400. */
  111401. intersectsMesh(target: Mesh | SolidParticle): boolean;
  111402. /**
  111403. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  111404. * A particle is in the frustum if its bounding box intersects the frustum
  111405. * @param frustumPlanes defines the frustum to test
  111406. * @returns true if the particle is in the frustum planes
  111407. */
  111408. isInFrustum(frustumPlanes: Plane[]): boolean;
  111409. /**
  111410. * get the rotation matrix of the particle
  111411. * @hidden
  111412. */
  111413. getRotationMatrix(m: Matrix): void;
  111414. }
  111415. /**
  111416. * Represents the shape of the model used by one particle of a solid particle system.
  111417. * SPS internal tool, don't use it manually.
  111418. */
  111419. export class ModelShape {
  111420. /**
  111421. * The shape id
  111422. * @hidden
  111423. */
  111424. shapeID: number;
  111425. /**
  111426. * flat array of model positions (internal use)
  111427. * @hidden
  111428. */
  111429. _shape: Vector3[];
  111430. /**
  111431. * flat array of model UVs (internal use)
  111432. * @hidden
  111433. */
  111434. _shapeUV: number[];
  111435. /**
  111436. * color array of the model
  111437. * @hidden
  111438. */
  111439. _shapeColors: number[];
  111440. /**
  111441. * indices array of the model
  111442. * @hidden
  111443. */
  111444. _indices: number[];
  111445. /**
  111446. * normals array of the model
  111447. * @hidden
  111448. */
  111449. _normals: number[];
  111450. /**
  111451. * length of the shape in the model indices array (internal use)
  111452. * @hidden
  111453. */
  111454. _indicesLength: number;
  111455. /**
  111456. * Custom position function (internal use)
  111457. * @hidden
  111458. */
  111459. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  111460. /**
  111461. * Custom vertex function (internal use)
  111462. * @hidden
  111463. */
  111464. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  111465. /**
  111466. * Model material (internal use)
  111467. * @hidden
  111468. */
  111469. _material: Nullable<Material>;
  111470. /**
  111471. * 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.
  111472. * SPS internal tool, don't use it manually.
  111473. * @hidden
  111474. */
  111475. 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>);
  111476. }
  111477. /**
  111478. * Represents a Depth Sorted Particle in the solid particle system.
  111479. * @hidden
  111480. */
  111481. export class DepthSortedParticle {
  111482. /**
  111483. * Particle index
  111484. */
  111485. idx: number;
  111486. /**
  111487. * Index of the particle in the "indices" array
  111488. */
  111489. ind: number;
  111490. /**
  111491. * Length of the particle shape in the "indices" array
  111492. */
  111493. indicesLength: number;
  111494. /**
  111495. * Squared distance from the particle to the camera
  111496. */
  111497. sqDistance: number;
  111498. /**
  111499. * Material index when used with MultiMaterials
  111500. */
  111501. materialIndex: number;
  111502. /**
  111503. * Creates a new sorted particle
  111504. * @param materialIndex
  111505. */
  111506. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  111507. }
  111508. /**
  111509. * Represents a solid particle vertex
  111510. */
  111511. export class SolidParticleVertex {
  111512. /**
  111513. * Vertex position
  111514. */
  111515. position: Vector3;
  111516. /**
  111517. * Vertex color
  111518. */
  111519. color: Color4;
  111520. /**
  111521. * Vertex UV
  111522. */
  111523. uv: Vector2;
  111524. /**
  111525. * Creates a new solid particle vertex
  111526. */
  111527. constructor();
  111528. /** Vertex x coordinate */
  111529. get x(): number;
  111530. set x(val: number);
  111531. /** Vertex y coordinate */
  111532. get y(): number;
  111533. set y(val: number);
  111534. /** Vertex z coordinate */
  111535. get z(): number;
  111536. set z(val: number);
  111537. }
  111538. }
  111539. declare module BABYLON {
  111540. /**
  111541. * @hidden
  111542. */
  111543. export class _MeshCollisionData {
  111544. _checkCollisions: boolean;
  111545. _collisionMask: number;
  111546. _collisionGroup: number;
  111547. _surroundingMeshes: Nullable<AbstractMesh[]>;
  111548. _collider: Nullable<Collider>;
  111549. _oldPositionForCollisions: Vector3;
  111550. _diffPositionForCollisions: Vector3;
  111551. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  111552. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  111553. }
  111554. }
  111555. declare module BABYLON {
  111556. /** @hidden */
  111557. class _FacetDataStorage {
  111558. facetPositions: Vector3[];
  111559. facetNormals: Vector3[];
  111560. facetPartitioning: number[][];
  111561. facetNb: number;
  111562. partitioningSubdivisions: number;
  111563. partitioningBBoxRatio: number;
  111564. facetDataEnabled: boolean;
  111565. facetParameters: any;
  111566. bbSize: Vector3;
  111567. subDiv: {
  111568. max: number;
  111569. X: number;
  111570. Y: number;
  111571. Z: number;
  111572. };
  111573. facetDepthSort: boolean;
  111574. facetDepthSortEnabled: boolean;
  111575. depthSortedIndices: IndicesArray;
  111576. depthSortedFacets: {
  111577. ind: number;
  111578. sqDistance: number;
  111579. }[];
  111580. facetDepthSortFunction: (f1: {
  111581. ind: number;
  111582. sqDistance: number;
  111583. }, f2: {
  111584. ind: number;
  111585. sqDistance: number;
  111586. }) => number;
  111587. facetDepthSortFrom: Vector3;
  111588. facetDepthSortOrigin: Vector3;
  111589. invertedMatrix: Matrix;
  111590. }
  111591. /**
  111592. * @hidden
  111593. **/
  111594. class _InternalAbstractMeshDataInfo {
  111595. _hasVertexAlpha: boolean;
  111596. _useVertexColors: boolean;
  111597. _numBoneInfluencers: number;
  111598. _applyFog: boolean;
  111599. _receiveShadows: boolean;
  111600. _facetData: _FacetDataStorage;
  111601. _visibility: number;
  111602. _skeleton: Nullable<Skeleton>;
  111603. _layerMask: number;
  111604. _computeBonesUsingShaders: boolean;
  111605. _isActive: boolean;
  111606. _onlyForInstances: boolean;
  111607. _isActiveIntermediate: boolean;
  111608. _onlyForInstancesIntermediate: boolean;
  111609. _actAsRegularMesh: boolean;
  111610. }
  111611. /**
  111612. * Class used to store all common mesh properties
  111613. */
  111614. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  111615. /** No occlusion */
  111616. static OCCLUSION_TYPE_NONE: number;
  111617. /** Occlusion set to optimisitic */
  111618. static OCCLUSION_TYPE_OPTIMISTIC: number;
  111619. /** Occlusion set to strict */
  111620. static OCCLUSION_TYPE_STRICT: number;
  111621. /** Use an accurante occlusion algorithm */
  111622. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  111623. /** Use a conservative occlusion algorithm */
  111624. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  111625. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  111626. * Test order :
  111627. * Is the bounding sphere outside the frustum ?
  111628. * If not, are the bounding box vertices outside the frustum ?
  111629. * It not, then the cullable object is in the frustum.
  111630. */
  111631. static readonly CULLINGSTRATEGY_STANDARD: number;
  111632. /** Culling strategy : Bounding Sphere Only.
  111633. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  111634. * It's also less accurate than the standard because some not visible objects can still be selected.
  111635. * Test : is the bounding sphere outside the frustum ?
  111636. * If not, then the cullable object is in the frustum.
  111637. */
  111638. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  111639. /** Culling strategy : Optimistic Inclusion.
  111640. * This in an inclusion test first, then the standard exclusion test.
  111641. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  111642. * 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.
  111643. * Anyway, it's as accurate as the standard strategy.
  111644. * Test :
  111645. * Is the cullable object bounding sphere center in the frustum ?
  111646. * If not, apply the default culling strategy.
  111647. */
  111648. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  111649. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  111650. * This in an inclusion test first, then the bounding sphere only exclusion test.
  111651. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  111652. * 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.
  111653. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  111654. * Test :
  111655. * Is the cullable object bounding sphere center in the frustum ?
  111656. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  111657. */
  111658. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  111659. /**
  111660. * No billboard
  111661. */
  111662. static get BILLBOARDMODE_NONE(): number;
  111663. /** Billboard on X axis */
  111664. static get BILLBOARDMODE_X(): number;
  111665. /** Billboard on Y axis */
  111666. static get BILLBOARDMODE_Y(): number;
  111667. /** Billboard on Z axis */
  111668. static get BILLBOARDMODE_Z(): number;
  111669. /** Billboard on all axes */
  111670. static get BILLBOARDMODE_ALL(): number;
  111671. /** Billboard on using position instead of orientation */
  111672. static get BILLBOARDMODE_USE_POSITION(): number;
  111673. /** @hidden */
  111674. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  111675. /**
  111676. * The culling strategy to use to check whether the mesh must be rendered or not.
  111677. * This value can be changed at any time and will be used on the next render mesh selection.
  111678. * The possible values are :
  111679. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111680. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111681. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111682. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111683. * Please read each static variable documentation to get details about the culling process.
  111684. * */
  111685. cullingStrategy: number;
  111686. /**
  111687. * Gets the number of facets in the mesh
  111688. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111689. */
  111690. get facetNb(): number;
  111691. /**
  111692. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  111693. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111694. */
  111695. get partitioningSubdivisions(): number;
  111696. set partitioningSubdivisions(nb: number);
  111697. /**
  111698. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  111699. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  111700. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111701. */
  111702. get partitioningBBoxRatio(): number;
  111703. set partitioningBBoxRatio(ratio: number);
  111704. /**
  111705. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  111706. * Works only for updatable meshes.
  111707. * Doesn't work with multi-materials
  111708. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111709. */
  111710. get mustDepthSortFacets(): boolean;
  111711. set mustDepthSortFacets(sort: boolean);
  111712. /**
  111713. * The location (Vector3) where the facet depth sort must be computed from.
  111714. * By default, the active camera position.
  111715. * Used only when facet depth sort is enabled
  111716. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111717. */
  111718. get facetDepthSortFrom(): Vector3;
  111719. set facetDepthSortFrom(location: Vector3);
  111720. /**
  111721. * gets a boolean indicating if facetData is enabled
  111722. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111723. */
  111724. get isFacetDataEnabled(): boolean;
  111725. /** @hidden */
  111726. _updateNonUniformScalingState(value: boolean): boolean;
  111727. /**
  111728. * An event triggered when this mesh collides with another one
  111729. */
  111730. onCollideObservable: Observable<AbstractMesh>;
  111731. /** Set a function to call when this mesh collides with another one */
  111732. set onCollide(callback: () => void);
  111733. /**
  111734. * An event triggered when the collision's position changes
  111735. */
  111736. onCollisionPositionChangeObservable: Observable<Vector3>;
  111737. /** Set a function to call when the collision's position changes */
  111738. set onCollisionPositionChange(callback: () => void);
  111739. /**
  111740. * An event triggered when material is changed
  111741. */
  111742. onMaterialChangedObservable: Observable<AbstractMesh>;
  111743. /**
  111744. * Gets or sets the orientation for POV movement & rotation
  111745. */
  111746. definedFacingForward: boolean;
  111747. /** @hidden */
  111748. _occlusionQuery: Nullable<WebGLQuery>;
  111749. /** @hidden */
  111750. _renderingGroup: Nullable<RenderingGroup>;
  111751. /**
  111752. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111753. */
  111754. get visibility(): number;
  111755. /**
  111756. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111757. */
  111758. set visibility(value: number);
  111759. /** Gets or sets the alpha index used to sort transparent meshes
  111760. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  111761. */
  111762. alphaIndex: number;
  111763. /**
  111764. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  111765. */
  111766. isVisible: boolean;
  111767. /**
  111768. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  111769. */
  111770. isPickable: boolean;
  111771. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  111772. showSubMeshesBoundingBox: boolean;
  111773. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  111774. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  111775. */
  111776. isBlocker: boolean;
  111777. /**
  111778. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  111779. */
  111780. enablePointerMoveEvents: boolean;
  111781. private _renderingGroupId;
  111782. /**
  111783. * Specifies the rendering group id for this mesh (0 by default)
  111784. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  111785. */
  111786. get renderingGroupId(): number;
  111787. set renderingGroupId(value: number);
  111788. private _material;
  111789. /** Gets or sets current material */
  111790. get material(): Nullable<Material>;
  111791. set material(value: Nullable<Material>);
  111792. /**
  111793. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  111794. * @see https://doc.babylonjs.com/babylon101/shadows
  111795. */
  111796. get receiveShadows(): boolean;
  111797. set receiveShadows(value: boolean);
  111798. /** Defines color to use when rendering outline */
  111799. outlineColor: Color3;
  111800. /** Define width to use when rendering outline */
  111801. outlineWidth: number;
  111802. /** Defines color to use when rendering overlay */
  111803. overlayColor: Color3;
  111804. /** Defines alpha to use when rendering overlay */
  111805. overlayAlpha: number;
  111806. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  111807. get hasVertexAlpha(): boolean;
  111808. set hasVertexAlpha(value: boolean);
  111809. /** 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) */
  111810. get useVertexColors(): boolean;
  111811. set useVertexColors(value: boolean);
  111812. /**
  111813. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  111814. */
  111815. get computeBonesUsingShaders(): boolean;
  111816. set computeBonesUsingShaders(value: boolean);
  111817. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  111818. get numBoneInfluencers(): number;
  111819. set numBoneInfluencers(value: number);
  111820. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  111821. get applyFog(): boolean;
  111822. set applyFog(value: boolean);
  111823. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  111824. useOctreeForRenderingSelection: boolean;
  111825. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  111826. useOctreeForPicking: boolean;
  111827. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  111828. useOctreeForCollisions: boolean;
  111829. /**
  111830. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  111831. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  111832. */
  111833. get layerMask(): number;
  111834. set layerMask(value: number);
  111835. /**
  111836. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  111837. */
  111838. alwaysSelectAsActiveMesh: boolean;
  111839. /**
  111840. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  111841. */
  111842. doNotSyncBoundingInfo: boolean;
  111843. /**
  111844. * Gets or sets the current action manager
  111845. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  111846. */
  111847. actionManager: Nullable<AbstractActionManager>;
  111848. private _meshCollisionData;
  111849. /**
  111850. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  111851. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111852. */
  111853. ellipsoid: Vector3;
  111854. /**
  111855. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  111856. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111857. */
  111858. ellipsoidOffset: Vector3;
  111859. /**
  111860. * Gets or sets a collision mask used to mask collisions (default is -1).
  111861. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111862. */
  111863. get collisionMask(): number;
  111864. set collisionMask(mask: number);
  111865. /**
  111866. * Gets or sets the current collision group mask (-1 by default).
  111867. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111868. */
  111869. get collisionGroup(): number;
  111870. set collisionGroup(mask: number);
  111871. /**
  111872. * Gets or sets current surrounding meshes (null by default).
  111873. *
  111874. * By default collision detection is tested against every mesh in the scene.
  111875. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  111876. * meshes will be tested for the collision.
  111877. *
  111878. * Note: if set to an empty array no collision will happen when this mesh is moved.
  111879. */
  111880. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  111881. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  111882. /**
  111883. * Defines edge width used when edgesRenderer is enabled
  111884. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111885. */
  111886. edgesWidth: number;
  111887. /**
  111888. * Defines edge color used when edgesRenderer is enabled
  111889. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111890. */
  111891. edgesColor: Color4;
  111892. /** @hidden */
  111893. _edgesRenderer: Nullable<IEdgesRenderer>;
  111894. /** @hidden */
  111895. _masterMesh: Nullable<AbstractMesh>;
  111896. /** @hidden */
  111897. _boundingInfo: Nullable<BoundingInfo>;
  111898. /** @hidden */
  111899. _renderId: number;
  111900. /**
  111901. * Gets or sets the list of subMeshes
  111902. * @see https://doc.babylonjs.com/how_to/multi_materials
  111903. */
  111904. subMeshes: SubMesh[];
  111905. /** @hidden */
  111906. _intersectionsInProgress: AbstractMesh[];
  111907. /** @hidden */
  111908. _unIndexed: boolean;
  111909. /** @hidden */
  111910. _lightSources: Light[];
  111911. /** Gets the list of lights affecting that mesh */
  111912. get lightSources(): Light[];
  111913. /** @hidden */
  111914. get _positions(): Nullable<Vector3[]>;
  111915. /** @hidden */
  111916. _waitingData: {
  111917. lods: Nullable<any>;
  111918. actions: Nullable<any>;
  111919. freezeWorldMatrix: Nullable<boolean>;
  111920. };
  111921. /** @hidden */
  111922. _bonesTransformMatrices: Nullable<Float32Array>;
  111923. /** @hidden */
  111924. _transformMatrixTexture: Nullable<RawTexture>;
  111925. /**
  111926. * Gets or sets a skeleton to apply skining transformations
  111927. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  111928. */
  111929. set skeleton(value: Nullable<Skeleton>);
  111930. get skeleton(): Nullable<Skeleton>;
  111931. /**
  111932. * An event triggered when the mesh is rebuilt.
  111933. */
  111934. onRebuildObservable: Observable<AbstractMesh>;
  111935. /**
  111936. * Creates a new AbstractMesh
  111937. * @param name defines the name of the mesh
  111938. * @param scene defines the hosting scene
  111939. */
  111940. constructor(name: string, scene?: Nullable<Scene>);
  111941. /**
  111942. * Returns the string "AbstractMesh"
  111943. * @returns "AbstractMesh"
  111944. */
  111945. getClassName(): string;
  111946. /**
  111947. * Gets a string representation of the current mesh
  111948. * @param fullDetails defines a boolean indicating if full details must be included
  111949. * @returns a string representation of the current mesh
  111950. */
  111951. toString(fullDetails?: boolean): string;
  111952. /**
  111953. * @hidden
  111954. */
  111955. protected _getEffectiveParent(): Nullable<Node>;
  111956. /** @hidden */
  111957. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  111958. /** @hidden */
  111959. _rebuild(): void;
  111960. /** @hidden */
  111961. _resyncLightSources(): void;
  111962. /** @hidden */
  111963. _resyncLightSource(light: Light): void;
  111964. /** @hidden */
  111965. _unBindEffect(): void;
  111966. /** @hidden */
  111967. _removeLightSource(light: Light, dispose: boolean): void;
  111968. private _markSubMeshesAsDirty;
  111969. /** @hidden */
  111970. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  111971. /** @hidden */
  111972. _markSubMeshesAsAttributesDirty(): void;
  111973. /** @hidden */
  111974. _markSubMeshesAsMiscDirty(): void;
  111975. /**
  111976. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  111977. */
  111978. get scaling(): Vector3;
  111979. set scaling(newScaling: Vector3);
  111980. /**
  111981. * Returns true if the mesh is blocked. Implemented by child classes
  111982. */
  111983. get isBlocked(): boolean;
  111984. /**
  111985. * Returns the mesh itself by default. Implemented by child classes
  111986. * @param camera defines the camera to use to pick the right LOD level
  111987. * @returns the currentAbstractMesh
  111988. */
  111989. getLOD(camera: Camera): Nullable<AbstractMesh>;
  111990. /**
  111991. * Returns 0 by default. Implemented by child classes
  111992. * @returns an integer
  111993. */
  111994. getTotalVertices(): number;
  111995. /**
  111996. * Returns a positive integer : the total number of indices in this mesh geometry.
  111997. * @returns the numner of indices or zero if the mesh has no geometry.
  111998. */
  111999. getTotalIndices(): number;
  112000. /**
  112001. * Returns null by default. Implemented by child classes
  112002. * @returns null
  112003. */
  112004. getIndices(): Nullable<IndicesArray>;
  112005. /**
  112006. * Returns the array of the requested vertex data kind. Implemented by child classes
  112007. * @param kind defines the vertex data kind to use
  112008. * @returns null
  112009. */
  112010. getVerticesData(kind: string): Nullable<FloatArray>;
  112011. /**
  112012. * Sets the vertex data of the mesh geometry for the requested `kind`.
  112013. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  112014. * Note that a new underlying VertexBuffer object is created each call.
  112015. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  112016. * @param kind defines vertex data kind:
  112017. * * VertexBuffer.PositionKind
  112018. * * VertexBuffer.UVKind
  112019. * * VertexBuffer.UV2Kind
  112020. * * VertexBuffer.UV3Kind
  112021. * * VertexBuffer.UV4Kind
  112022. * * VertexBuffer.UV5Kind
  112023. * * VertexBuffer.UV6Kind
  112024. * * VertexBuffer.ColorKind
  112025. * * VertexBuffer.MatricesIndicesKind
  112026. * * VertexBuffer.MatricesIndicesExtraKind
  112027. * * VertexBuffer.MatricesWeightsKind
  112028. * * VertexBuffer.MatricesWeightsExtraKind
  112029. * @param data defines the data source
  112030. * @param updatable defines if the data must be flagged as updatable (or static)
  112031. * @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
  112032. * @returns the current mesh
  112033. */
  112034. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  112035. /**
  112036. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  112037. * If the mesh has no geometry, it is simply returned as it is.
  112038. * @param kind defines vertex data kind:
  112039. * * VertexBuffer.PositionKind
  112040. * * VertexBuffer.UVKind
  112041. * * VertexBuffer.UV2Kind
  112042. * * VertexBuffer.UV3Kind
  112043. * * VertexBuffer.UV4Kind
  112044. * * VertexBuffer.UV5Kind
  112045. * * VertexBuffer.UV6Kind
  112046. * * VertexBuffer.ColorKind
  112047. * * VertexBuffer.MatricesIndicesKind
  112048. * * VertexBuffer.MatricesIndicesExtraKind
  112049. * * VertexBuffer.MatricesWeightsKind
  112050. * * VertexBuffer.MatricesWeightsExtraKind
  112051. * @param data defines the data source
  112052. * @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
  112053. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  112054. * @returns the current mesh
  112055. */
  112056. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  112057. /**
  112058. * Sets the mesh indices,
  112059. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  112060. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  112061. * @param totalVertices Defines the total number of vertices
  112062. * @returns the current mesh
  112063. */
  112064. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  112065. /**
  112066. * Gets a boolean indicating if specific vertex data is present
  112067. * @param kind defines the vertex data kind to use
  112068. * @returns true is data kind is present
  112069. */
  112070. isVerticesDataPresent(kind: string): boolean;
  112071. /**
  112072. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  112073. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  112074. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  112075. * @returns a BoundingInfo
  112076. */
  112077. getBoundingInfo(): BoundingInfo;
  112078. /**
  112079. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  112080. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  112081. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  112082. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  112083. * @returns the current mesh
  112084. */
  112085. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  112086. /**
  112087. * Overwrite the current bounding info
  112088. * @param boundingInfo defines the new bounding info
  112089. * @returns the current mesh
  112090. */
  112091. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  112092. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  112093. get useBones(): boolean;
  112094. /** @hidden */
  112095. _preActivate(): void;
  112096. /** @hidden */
  112097. _preActivateForIntermediateRendering(renderId: number): void;
  112098. /** @hidden */
  112099. _activate(renderId: number, intermediateRendering: boolean): boolean;
  112100. /** @hidden */
  112101. _postActivate(): void;
  112102. /** @hidden */
  112103. _freeze(): void;
  112104. /** @hidden */
  112105. _unFreeze(): void;
  112106. /**
  112107. * Gets the current world matrix
  112108. * @returns a Matrix
  112109. */
  112110. getWorldMatrix(): Matrix;
  112111. /** @hidden */
  112112. _getWorldMatrixDeterminant(): number;
  112113. /**
  112114. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  112115. */
  112116. get isAnInstance(): boolean;
  112117. /**
  112118. * Gets a boolean indicating if this mesh has instances
  112119. */
  112120. get hasInstances(): boolean;
  112121. /**
  112122. * Gets a boolean indicating if this mesh has thin instances
  112123. */
  112124. get hasThinInstances(): boolean;
  112125. /**
  112126. * Perform relative position change from the point of view of behind the front of the mesh.
  112127. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112128. * Supports definition of mesh facing forward or backward
  112129. * @param amountRight defines the distance on the right axis
  112130. * @param amountUp defines the distance on the up axis
  112131. * @param amountForward defines the distance on the forward axis
  112132. * @returns the current mesh
  112133. */
  112134. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  112135. /**
  112136. * Calculate relative position change from the point of view of behind the front of the mesh.
  112137. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112138. * Supports definition of mesh facing forward or backward
  112139. * @param amountRight defines the distance on the right axis
  112140. * @param amountUp defines the distance on the up axis
  112141. * @param amountForward defines the distance on the forward axis
  112142. * @returns the new displacement vector
  112143. */
  112144. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  112145. /**
  112146. * Perform relative rotation change from the point of view of behind the front of the mesh.
  112147. * Supports definition of mesh facing forward or backward
  112148. * @param flipBack defines the flip
  112149. * @param twirlClockwise defines the twirl
  112150. * @param tiltRight defines the tilt
  112151. * @returns the current mesh
  112152. */
  112153. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  112154. /**
  112155. * Calculate 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 new rotation vector
  112161. */
  112162. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  112163. /**
  112164. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  112165. * This means the mesh underlying bounding box and sphere are recomputed.
  112166. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  112167. * @returns the current mesh
  112168. */
  112169. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  112170. /** @hidden */
  112171. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  112172. /** @hidden */
  112173. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  112174. /** @hidden */
  112175. _updateBoundingInfo(): AbstractMesh;
  112176. /** @hidden */
  112177. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  112178. /** @hidden */
  112179. protected _afterComputeWorldMatrix(): void;
  112180. /** @hidden */
  112181. get _effectiveMesh(): AbstractMesh;
  112182. /**
  112183. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  112184. * A mesh is in the frustum if its bounding box intersects the frustum
  112185. * @param frustumPlanes defines the frustum to test
  112186. * @returns true if the mesh is in the frustum planes
  112187. */
  112188. isInFrustum(frustumPlanes: Plane[]): boolean;
  112189. /**
  112190. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  112191. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  112192. * @param frustumPlanes defines the frustum to test
  112193. * @returns true if the mesh is completely in the frustum planes
  112194. */
  112195. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  112196. /**
  112197. * True if the mesh intersects another mesh or a SolidParticle object
  112198. * @param mesh defines a target mesh or SolidParticle to test
  112199. * @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)
  112200. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  112201. * @returns true if there is an intersection
  112202. */
  112203. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  112204. /**
  112205. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  112206. * @param point defines the point to test
  112207. * @returns true if there is an intersection
  112208. */
  112209. intersectsPoint(point: Vector3): boolean;
  112210. /**
  112211. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  112212. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112213. */
  112214. get checkCollisions(): boolean;
  112215. set checkCollisions(collisionEnabled: boolean);
  112216. /**
  112217. * Gets Collider object used to compute collisions (not physics)
  112218. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112219. */
  112220. get collider(): Nullable<Collider>;
  112221. /**
  112222. * Move the mesh using collision engine
  112223. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112224. * @param displacement defines the requested displacement vector
  112225. * @returns the current mesh
  112226. */
  112227. moveWithCollisions(displacement: Vector3): AbstractMesh;
  112228. private _onCollisionPositionChange;
  112229. /** @hidden */
  112230. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  112231. /** @hidden */
  112232. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  112233. /** @hidden */
  112234. _checkCollision(collider: Collider): AbstractMesh;
  112235. /** @hidden */
  112236. _generatePointsArray(): boolean;
  112237. /**
  112238. * Checks if the passed Ray intersects with the mesh
  112239. * @param ray defines the ray to use
  112240. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  112241. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  112242. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  112243. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  112244. * @returns the picking info
  112245. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  112246. */
  112247. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  112248. /**
  112249. * Clones the current mesh
  112250. * @param name defines the mesh name
  112251. * @param newParent defines the new mesh parent
  112252. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  112253. * @returns the new mesh
  112254. */
  112255. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  112256. /**
  112257. * Disposes all the submeshes of the current meshnp
  112258. * @returns the current mesh
  112259. */
  112260. releaseSubMeshes(): AbstractMesh;
  112261. /**
  112262. * Releases resources associated with this abstract mesh.
  112263. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112264. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112265. */
  112266. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112267. /**
  112268. * Adds the passed mesh as a child to the current mesh
  112269. * @param mesh defines the child mesh
  112270. * @returns the current mesh
  112271. */
  112272. addChild(mesh: AbstractMesh): AbstractMesh;
  112273. /**
  112274. * Removes the passed mesh from the current mesh children list
  112275. * @param mesh defines the child mesh
  112276. * @returns the current mesh
  112277. */
  112278. removeChild(mesh: AbstractMesh): AbstractMesh;
  112279. /** @hidden */
  112280. private _initFacetData;
  112281. /**
  112282. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  112283. * This method can be called within the render loop.
  112284. * 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
  112285. * @returns the current mesh
  112286. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112287. */
  112288. updateFacetData(): AbstractMesh;
  112289. /**
  112290. * Returns the facetLocalNormals array.
  112291. * The normals are expressed in the mesh local spac
  112292. * @returns an array of Vector3
  112293. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112294. */
  112295. getFacetLocalNormals(): Vector3[];
  112296. /**
  112297. * Returns the facetLocalPositions array.
  112298. * The facet positions are expressed in the mesh local space
  112299. * @returns an array of Vector3
  112300. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112301. */
  112302. getFacetLocalPositions(): Vector3[];
  112303. /**
  112304. * Returns the facetLocalPartioning array
  112305. * @returns an array of array of numbers
  112306. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112307. */
  112308. getFacetLocalPartitioning(): number[][];
  112309. /**
  112310. * Returns the i-th facet position in the world system.
  112311. * This method allocates a new Vector3 per call
  112312. * @param i defines the facet index
  112313. * @returns a new Vector3
  112314. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112315. */
  112316. getFacetPosition(i: number): Vector3;
  112317. /**
  112318. * Sets the reference Vector3 with the i-th facet position in the world system
  112319. * @param i defines the facet index
  112320. * @param ref defines the target vector
  112321. * @returns the current mesh
  112322. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112323. */
  112324. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  112325. /**
  112326. * Returns the i-th facet normal in the world system.
  112327. * This method allocates a new Vector3 per call
  112328. * @param i defines the facet index
  112329. * @returns a new Vector3
  112330. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112331. */
  112332. getFacetNormal(i: number): Vector3;
  112333. /**
  112334. * Sets the reference Vector3 with the i-th facet normal in the world system
  112335. * @param i defines the facet index
  112336. * @param ref defines the target vector
  112337. * @returns the current mesh
  112338. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112339. */
  112340. getFacetNormalToRef(i: number, ref: Vector3): this;
  112341. /**
  112342. * 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)
  112343. * @param x defines x coordinate
  112344. * @param y defines y coordinate
  112345. * @param z defines z coordinate
  112346. * @returns the array of facet indexes
  112347. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112348. */
  112349. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  112350. /**
  112351. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  112352. * @param projected sets as the (x,y,z) world projection on the facet
  112353. * @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
  112354. * @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
  112355. * @param x defines x coordinate
  112356. * @param y defines y coordinate
  112357. * @param z defines z coordinate
  112358. * @returns the face index if found (or null instead)
  112359. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112360. */
  112361. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112362. /**
  112363. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  112364. * @param projected sets as the (x,y,z) local projection on the facet
  112365. * @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
  112366. * @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
  112367. * @param x defines x coordinate
  112368. * @param y defines y coordinate
  112369. * @param z defines z coordinate
  112370. * @returns the face index if found (or null instead)
  112371. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112372. */
  112373. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112374. /**
  112375. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  112376. * @returns the parameters
  112377. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112378. */
  112379. getFacetDataParameters(): any;
  112380. /**
  112381. * Disables the feature FacetData and frees the related memory
  112382. * @returns the current mesh
  112383. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112384. */
  112385. disableFacetData(): AbstractMesh;
  112386. /**
  112387. * Updates the AbstractMesh indices array
  112388. * @param indices defines the data source
  112389. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  112390. * @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)
  112391. * @returns the current mesh
  112392. */
  112393. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  112394. /**
  112395. * Creates new normals data for the mesh
  112396. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  112397. * @returns the current mesh
  112398. */
  112399. createNormals(updatable: boolean): AbstractMesh;
  112400. /**
  112401. * Align the mesh with a normal
  112402. * @param normal defines the normal to use
  112403. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  112404. * @returns the current mesh
  112405. */
  112406. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  112407. /** @hidden */
  112408. _checkOcclusionQuery(): boolean;
  112409. /**
  112410. * Disables the mesh edge rendering mode
  112411. * @returns the currentAbstractMesh
  112412. */
  112413. disableEdgesRendering(): AbstractMesh;
  112414. /**
  112415. * Enables the edge rendering mode on the mesh.
  112416. * This mode makes the mesh edges visible
  112417. * @param epsilon defines the maximal distance between two angles to detect a face
  112418. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  112419. * @returns the currentAbstractMesh
  112420. * @see https://www.babylonjs-playground.com/#19O9TU#0
  112421. */
  112422. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  112423. /**
  112424. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  112425. * @returns an array of particle systems in the scene that use the mesh as an emitter
  112426. */
  112427. getConnectedParticleSystems(): IParticleSystem[];
  112428. }
  112429. }
  112430. declare module BABYLON {
  112431. /**
  112432. * Interface used to define ActionEvent
  112433. */
  112434. export interface IActionEvent {
  112435. /** The mesh or sprite that triggered the action */
  112436. source: any;
  112437. /** The X mouse cursor position at the time of the event */
  112438. pointerX: number;
  112439. /** The Y mouse cursor position at the time of the event */
  112440. pointerY: number;
  112441. /** The mesh that is currently pointed at (can be null) */
  112442. meshUnderPointer: Nullable<AbstractMesh>;
  112443. /** the original (browser) event that triggered the ActionEvent */
  112444. sourceEvent?: any;
  112445. /** additional data for the event */
  112446. additionalData?: any;
  112447. }
  112448. /**
  112449. * ActionEvent is the event being sent when an action is triggered.
  112450. */
  112451. export class ActionEvent implements IActionEvent {
  112452. /** The mesh or sprite that triggered the action */
  112453. source: any;
  112454. /** The X mouse cursor position at the time of the event */
  112455. pointerX: number;
  112456. /** The Y mouse cursor position at the time of the event */
  112457. pointerY: number;
  112458. /** The mesh that is currently pointed at (can be null) */
  112459. meshUnderPointer: Nullable<AbstractMesh>;
  112460. /** the original (browser) event that triggered the ActionEvent */
  112461. sourceEvent?: any;
  112462. /** additional data for the event */
  112463. additionalData?: any;
  112464. /**
  112465. * Creates a new ActionEvent
  112466. * @param source The mesh or sprite that triggered the action
  112467. * @param pointerX The X mouse cursor position at the time of the event
  112468. * @param pointerY The Y mouse cursor position at the time of the event
  112469. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  112470. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  112471. * @param additionalData additional data for the event
  112472. */
  112473. constructor(
  112474. /** The mesh or sprite that triggered the action */
  112475. source: any,
  112476. /** The X mouse cursor position at the time of the event */
  112477. pointerX: number,
  112478. /** The Y mouse cursor position at the time of the event */
  112479. pointerY: number,
  112480. /** The mesh that is currently pointed at (can be null) */
  112481. meshUnderPointer: Nullable<AbstractMesh>,
  112482. /** the original (browser) event that triggered the ActionEvent */
  112483. sourceEvent?: any,
  112484. /** additional data for the event */
  112485. additionalData?: any);
  112486. /**
  112487. * Helper function to auto-create an ActionEvent from a source mesh.
  112488. * @param source The source mesh that triggered the event
  112489. * @param evt The original (browser) event
  112490. * @param additionalData additional data for the event
  112491. * @returns the new ActionEvent
  112492. */
  112493. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  112494. /**
  112495. * Helper function to auto-create an ActionEvent from a source sprite
  112496. * @param source The source sprite that triggered the event
  112497. * @param scene Scene associated with the sprite
  112498. * @param evt The original (browser) event
  112499. * @param additionalData additional data for the event
  112500. * @returns the new ActionEvent
  112501. */
  112502. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  112503. /**
  112504. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  112505. * @param scene the scene where the event occurred
  112506. * @param evt The original (browser) event
  112507. * @returns the new ActionEvent
  112508. */
  112509. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  112510. /**
  112511. * Helper function to auto-create an ActionEvent from a primitive
  112512. * @param prim defines the target primitive
  112513. * @param pointerPos defines the pointer position
  112514. * @param evt The original (browser) event
  112515. * @param additionalData additional data for the event
  112516. * @returns the new ActionEvent
  112517. */
  112518. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  112519. }
  112520. }
  112521. declare module BABYLON {
  112522. /**
  112523. * Abstract class used to decouple action Manager from scene and meshes.
  112524. * Do not instantiate.
  112525. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  112526. */
  112527. export abstract class AbstractActionManager implements IDisposable {
  112528. /** Gets the list of active triggers */
  112529. static Triggers: {
  112530. [key: string]: number;
  112531. };
  112532. /** Gets the cursor to use when hovering items */
  112533. hoverCursor: string;
  112534. /** Gets the list of actions */
  112535. actions: IAction[];
  112536. /**
  112537. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  112538. */
  112539. isRecursive: boolean;
  112540. /**
  112541. * Releases all associated resources
  112542. */
  112543. abstract dispose(): void;
  112544. /**
  112545. * Does this action manager has pointer triggers
  112546. */
  112547. abstract get hasPointerTriggers(): boolean;
  112548. /**
  112549. * Does this action manager has pick triggers
  112550. */
  112551. abstract get hasPickTriggers(): boolean;
  112552. /**
  112553. * Process a specific trigger
  112554. * @param trigger defines the trigger to process
  112555. * @param evt defines the event details to be processed
  112556. */
  112557. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  112558. /**
  112559. * Does this action manager handles actions of any of the given triggers
  112560. * @param triggers defines the triggers to be tested
  112561. * @return a boolean indicating whether one (or more) of the triggers is handled
  112562. */
  112563. abstract hasSpecificTriggers(triggers: number[]): boolean;
  112564. /**
  112565. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  112566. * speed.
  112567. * @param triggerA defines the trigger to be tested
  112568. * @param triggerB defines the trigger to be tested
  112569. * @return a boolean indicating whether one (or more) of the triggers is handled
  112570. */
  112571. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  112572. /**
  112573. * Does this action manager handles actions of a given trigger
  112574. * @param trigger defines the trigger to be tested
  112575. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  112576. * @return whether the trigger is handled
  112577. */
  112578. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  112579. /**
  112580. * Serialize this manager to a JSON object
  112581. * @param name defines the property name to store this manager
  112582. * @returns a JSON representation of this manager
  112583. */
  112584. abstract serialize(name: string): any;
  112585. /**
  112586. * Registers an action to this action manager
  112587. * @param action defines the action to be registered
  112588. * @return the action amended (prepared) after registration
  112589. */
  112590. abstract registerAction(action: IAction): Nullable<IAction>;
  112591. /**
  112592. * Unregisters an action to this action manager
  112593. * @param action defines the action to be unregistered
  112594. * @return a boolean indicating whether the action has been unregistered
  112595. */
  112596. abstract unregisterAction(action: IAction): Boolean;
  112597. /**
  112598. * Does exist one action manager with at least one trigger
  112599. **/
  112600. static get HasTriggers(): boolean;
  112601. /**
  112602. * Does exist one action manager with at least one pick trigger
  112603. **/
  112604. static get HasPickTriggers(): boolean;
  112605. /**
  112606. * Does exist one action manager that handles actions of a given trigger
  112607. * @param trigger defines the trigger to be tested
  112608. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  112609. **/
  112610. static HasSpecificTrigger(trigger: number): boolean;
  112611. }
  112612. }
  112613. declare module BABYLON {
  112614. /**
  112615. * Defines how a node can be built from a string name.
  112616. */
  112617. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  112618. /**
  112619. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  112620. */
  112621. export class Node implements IBehaviorAware<Node> {
  112622. /** @hidden */
  112623. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  112624. private static _NodeConstructors;
  112625. /**
  112626. * Add a new node constructor
  112627. * @param type defines the type name of the node to construct
  112628. * @param constructorFunc defines the constructor function
  112629. */
  112630. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  112631. /**
  112632. * Returns a node constructor based on type name
  112633. * @param type defines the type name
  112634. * @param name defines the new node name
  112635. * @param scene defines the hosting scene
  112636. * @param options defines optional options to transmit to constructors
  112637. * @returns the new constructor or null
  112638. */
  112639. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  112640. /**
  112641. * Gets or sets the name of the node
  112642. */
  112643. name: string;
  112644. /**
  112645. * Gets or sets the id of the node
  112646. */
  112647. id: string;
  112648. /**
  112649. * Gets or sets the unique id of the node
  112650. */
  112651. uniqueId: number;
  112652. /**
  112653. * Gets or sets a string used to store user defined state for the node
  112654. */
  112655. state: string;
  112656. /**
  112657. * Gets or sets an object used to store user defined information for the node
  112658. */
  112659. metadata: any;
  112660. /**
  112661. * For internal use only. Please do not use.
  112662. */
  112663. reservedDataStore: any;
  112664. /**
  112665. * List of inspectable custom properties (used by the Inspector)
  112666. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  112667. */
  112668. inspectableCustomProperties: IInspectable[];
  112669. private _doNotSerialize;
  112670. /**
  112671. * Gets or sets a boolean used to define if the node must be serialized
  112672. */
  112673. get doNotSerialize(): boolean;
  112674. set doNotSerialize(value: boolean);
  112675. /** @hidden */
  112676. _isDisposed: boolean;
  112677. /**
  112678. * Gets a list of Animations associated with the node
  112679. */
  112680. animations: Animation[];
  112681. protected _ranges: {
  112682. [name: string]: Nullable<AnimationRange>;
  112683. };
  112684. /**
  112685. * Callback raised when the node is ready to be used
  112686. */
  112687. onReady: Nullable<(node: Node) => void>;
  112688. private _isEnabled;
  112689. private _isParentEnabled;
  112690. private _isReady;
  112691. /** @hidden */
  112692. _currentRenderId: number;
  112693. private _parentUpdateId;
  112694. /** @hidden */
  112695. _childUpdateId: number;
  112696. /** @hidden */
  112697. _waitingParentId: Nullable<string>;
  112698. /** @hidden */
  112699. _scene: Scene;
  112700. /** @hidden */
  112701. _cache: any;
  112702. private _parentNode;
  112703. private _children;
  112704. /** @hidden */
  112705. _worldMatrix: Matrix;
  112706. /** @hidden */
  112707. _worldMatrixDeterminant: number;
  112708. /** @hidden */
  112709. _worldMatrixDeterminantIsDirty: boolean;
  112710. /** @hidden */
  112711. private _sceneRootNodesIndex;
  112712. /**
  112713. * Gets a boolean indicating if the node has been disposed
  112714. * @returns true if the node was disposed
  112715. */
  112716. isDisposed(): boolean;
  112717. /**
  112718. * Gets or sets the parent of the node (without keeping the current position in the scene)
  112719. * @see https://doc.babylonjs.com/how_to/parenting
  112720. */
  112721. set parent(parent: Nullable<Node>);
  112722. get parent(): Nullable<Node>;
  112723. /** @hidden */
  112724. _addToSceneRootNodes(): void;
  112725. /** @hidden */
  112726. _removeFromSceneRootNodes(): void;
  112727. private _animationPropertiesOverride;
  112728. /**
  112729. * Gets or sets the animation properties override
  112730. */
  112731. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  112732. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  112733. /**
  112734. * Gets a string identifying the name of the class
  112735. * @returns "Node" string
  112736. */
  112737. getClassName(): string;
  112738. /** @hidden */
  112739. readonly _isNode: boolean;
  112740. /**
  112741. * An event triggered when the mesh is disposed
  112742. */
  112743. onDisposeObservable: Observable<Node>;
  112744. private _onDisposeObserver;
  112745. /**
  112746. * Sets a callback that will be raised when the node will be disposed
  112747. */
  112748. set onDispose(callback: () => void);
  112749. /**
  112750. * Creates a new Node
  112751. * @param name the name and id to be given to this node
  112752. * @param scene the scene this node will be added to
  112753. */
  112754. constructor(name: string, scene?: Nullable<Scene>);
  112755. /**
  112756. * Gets the scene of the node
  112757. * @returns a scene
  112758. */
  112759. getScene(): Scene;
  112760. /**
  112761. * Gets the engine of the node
  112762. * @returns a Engine
  112763. */
  112764. getEngine(): Engine;
  112765. private _behaviors;
  112766. /**
  112767. * Attach a behavior to the node
  112768. * @see https://doc.babylonjs.com/features/behaviour
  112769. * @param behavior defines the behavior to attach
  112770. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  112771. * @returns the current Node
  112772. */
  112773. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  112774. /**
  112775. * Remove an attached behavior
  112776. * @see https://doc.babylonjs.com/features/behaviour
  112777. * @param behavior defines the behavior to attach
  112778. * @returns the current Node
  112779. */
  112780. removeBehavior(behavior: Behavior<Node>): Node;
  112781. /**
  112782. * Gets the list of attached behaviors
  112783. * @see https://doc.babylonjs.com/features/behaviour
  112784. */
  112785. get behaviors(): Behavior<Node>[];
  112786. /**
  112787. * Gets an attached behavior by name
  112788. * @param name defines the name of the behavior to look for
  112789. * @see https://doc.babylonjs.com/features/behaviour
  112790. * @returns null if behavior was not found else the requested behavior
  112791. */
  112792. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  112793. /**
  112794. * Returns the latest update of the World matrix
  112795. * @returns a Matrix
  112796. */
  112797. getWorldMatrix(): Matrix;
  112798. /** @hidden */
  112799. _getWorldMatrixDeterminant(): number;
  112800. /**
  112801. * Returns directly the latest state of the mesh World matrix.
  112802. * A Matrix is returned.
  112803. */
  112804. get worldMatrixFromCache(): Matrix;
  112805. /** @hidden */
  112806. _initCache(): void;
  112807. /** @hidden */
  112808. updateCache(force?: boolean): void;
  112809. /** @hidden */
  112810. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  112811. /** @hidden */
  112812. _updateCache(ignoreParentClass?: boolean): void;
  112813. /** @hidden */
  112814. _isSynchronized(): boolean;
  112815. /** @hidden */
  112816. _markSyncedWithParent(): void;
  112817. /** @hidden */
  112818. isSynchronizedWithParent(): boolean;
  112819. /** @hidden */
  112820. isSynchronized(): boolean;
  112821. /**
  112822. * Is this node ready to be used/rendered
  112823. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  112824. * @return true if the node is ready
  112825. */
  112826. isReady(completeCheck?: boolean): boolean;
  112827. /**
  112828. * Is this node enabled?
  112829. * 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
  112830. * @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
  112831. * @return whether this node (and its parent) is enabled
  112832. */
  112833. isEnabled(checkAncestors?: boolean): boolean;
  112834. /** @hidden */
  112835. protected _syncParentEnabledState(): void;
  112836. /**
  112837. * Set the enabled state of this node
  112838. * @param value defines the new enabled state
  112839. */
  112840. setEnabled(value: boolean): void;
  112841. /**
  112842. * Is this node a descendant of the given node?
  112843. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  112844. * @param ancestor defines the parent node to inspect
  112845. * @returns a boolean indicating if this node is a descendant of the given node
  112846. */
  112847. isDescendantOf(ancestor: Node): boolean;
  112848. /** @hidden */
  112849. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  112850. /**
  112851. * Will return all nodes that have this node as ascendant
  112852. * @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
  112853. * @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
  112854. * @return all children nodes of all types
  112855. */
  112856. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  112857. /**
  112858. * Get all child-meshes of this node
  112859. * @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)
  112860. * @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
  112861. * @returns an array of AbstractMesh
  112862. */
  112863. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  112864. /**
  112865. * Get all direct children of this node
  112866. * @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
  112867. * @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)
  112868. * @returns an array of Node
  112869. */
  112870. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  112871. /** @hidden */
  112872. _setReady(state: boolean): void;
  112873. /**
  112874. * Get an animation by name
  112875. * @param name defines the name of the animation to look for
  112876. * @returns null if not found else the requested animation
  112877. */
  112878. getAnimationByName(name: string): Nullable<Animation>;
  112879. /**
  112880. * Creates an animation range for this node
  112881. * @param name defines the name of the range
  112882. * @param from defines the starting key
  112883. * @param to defines the end key
  112884. */
  112885. createAnimationRange(name: string, from: number, to: number): void;
  112886. /**
  112887. * Delete a specific animation range
  112888. * @param name defines the name of the range to delete
  112889. * @param deleteFrames defines if animation frames from the range must be deleted as well
  112890. */
  112891. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  112892. /**
  112893. * Get an animation range by name
  112894. * @param name defines the name of the animation range to look for
  112895. * @returns null if not found else the requested animation range
  112896. */
  112897. getAnimationRange(name: string): Nullable<AnimationRange>;
  112898. /**
  112899. * Gets the list of all animation ranges defined on this node
  112900. * @returns an array
  112901. */
  112902. getAnimationRanges(): Nullable<AnimationRange>[];
  112903. /**
  112904. * Will start the animation sequence
  112905. * @param name defines the range frames for animation sequence
  112906. * @param loop defines if the animation should loop (false by default)
  112907. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  112908. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  112909. * @returns the object created for this animation. If range does not exist, it will return null
  112910. */
  112911. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  112912. /**
  112913. * Serialize animation ranges into a JSON compatible object
  112914. * @returns serialization object
  112915. */
  112916. serializeAnimationRanges(): any;
  112917. /**
  112918. * Computes the world matrix of the node
  112919. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  112920. * @returns the world matrix
  112921. */
  112922. computeWorldMatrix(force?: boolean): Matrix;
  112923. /**
  112924. * Releases resources associated with this node.
  112925. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112926. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112927. */
  112928. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112929. /**
  112930. * Parse animation range data from a serialization object and store them into a given node
  112931. * @param node defines where to store the animation ranges
  112932. * @param parsedNode defines the serialization object to read data from
  112933. * @param scene defines the hosting scene
  112934. */
  112935. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  112936. /**
  112937. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  112938. * @param includeDescendants Include bounding info from descendants as well (true by default)
  112939. * @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
  112940. * @returns the new bounding vectors
  112941. */
  112942. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  112943. min: Vector3;
  112944. max: Vector3;
  112945. };
  112946. }
  112947. }
  112948. declare module BABYLON {
  112949. /**
  112950. * @hidden
  112951. */
  112952. export class _IAnimationState {
  112953. key: number;
  112954. repeatCount: number;
  112955. workValue?: any;
  112956. loopMode?: number;
  112957. offsetValue?: any;
  112958. highLimitValue?: any;
  112959. }
  112960. /**
  112961. * Class used to store any kind of animation
  112962. */
  112963. export class Animation {
  112964. /**Name of the animation */
  112965. name: string;
  112966. /**Property to animate */
  112967. targetProperty: string;
  112968. /**The frames per second of the animation */
  112969. framePerSecond: number;
  112970. /**The data type of the animation */
  112971. dataType: number;
  112972. /**The loop mode of the animation */
  112973. loopMode?: number | undefined;
  112974. /**Specifies if blending should be enabled */
  112975. enableBlending?: boolean | undefined;
  112976. /**
  112977. * Use matrix interpolation instead of using direct key value when animating matrices
  112978. */
  112979. static AllowMatricesInterpolation: boolean;
  112980. /**
  112981. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  112982. */
  112983. static AllowMatrixDecomposeForInterpolation: boolean;
  112984. /** Define the Url to load snippets */
  112985. static SnippetUrl: string;
  112986. /** Snippet ID if the animation was created from the snippet server */
  112987. snippetId: string;
  112988. /**
  112989. * Stores the key frames of the animation
  112990. */
  112991. private _keys;
  112992. /**
  112993. * Stores the easing function of the animation
  112994. */
  112995. private _easingFunction;
  112996. /**
  112997. * @hidden Internal use only
  112998. */
  112999. _runtimeAnimations: RuntimeAnimation[];
  113000. /**
  113001. * The set of event that will be linked to this animation
  113002. */
  113003. private _events;
  113004. /**
  113005. * Stores an array of target property paths
  113006. */
  113007. targetPropertyPath: string[];
  113008. /**
  113009. * Stores the blending speed of the animation
  113010. */
  113011. blendingSpeed: number;
  113012. /**
  113013. * Stores the animation ranges for the animation
  113014. */
  113015. private _ranges;
  113016. /**
  113017. * @hidden Internal use
  113018. */
  113019. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  113020. /**
  113021. * Sets up an animation
  113022. * @param property The property to animate
  113023. * @param animationType The animation type to apply
  113024. * @param framePerSecond The frames per second of the animation
  113025. * @param easingFunction The easing function used in the animation
  113026. * @returns The created animation
  113027. */
  113028. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  113029. /**
  113030. * Create and start an animation on a node
  113031. * @param name defines the name of the global animation that will be run on all nodes
  113032. * @param node defines the root node where the animation will take place
  113033. * @param targetProperty defines property to animate
  113034. * @param framePerSecond defines the number of frame per second yo use
  113035. * @param totalFrame defines the number of frames in total
  113036. * @param from defines the initial value
  113037. * @param to defines the final value
  113038. * @param loopMode defines which loop mode you want to use (off by default)
  113039. * @param easingFunction defines the easing function to use (linear by default)
  113040. * @param onAnimationEnd defines the callback to call when animation end
  113041. * @returns the animatable created for this animation
  113042. */
  113043. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113044. /**
  113045. * Create and start an animation on a node and its descendants
  113046. * @param name defines the name of the global animation that will be run on all nodes
  113047. * @param node defines the root node where the animation will take place
  113048. * @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
  113049. * @param targetProperty defines property to animate
  113050. * @param framePerSecond defines the number of frame per second to use
  113051. * @param totalFrame defines the number of frames in total
  113052. * @param from defines the initial value
  113053. * @param to defines the final value
  113054. * @param loopMode defines which loop mode you want to use (off by default)
  113055. * @param easingFunction defines the easing function to use (linear by default)
  113056. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  113057. * @returns the list of animatables created for all nodes
  113058. * @example https://www.babylonjs-playground.com/#MH0VLI
  113059. */
  113060. 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[]>;
  113061. /**
  113062. * Creates a new animation, merges it with the existing animations and starts it
  113063. * @param name Name of the animation
  113064. * @param node Node which contains the scene that begins the animations
  113065. * @param targetProperty Specifies which property to animate
  113066. * @param framePerSecond The frames per second of the animation
  113067. * @param totalFrame The total number of frames
  113068. * @param from The frame at the beginning of the animation
  113069. * @param to The frame at the end of the animation
  113070. * @param loopMode Specifies the loop mode of the animation
  113071. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  113072. * @param onAnimationEnd Callback to run once the animation is complete
  113073. * @returns Nullable animation
  113074. */
  113075. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113076. /**
  113077. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  113078. * @param sourceAnimation defines the Animation containing keyframes to convert
  113079. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  113080. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  113081. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  113082. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  113083. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  113084. */
  113085. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  113086. /**
  113087. * Transition property of an host to the target Value
  113088. * @param property The property to transition
  113089. * @param targetValue The target Value of the property
  113090. * @param host The object where the property to animate belongs
  113091. * @param scene Scene used to run the animation
  113092. * @param frameRate Framerate (in frame/s) to use
  113093. * @param transition The transition type we want to use
  113094. * @param duration The duration of the animation, in milliseconds
  113095. * @param onAnimationEnd Callback trigger at the end of the animation
  113096. * @returns Nullable animation
  113097. */
  113098. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  113099. /**
  113100. * Return the array of runtime animations currently using this animation
  113101. */
  113102. get runtimeAnimations(): RuntimeAnimation[];
  113103. /**
  113104. * Specifies if any of the runtime animations are currently running
  113105. */
  113106. get hasRunningRuntimeAnimations(): boolean;
  113107. /**
  113108. * Initializes the animation
  113109. * @param name Name of the animation
  113110. * @param targetProperty Property to animate
  113111. * @param framePerSecond The frames per second of the animation
  113112. * @param dataType The data type of the animation
  113113. * @param loopMode The loop mode of the animation
  113114. * @param enableBlending Specifies if blending should be enabled
  113115. */
  113116. constructor(
  113117. /**Name of the animation */
  113118. name: string,
  113119. /**Property to animate */
  113120. targetProperty: string,
  113121. /**The frames per second of the animation */
  113122. framePerSecond: number,
  113123. /**The data type of the animation */
  113124. dataType: number,
  113125. /**The loop mode of the animation */
  113126. loopMode?: number | undefined,
  113127. /**Specifies if blending should be enabled */
  113128. enableBlending?: boolean | undefined);
  113129. /**
  113130. * Converts the animation to a string
  113131. * @param fullDetails support for multiple levels of logging within scene loading
  113132. * @returns String form of the animation
  113133. */
  113134. toString(fullDetails?: boolean): string;
  113135. /**
  113136. * Add an event to this animation
  113137. * @param event Event to add
  113138. */
  113139. addEvent(event: AnimationEvent): void;
  113140. /**
  113141. * Remove all events found at the given frame
  113142. * @param frame The frame to remove events from
  113143. */
  113144. removeEvents(frame: number): void;
  113145. /**
  113146. * Retrieves all the events from the animation
  113147. * @returns Events from the animation
  113148. */
  113149. getEvents(): AnimationEvent[];
  113150. /**
  113151. * Creates an animation range
  113152. * @param name Name of the animation range
  113153. * @param from Starting frame of the animation range
  113154. * @param to Ending frame of the animation
  113155. */
  113156. createRange(name: string, from: number, to: number): void;
  113157. /**
  113158. * Deletes an animation range by name
  113159. * @param name Name of the animation range to delete
  113160. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  113161. */
  113162. deleteRange(name: string, deleteFrames?: boolean): void;
  113163. /**
  113164. * Gets the animation range by name, or null if not defined
  113165. * @param name Name of the animation range
  113166. * @returns Nullable animation range
  113167. */
  113168. getRange(name: string): Nullable<AnimationRange>;
  113169. /**
  113170. * Gets the key frames from the animation
  113171. * @returns The key frames of the animation
  113172. */
  113173. getKeys(): Array<IAnimationKey>;
  113174. /**
  113175. * Gets the highest frame rate of the animation
  113176. * @returns Highest frame rate of the animation
  113177. */
  113178. getHighestFrame(): number;
  113179. /**
  113180. * Gets the easing function of the animation
  113181. * @returns Easing function of the animation
  113182. */
  113183. getEasingFunction(): IEasingFunction;
  113184. /**
  113185. * Sets the easing function of the animation
  113186. * @param easingFunction A custom mathematical formula for animation
  113187. */
  113188. setEasingFunction(easingFunction: EasingFunction): void;
  113189. /**
  113190. * Interpolates a scalar linearly
  113191. * @param startValue Start value of the animation curve
  113192. * @param endValue End value of the animation curve
  113193. * @param gradient Scalar amount to interpolate
  113194. * @returns Interpolated scalar value
  113195. */
  113196. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  113197. /**
  113198. * Interpolates a scalar cubically
  113199. * @param startValue Start value of the animation curve
  113200. * @param outTangent End tangent of the animation
  113201. * @param endValue End value of the animation curve
  113202. * @param inTangent Start tangent of the animation curve
  113203. * @param gradient Scalar amount to interpolate
  113204. * @returns Interpolated scalar value
  113205. */
  113206. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  113207. /**
  113208. * Interpolates a quaternion using a spherical linear interpolation
  113209. * @param startValue Start value of the animation curve
  113210. * @param endValue End value of the animation curve
  113211. * @param gradient Scalar amount to interpolate
  113212. * @returns Interpolated quaternion value
  113213. */
  113214. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  113215. /**
  113216. * Interpolates a quaternion cubically
  113217. * @param startValue Start value of the animation curve
  113218. * @param outTangent End tangent of the animation curve
  113219. * @param endValue End value of the animation curve
  113220. * @param inTangent Start tangent of the animation curve
  113221. * @param gradient Scalar amount to interpolate
  113222. * @returns Interpolated quaternion value
  113223. */
  113224. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  113225. /**
  113226. * Interpolates a Vector3 linearl
  113227. * @param startValue Start value of the animation curve
  113228. * @param endValue End value of the animation curve
  113229. * @param gradient Scalar amount to interpolate
  113230. * @returns Interpolated scalar value
  113231. */
  113232. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  113233. /**
  113234. * Interpolates a Vector3 cubically
  113235. * @param startValue Start value of the animation curve
  113236. * @param outTangent End tangent of the animation
  113237. * @param endValue End value of the animation curve
  113238. * @param inTangent Start tangent of the animation curve
  113239. * @param gradient Scalar amount to interpolate
  113240. * @returns InterpolatedVector3 value
  113241. */
  113242. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  113243. /**
  113244. * Interpolates a Vector2 linearly
  113245. * @param startValue Start value of the animation curve
  113246. * @param endValue End value of the animation curve
  113247. * @param gradient Scalar amount to interpolate
  113248. * @returns Interpolated Vector2 value
  113249. */
  113250. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  113251. /**
  113252. * Interpolates a Vector2 cubically
  113253. * @param startValue Start value of the animation curve
  113254. * @param outTangent End tangent of the animation
  113255. * @param endValue End value of the animation curve
  113256. * @param inTangent Start tangent of the animation curve
  113257. * @param gradient Scalar amount to interpolate
  113258. * @returns Interpolated Vector2 value
  113259. */
  113260. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  113261. /**
  113262. * Interpolates a size linearly
  113263. * @param startValue Start value of the animation curve
  113264. * @param endValue End value of the animation curve
  113265. * @param gradient Scalar amount to interpolate
  113266. * @returns Interpolated Size value
  113267. */
  113268. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  113269. /**
  113270. * Interpolates a Color3 linearly
  113271. * @param startValue Start value of the animation curve
  113272. * @param endValue End value of the animation curve
  113273. * @param gradient Scalar amount to interpolate
  113274. * @returns Interpolated Color3 value
  113275. */
  113276. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  113277. /**
  113278. * Interpolates a Color4 linearly
  113279. * @param startValue Start value of the animation curve
  113280. * @param endValue End value of the animation curve
  113281. * @param gradient Scalar amount to interpolate
  113282. * @returns Interpolated Color3 value
  113283. */
  113284. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  113285. /**
  113286. * @hidden Internal use only
  113287. */
  113288. _getKeyValue(value: any): any;
  113289. /**
  113290. * @hidden Internal use only
  113291. */
  113292. _interpolate(currentFrame: number, state: _IAnimationState): any;
  113293. /**
  113294. * Defines the function to use to interpolate matrices
  113295. * @param startValue defines the start matrix
  113296. * @param endValue defines the end matrix
  113297. * @param gradient defines the gradient between both matrices
  113298. * @param result defines an optional target matrix where to store the interpolation
  113299. * @returns the interpolated matrix
  113300. */
  113301. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  113302. /**
  113303. * Makes a copy of the animation
  113304. * @returns Cloned animation
  113305. */
  113306. clone(): Animation;
  113307. /**
  113308. * Sets the key frames of the animation
  113309. * @param values The animation key frames to set
  113310. */
  113311. setKeys(values: Array<IAnimationKey>): void;
  113312. /**
  113313. * Serializes the animation to an object
  113314. * @returns Serialized object
  113315. */
  113316. serialize(): any;
  113317. /**
  113318. * Float animation type
  113319. */
  113320. static readonly ANIMATIONTYPE_FLOAT: number;
  113321. /**
  113322. * Vector3 animation type
  113323. */
  113324. static readonly ANIMATIONTYPE_VECTOR3: number;
  113325. /**
  113326. * Quaternion animation type
  113327. */
  113328. static readonly ANIMATIONTYPE_QUATERNION: number;
  113329. /**
  113330. * Matrix animation type
  113331. */
  113332. static readonly ANIMATIONTYPE_MATRIX: number;
  113333. /**
  113334. * Color3 animation type
  113335. */
  113336. static readonly ANIMATIONTYPE_COLOR3: number;
  113337. /**
  113338. * Color3 animation type
  113339. */
  113340. static readonly ANIMATIONTYPE_COLOR4: number;
  113341. /**
  113342. * Vector2 animation type
  113343. */
  113344. static readonly ANIMATIONTYPE_VECTOR2: number;
  113345. /**
  113346. * Size animation type
  113347. */
  113348. static readonly ANIMATIONTYPE_SIZE: number;
  113349. /**
  113350. * Relative Loop Mode
  113351. */
  113352. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  113353. /**
  113354. * Cycle Loop Mode
  113355. */
  113356. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  113357. /**
  113358. * Constant Loop Mode
  113359. */
  113360. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  113361. /** @hidden */
  113362. static _UniversalLerp(left: any, right: any, amount: number): any;
  113363. /**
  113364. * Parses an animation object and creates an animation
  113365. * @param parsedAnimation Parsed animation object
  113366. * @returns Animation object
  113367. */
  113368. static Parse(parsedAnimation: any): Animation;
  113369. /**
  113370. * Appends the serialized animations from the source animations
  113371. * @param source Source containing the animations
  113372. * @param destination Target to store the animations
  113373. */
  113374. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113375. /**
  113376. * Creates a new animation or an array of animations from a snippet saved in a remote file
  113377. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  113378. * @param url defines the url to load from
  113379. * @returns a promise that will resolve to the new animation or an array of animations
  113380. */
  113381. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  113382. /**
  113383. * Creates an animation or an array of animations from a snippet saved by the Inspector
  113384. * @param snippetId defines the snippet to load
  113385. * @returns a promise that will resolve to the new animation or a new array of animations
  113386. */
  113387. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  113388. }
  113389. }
  113390. declare module BABYLON {
  113391. /**
  113392. * Interface containing an array of animations
  113393. */
  113394. export interface IAnimatable {
  113395. /**
  113396. * Array of animations
  113397. */
  113398. animations: Nullable<Array<Animation>>;
  113399. }
  113400. }
  113401. declare module BABYLON {
  113402. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  113403. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113404. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113405. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113406. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113407. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113408. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113409. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113410. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113411. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113412. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113413. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113414. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113415. /**
  113416. * Decorator used to define property that can be serialized as reference to a camera
  113417. * @param sourceName defines the name of the property to decorate
  113418. */
  113419. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113420. /**
  113421. * Class used to help serialization objects
  113422. */
  113423. export class SerializationHelper {
  113424. /** @hidden */
  113425. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  113426. /** @hidden */
  113427. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  113428. /** @hidden */
  113429. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  113430. /** @hidden */
  113431. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  113432. /**
  113433. * Appends the serialized animations from the source animations
  113434. * @param source Source containing the animations
  113435. * @param destination Target to store the animations
  113436. */
  113437. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113438. /**
  113439. * Static function used to serialized a specific entity
  113440. * @param entity defines the entity to serialize
  113441. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  113442. * @returns a JSON compatible object representing the serialization of the entity
  113443. */
  113444. static Serialize<T>(entity: T, serializationObject?: any): any;
  113445. /**
  113446. * Creates a new entity from a serialization data object
  113447. * @param creationFunction defines a function used to instanciated the new entity
  113448. * @param source defines the source serialization data
  113449. * @param scene defines the hosting scene
  113450. * @param rootUrl defines the root url for resources
  113451. * @returns a new entity
  113452. */
  113453. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  113454. /**
  113455. * Clones an object
  113456. * @param creationFunction defines the function used to instanciate the new object
  113457. * @param source defines the source object
  113458. * @returns the cloned object
  113459. */
  113460. static Clone<T>(creationFunction: () => T, source: T): T;
  113461. /**
  113462. * Instanciates a new object based on a source one (some data will be shared between both object)
  113463. * @param creationFunction defines the function used to instanciate the new object
  113464. * @param source defines the source object
  113465. * @returns the new object
  113466. */
  113467. static Instanciate<T>(creationFunction: () => T, source: T): T;
  113468. }
  113469. }
  113470. declare module BABYLON {
  113471. /**
  113472. * Base class of all the textures in babylon.
  113473. * It groups all the common properties the materials, post process, lights... might need
  113474. * in order to make a correct use of the texture.
  113475. */
  113476. export class BaseTexture implements IAnimatable {
  113477. /**
  113478. * Default anisotropic filtering level for the application.
  113479. * It is set to 4 as a good tradeoff between perf and quality.
  113480. */
  113481. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  113482. /**
  113483. * Gets or sets the unique id of the texture
  113484. */
  113485. uniqueId: number;
  113486. /**
  113487. * Define the name of the texture.
  113488. */
  113489. name: string;
  113490. /**
  113491. * Gets or sets an object used to store user defined information.
  113492. */
  113493. metadata: any;
  113494. /**
  113495. * For internal use only. Please do not use.
  113496. */
  113497. reservedDataStore: any;
  113498. private _hasAlpha;
  113499. /**
  113500. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  113501. */
  113502. set hasAlpha(value: boolean);
  113503. get hasAlpha(): boolean;
  113504. /**
  113505. * Defines if the alpha value should be determined via the rgb values.
  113506. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  113507. */
  113508. getAlphaFromRGB: boolean;
  113509. /**
  113510. * Intensity or strength of the texture.
  113511. * It is commonly used by materials to fine tune the intensity of the texture
  113512. */
  113513. level: number;
  113514. /**
  113515. * Define the UV chanel to use starting from 0 and defaulting to 0.
  113516. * This is part of the texture as textures usually maps to one uv set.
  113517. */
  113518. coordinatesIndex: number;
  113519. protected _coordinatesMode: number;
  113520. /**
  113521. * How a texture is mapped.
  113522. *
  113523. * | Value | Type | Description |
  113524. * | ----- | ----------------------------------- | ----------- |
  113525. * | 0 | EXPLICIT_MODE | |
  113526. * | 1 | SPHERICAL_MODE | |
  113527. * | 2 | PLANAR_MODE | |
  113528. * | 3 | CUBIC_MODE | |
  113529. * | 4 | PROJECTION_MODE | |
  113530. * | 5 | SKYBOX_MODE | |
  113531. * | 6 | INVCUBIC_MODE | |
  113532. * | 7 | EQUIRECTANGULAR_MODE | |
  113533. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  113534. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  113535. */
  113536. set coordinatesMode(value: number);
  113537. get coordinatesMode(): number;
  113538. private _wrapU;
  113539. /**
  113540. * | Value | Type | Description |
  113541. * | ----- | ------------------ | ----------- |
  113542. * | 0 | CLAMP_ADDRESSMODE | |
  113543. * | 1 | WRAP_ADDRESSMODE | |
  113544. * | 2 | MIRROR_ADDRESSMODE | |
  113545. */
  113546. get wrapU(): number;
  113547. set wrapU(value: number);
  113548. private _wrapV;
  113549. /**
  113550. * | Value | Type | Description |
  113551. * | ----- | ------------------ | ----------- |
  113552. * | 0 | CLAMP_ADDRESSMODE | |
  113553. * | 1 | WRAP_ADDRESSMODE | |
  113554. * | 2 | MIRROR_ADDRESSMODE | |
  113555. */
  113556. get wrapV(): number;
  113557. set wrapV(value: number);
  113558. /**
  113559. * | Value | Type | Description |
  113560. * | ----- | ------------------ | ----------- |
  113561. * | 0 | CLAMP_ADDRESSMODE | |
  113562. * | 1 | WRAP_ADDRESSMODE | |
  113563. * | 2 | MIRROR_ADDRESSMODE | |
  113564. */
  113565. wrapR: number;
  113566. /**
  113567. * With compliant hardware and browser (supporting anisotropic filtering)
  113568. * this defines the level of anisotropic filtering in the texture.
  113569. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  113570. */
  113571. anisotropicFilteringLevel: number;
  113572. /**
  113573. * Define if the texture is a cube texture or if false a 2d texture.
  113574. */
  113575. get isCube(): boolean;
  113576. set isCube(value: boolean);
  113577. /**
  113578. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  113579. */
  113580. get is3D(): boolean;
  113581. set is3D(value: boolean);
  113582. /**
  113583. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  113584. */
  113585. get is2DArray(): boolean;
  113586. set is2DArray(value: boolean);
  113587. /**
  113588. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  113589. * HDR texture are usually stored in linear space.
  113590. * This only impacts the PBR and Background materials
  113591. */
  113592. gammaSpace: boolean;
  113593. /**
  113594. * Gets or sets whether or not the texture contains RGBD data.
  113595. */
  113596. get isRGBD(): boolean;
  113597. set isRGBD(value: boolean);
  113598. /**
  113599. * Is Z inverted in the texture (useful in a cube texture).
  113600. */
  113601. invertZ: boolean;
  113602. /**
  113603. * Are mip maps generated for this texture or not.
  113604. */
  113605. get noMipmap(): boolean;
  113606. /**
  113607. * @hidden
  113608. */
  113609. lodLevelInAlpha: boolean;
  113610. /**
  113611. * With prefiltered texture, defined the offset used during the prefiltering steps.
  113612. */
  113613. get lodGenerationOffset(): number;
  113614. set lodGenerationOffset(value: number);
  113615. /**
  113616. * With prefiltered texture, defined the scale used during the prefiltering steps.
  113617. */
  113618. get lodGenerationScale(): number;
  113619. set lodGenerationScale(value: number);
  113620. /**
  113621. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  113622. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  113623. * average roughness values.
  113624. */
  113625. get linearSpecularLOD(): boolean;
  113626. set linearSpecularLOD(value: boolean);
  113627. /**
  113628. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  113629. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  113630. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  113631. */
  113632. get irradianceTexture(): Nullable<BaseTexture>;
  113633. set irradianceTexture(value: Nullable<BaseTexture>);
  113634. /**
  113635. * Define if the texture is a render target.
  113636. */
  113637. isRenderTarget: boolean;
  113638. /**
  113639. * Define the unique id of the texture in the scene.
  113640. */
  113641. get uid(): string;
  113642. /** @hidden */
  113643. _prefiltered: boolean;
  113644. /**
  113645. * Return a string representation of the texture.
  113646. * @returns the texture as a string
  113647. */
  113648. toString(): string;
  113649. /**
  113650. * Get the class name of the texture.
  113651. * @returns "BaseTexture"
  113652. */
  113653. getClassName(): string;
  113654. /**
  113655. * Define the list of animation attached to the texture.
  113656. */
  113657. animations: Animation[];
  113658. /**
  113659. * An event triggered when the texture is disposed.
  113660. */
  113661. onDisposeObservable: Observable<BaseTexture>;
  113662. private _onDisposeObserver;
  113663. /**
  113664. * Callback triggered when the texture has been disposed.
  113665. * Kept for back compatibility, you can use the onDisposeObservable instead.
  113666. */
  113667. set onDispose(callback: () => void);
  113668. /**
  113669. * Define the current state of the loading sequence when in delayed load mode.
  113670. */
  113671. delayLoadState: number;
  113672. protected _scene: Nullable<Scene>;
  113673. protected _engine: Nullable<ThinEngine>;
  113674. /** @hidden */
  113675. _texture: Nullable<InternalTexture>;
  113676. private _uid;
  113677. /**
  113678. * Define if the texture is preventinga material to render or not.
  113679. * If not and the texture is not ready, the engine will use a default black texture instead.
  113680. */
  113681. get isBlocking(): boolean;
  113682. /**
  113683. * Instantiates a new BaseTexture.
  113684. * Base class of all the textures in babylon.
  113685. * It groups all the common properties the materials, post process, lights... might need
  113686. * in order to make a correct use of the texture.
  113687. * @param sceneOrEngine Define the scene or engine the texture blongs to
  113688. */
  113689. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  113690. /**
  113691. * Get the scene the texture belongs to.
  113692. * @returns the scene or null if undefined
  113693. */
  113694. getScene(): Nullable<Scene>;
  113695. /** @hidden */
  113696. protected _getEngine(): Nullable<ThinEngine>;
  113697. /**
  113698. * Get the texture transform matrix used to offset tile the texture for istance.
  113699. * @returns the transformation matrix
  113700. */
  113701. getTextureMatrix(): Matrix;
  113702. /**
  113703. * Get the texture reflection matrix used to rotate/transform the reflection.
  113704. * @returns the reflection matrix
  113705. */
  113706. getReflectionTextureMatrix(): Matrix;
  113707. /**
  113708. * Get the underlying lower level texture from Babylon.
  113709. * @returns the insternal texture
  113710. */
  113711. getInternalTexture(): Nullable<InternalTexture>;
  113712. /**
  113713. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  113714. * @returns true if ready or not blocking
  113715. */
  113716. isReadyOrNotBlocking(): boolean;
  113717. /**
  113718. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  113719. * @returns true if fully ready
  113720. */
  113721. isReady(): boolean;
  113722. private _cachedSize;
  113723. /**
  113724. * Get the size of the texture.
  113725. * @returns the texture size.
  113726. */
  113727. getSize(): ISize;
  113728. /**
  113729. * Get the base size of the texture.
  113730. * It can be different from the size if the texture has been resized for POT for instance
  113731. * @returns the base size
  113732. */
  113733. getBaseSize(): ISize;
  113734. /**
  113735. * Update the sampling mode of the texture.
  113736. * Default is Trilinear mode.
  113737. *
  113738. * | Value | Type | Description |
  113739. * | ----- | ------------------ | ----------- |
  113740. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  113741. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  113742. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  113743. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  113744. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  113745. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  113746. * | 7 | NEAREST_LINEAR | |
  113747. * | 8 | NEAREST_NEAREST | |
  113748. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  113749. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  113750. * | 11 | LINEAR_LINEAR | |
  113751. * | 12 | LINEAR_NEAREST | |
  113752. *
  113753. * > _mag_: magnification filter (close to the viewer)
  113754. * > _min_: minification filter (far from the viewer)
  113755. * > _mip_: filter used between mip map levels
  113756. *@param samplingMode Define the new sampling mode of the texture
  113757. */
  113758. updateSamplingMode(samplingMode: number): void;
  113759. /**
  113760. * Scales the texture if is `canRescale()`
  113761. * @param ratio the resize factor we want to use to rescale
  113762. */
  113763. scale(ratio: number): void;
  113764. /**
  113765. * Get if the texture can rescale.
  113766. */
  113767. get canRescale(): boolean;
  113768. /** @hidden */
  113769. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  113770. /** @hidden */
  113771. _rebuild(): void;
  113772. /**
  113773. * Triggers the load sequence in delayed load mode.
  113774. */
  113775. delayLoad(): void;
  113776. /**
  113777. * Clones the texture.
  113778. * @returns the cloned texture
  113779. */
  113780. clone(): Nullable<BaseTexture>;
  113781. /**
  113782. * Get the texture underlying type (INT, FLOAT...)
  113783. */
  113784. get textureType(): number;
  113785. /**
  113786. * Get the texture underlying format (RGB, RGBA...)
  113787. */
  113788. get textureFormat(): number;
  113789. /**
  113790. * Indicates that textures need to be re-calculated for all materials
  113791. */
  113792. protected _markAllSubMeshesAsTexturesDirty(): void;
  113793. /**
  113794. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  113795. * This will returns an RGBA array buffer containing either in values (0-255) or
  113796. * float values (0-1) depending of the underlying buffer type.
  113797. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  113798. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  113799. * @param buffer defines a user defined buffer to fill with data (can be null)
  113800. * @returns The Array buffer containing the pixels data.
  113801. */
  113802. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  113803. /**
  113804. * Release and destroy the underlying lower level texture aka internalTexture.
  113805. */
  113806. releaseInternalTexture(): void;
  113807. /** @hidden */
  113808. get _lodTextureHigh(): Nullable<BaseTexture>;
  113809. /** @hidden */
  113810. get _lodTextureMid(): Nullable<BaseTexture>;
  113811. /** @hidden */
  113812. get _lodTextureLow(): Nullable<BaseTexture>;
  113813. /**
  113814. * Dispose the texture and release its associated resources.
  113815. */
  113816. dispose(): void;
  113817. /**
  113818. * Serialize the texture into a JSON representation that can be parsed later on.
  113819. * @returns the JSON representation of the texture
  113820. */
  113821. serialize(): any;
  113822. /**
  113823. * Helper function to be called back once a list of texture contains only ready textures.
  113824. * @param textures Define the list of textures to wait for
  113825. * @param callback Define the callback triggered once the entire list will be ready
  113826. */
  113827. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  113828. private static _isScene;
  113829. }
  113830. }
  113831. declare module BABYLON {
  113832. /**
  113833. * Options to be used when creating an effect.
  113834. */
  113835. export interface IEffectCreationOptions {
  113836. /**
  113837. * Atrributes that will be used in the shader.
  113838. */
  113839. attributes: string[];
  113840. /**
  113841. * Uniform varible names that will be set in the shader.
  113842. */
  113843. uniformsNames: string[];
  113844. /**
  113845. * Uniform buffer variable names that will be set in the shader.
  113846. */
  113847. uniformBuffersNames: string[];
  113848. /**
  113849. * Sampler texture variable names that will be set in the shader.
  113850. */
  113851. samplers: string[];
  113852. /**
  113853. * Define statements that will be set in the shader.
  113854. */
  113855. defines: any;
  113856. /**
  113857. * Possible fallbacks for this effect to improve performance when needed.
  113858. */
  113859. fallbacks: Nullable<IEffectFallbacks>;
  113860. /**
  113861. * Callback that will be called when the shader is compiled.
  113862. */
  113863. onCompiled: Nullable<(effect: Effect) => void>;
  113864. /**
  113865. * Callback that will be called if an error occurs during shader compilation.
  113866. */
  113867. onError: Nullable<(effect: Effect, errors: string) => void>;
  113868. /**
  113869. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113870. */
  113871. indexParameters?: any;
  113872. /**
  113873. * Max number of lights that can be used in the shader.
  113874. */
  113875. maxSimultaneousLights?: number;
  113876. /**
  113877. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  113878. */
  113879. transformFeedbackVaryings?: Nullable<string[]>;
  113880. /**
  113881. * 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
  113882. */
  113883. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  113884. /**
  113885. * Is this effect rendering to several color attachments ?
  113886. */
  113887. multiTarget?: boolean;
  113888. }
  113889. /**
  113890. * Effect containing vertex and fragment shader that can be executed on an object.
  113891. */
  113892. export class Effect implements IDisposable {
  113893. /**
  113894. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  113895. */
  113896. static ShadersRepository: string;
  113897. /**
  113898. * Enable logging of the shader code when a compilation error occurs
  113899. */
  113900. static LogShaderCodeOnCompilationError: boolean;
  113901. /**
  113902. * Name of the effect.
  113903. */
  113904. name: any;
  113905. /**
  113906. * String container all the define statements that should be set on the shader.
  113907. */
  113908. defines: string;
  113909. /**
  113910. * Callback that will be called when the shader is compiled.
  113911. */
  113912. onCompiled: Nullable<(effect: Effect) => void>;
  113913. /**
  113914. * Callback that will be called if an error occurs during shader compilation.
  113915. */
  113916. onError: Nullable<(effect: Effect, errors: string) => void>;
  113917. /**
  113918. * Callback that will be called when effect is bound.
  113919. */
  113920. onBind: Nullable<(effect: Effect) => void>;
  113921. /**
  113922. * Unique ID of the effect.
  113923. */
  113924. uniqueId: number;
  113925. /**
  113926. * Observable that will be called when the shader is compiled.
  113927. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  113928. */
  113929. onCompileObservable: Observable<Effect>;
  113930. /**
  113931. * Observable that will be called if an error occurs during shader compilation.
  113932. */
  113933. onErrorObservable: Observable<Effect>;
  113934. /** @hidden */
  113935. _onBindObservable: Nullable<Observable<Effect>>;
  113936. /**
  113937. * @hidden
  113938. * Specifies if the effect was previously ready
  113939. */
  113940. _wasPreviouslyReady: boolean;
  113941. /**
  113942. * Observable that will be called when effect is bound.
  113943. */
  113944. get onBindObservable(): Observable<Effect>;
  113945. /** @hidden */
  113946. _bonesComputationForcedToCPU: boolean;
  113947. /** @hidden */
  113948. _multiTarget: boolean;
  113949. private static _uniqueIdSeed;
  113950. private _engine;
  113951. private _uniformBuffersNames;
  113952. private _uniformBuffersNamesList;
  113953. private _uniformsNames;
  113954. private _samplerList;
  113955. private _samplers;
  113956. private _isReady;
  113957. private _compilationError;
  113958. private _allFallbacksProcessed;
  113959. private _attributesNames;
  113960. private _attributes;
  113961. private _attributeLocationByName;
  113962. private _uniforms;
  113963. /**
  113964. * Key for the effect.
  113965. * @hidden
  113966. */
  113967. _key: string;
  113968. private _indexParameters;
  113969. private _fallbacks;
  113970. private _vertexSourceCode;
  113971. private _fragmentSourceCode;
  113972. private _vertexSourceCodeOverride;
  113973. private _fragmentSourceCodeOverride;
  113974. private _transformFeedbackVaryings;
  113975. /**
  113976. * Compiled shader to webGL program.
  113977. * @hidden
  113978. */
  113979. _pipelineContext: Nullable<IPipelineContext>;
  113980. private _valueCache;
  113981. private static _baseCache;
  113982. /**
  113983. * Instantiates an effect.
  113984. * An effect can be used to create/manage/execute vertex and fragment shaders.
  113985. * @param baseName Name of the effect.
  113986. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  113987. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  113988. * @param samplers List of sampler variables that will be passed to the shader.
  113989. * @param engine Engine to be used to render the effect
  113990. * @param defines Define statements to be added to the shader.
  113991. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  113992. * @param onCompiled Callback that will be called when the shader is compiled.
  113993. * @param onError Callback that will be called if an error occurs during shader compilation.
  113994. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113995. */
  113996. 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);
  113997. private _useFinalCode;
  113998. /**
  113999. * Unique key for this effect
  114000. */
  114001. get key(): string;
  114002. /**
  114003. * If the effect has been compiled and prepared.
  114004. * @returns if the effect is compiled and prepared.
  114005. */
  114006. isReady(): boolean;
  114007. private _isReadyInternal;
  114008. /**
  114009. * The engine the effect was initialized with.
  114010. * @returns the engine.
  114011. */
  114012. getEngine(): Engine;
  114013. /**
  114014. * The pipeline context for this effect
  114015. * @returns the associated pipeline context
  114016. */
  114017. getPipelineContext(): Nullable<IPipelineContext>;
  114018. /**
  114019. * The set of names of attribute variables for the shader.
  114020. * @returns An array of attribute names.
  114021. */
  114022. getAttributesNames(): string[];
  114023. /**
  114024. * Returns the attribute at the given index.
  114025. * @param index The index of the attribute.
  114026. * @returns The location of the attribute.
  114027. */
  114028. getAttributeLocation(index: number): number;
  114029. /**
  114030. * Returns the attribute based on the name of the variable.
  114031. * @param name of the attribute to look up.
  114032. * @returns the attribute location.
  114033. */
  114034. getAttributeLocationByName(name: string): number;
  114035. /**
  114036. * The number of attributes.
  114037. * @returns the numnber of attributes.
  114038. */
  114039. getAttributesCount(): number;
  114040. /**
  114041. * Gets the index of a uniform variable.
  114042. * @param uniformName of the uniform to look up.
  114043. * @returns the index.
  114044. */
  114045. getUniformIndex(uniformName: string): number;
  114046. /**
  114047. * Returns the attribute based on the name of the variable.
  114048. * @param uniformName of the uniform to look up.
  114049. * @returns the location of the uniform.
  114050. */
  114051. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  114052. /**
  114053. * Returns an array of sampler variable names
  114054. * @returns The array of sampler variable names.
  114055. */
  114056. getSamplers(): string[];
  114057. /**
  114058. * Returns an array of uniform variable names
  114059. * @returns The array of uniform variable names.
  114060. */
  114061. getUniformNames(): string[];
  114062. /**
  114063. * Returns an array of uniform buffer variable names
  114064. * @returns The array of uniform buffer variable names.
  114065. */
  114066. getUniformBuffersNames(): string[];
  114067. /**
  114068. * Returns the index parameters used to create the effect
  114069. * @returns The index parameters object
  114070. */
  114071. getIndexParameters(): any;
  114072. /**
  114073. * The error from the last compilation.
  114074. * @returns the error string.
  114075. */
  114076. getCompilationError(): string;
  114077. /**
  114078. * Gets a boolean indicating that all fallbacks were used during compilation
  114079. * @returns true if all fallbacks were used
  114080. */
  114081. allFallbacksProcessed(): boolean;
  114082. /**
  114083. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  114084. * @param func The callback to be used.
  114085. */
  114086. executeWhenCompiled(func: (effect: Effect) => void): void;
  114087. private _checkIsReady;
  114088. private _loadShader;
  114089. /**
  114090. * Gets the vertex shader source code of this effect
  114091. */
  114092. get vertexSourceCode(): string;
  114093. /**
  114094. * Gets the fragment shader source code of this effect
  114095. */
  114096. get fragmentSourceCode(): string;
  114097. /**
  114098. * Recompiles the webGL program
  114099. * @param vertexSourceCode The source code for the vertex shader.
  114100. * @param fragmentSourceCode The source code for the fragment shader.
  114101. * @param onCompiled Callback called when completed.
  114102. * @param onError Callback called on error.
  114103. * @hidden
  114104. */
  114105. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  114106. /**
  114107. * Prepares the effect
  114108. * @hidden
  114109. */
  114110. _prepareEffect(): void;
  114111. private _getShaderCodeAndErrorLine;
  114112. private _processCompilationErrors;
  114113. /**
  114114. * Checks if the effect is supported. (Must be called after compilation)
  114115. */
  114116. get isSupported(): boolean;
  114117. /**
  114118. * Binds a texture to the engine to be used as output of the shader.
  114119. * @param channel Name of the output variable.
  114120. * @param texture Texture to bind.
  114121. * @hidden
  114122. */
  114123. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  114124. /**
  114125. * Sets a texture on the engine to be used in the shader.
  114126. * @param channel Name of the sampler variable.
  114127. * @param texture Texture to set.
  114128. */
  114129. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  114130. /**
  114131. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  114132. * @param channel Name of the sampler variable.
  114133. * @param texture Texture to set.
  114134. */
  114135. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  114136. /**
  114137. * Sets an array of textures on the engine to be used in the shader.
  114138. * @param channel Name of the variable.
  114139. * @param textures Textures to set.
  114140. */
  114141. setTextureArray(channel: string, textures: BaseTexture[]): void;
  114142. /**
  114143. * 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)
  114144. * @param channel Name of the sampler variable.
  114145. * @param postProcess Post process to get the input texture from.
  114146. */
  114147. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  114148. /**
  114149. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  114150. * 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)
  114151. * @param channel Name of the sampler variable.
  114152. * @param postProcess Post process to get the output texture from.
  114153. */
  114154. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  114155. /** @hidden */
  114156. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  114157. /** @hidden */
  114158. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  114159. /** @hidden */
  114160. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  114161. /** @hidden */
  114162. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  114163. /**
  114164. * Binds a buffer to a uniform.
  114165. * @param buffer Buffer to bind.
  114166. * @param name Name of the uniform variable to bind to.
  114167. */
  114168. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  114169. /**
  114170. * Binds block to a uniform.
  114171. * @param blockName Name of the block to bind.
  114172. * @param index Index to bind.
  114173. */
  114174. bindUniformBlock(blockName: string, index: number): void;
  114175. /**
  114176. * Sets an interger value on a uniform variable.
  114177. * @param uniformName Name of the variable.
  114178. * @param value Value to be set.
  114179. * @returns this effect.
  114180. */
  114181. setInt(uniformName: string, value: number): Effect;
  114182. /**
  114183. * Sets an int array on a uniform variable.
  114184. * @param uniformName Name of the variable.
  114185. * @param array array to be set.
  114186. * @returns this effect.
  114187. */
  114188. setIntArray(uniformName: string, array: Int32Array): Effect;
  114189. /**
  114190. * 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)
  114191. * @param uniformName Name of the variable.
  114192. * @param array array to be set.
  114193. * @returns this effect.
  114194. */
  114195. setIntArray2(uniformName: string, array: Int32Array): Effect;
  114196. /**
  114197. * 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)
  114198. * @param uniformName Name of the variable.
  114199. * @param array array to be set.
  114200. * @returns this effect.
  114201. */
  114202. setIntArray3(uniformName: string, array: Int32Array): Effect;
  114203. /**
  114204. * 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)
  114205. * @param uniformName Name of the variable.
  114206. * @param array array to be set.
  114207. * @returns this effect.
  114208. */
  114209. setIntArray4(uniformName: string, array: Int32Array): Effect;
  114210. /**
  114211. * Sets an float array on a uniform variable.
  114212. * @param uniformName Name of the variable.
  114213. * @param array array to be set.
  114214. * @returns this effect.
  114215. */
  114216. setFloatArray(uniformName: string, array: Float32Array): Effect;
  114217. /**
  114218. * 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)
  114219. * @param uniformName Name of the variable.
  114220. * @param array array to be set.
  114221. * @returns this effect.
  114222. */
  114223. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  114224. /**
  114225. * 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)
  114226. * @param uniformName Name of the variable.
  114227. * @param array array to be set.
  114228. * @returns this effect.
  114229. */
  114230. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  114231. /**
  114232. * 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)
  114233. * @param uniformName Name of the variable.
  114234. * @param array array to be set.
  114235. * @returns this effect.
  114236. */
  114237. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  114238. /**
  114239. * Sets an array on a uniform variable.
  114240. * @param uniformName Name of the variable.
  114241. * @param array array to be set.
  114242. * @returns this effect.
  114243. */
  114244. setArray(uniformName: string, array: number[]): Effect;
  114245. /**
  114246. * 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)
  114247. * @param uniformName Name of the variable.
  114248. * @param array array to be set.
  114249. * @returns this effect.
  114250. */
  114251. setArray2(uniformName: string, array: number[]): Effect;
  114252. /**
  114253. * 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)
  114254. * @param uniformName Name of the variable.
  114255. * @param array array to be set.
  114256. * @returns this effect.
  114257. */
  114258. setArray3(uniformName: string, array: number[]): Effect;
  114259. /**
  114260. * 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)
  114261. * @param uniformName Name of the variable.
  114262. * @param array array to be set.
  114263. * @returns this effect.
  114264. */
  114265. setArray4(uniformName: string, array: number[]): Effect;
  114266. /**
  114267. * Sets matrices on a uniform variable.
  114268. * @param uniformName Name of the variable.
  114269. * @param matrices matrices to be set.
  114270. * @returns this effect.
  114271. */
  114272. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  114273. /**
  114274. * Sets matrix on a uniform variable.
  114275. * @param uniformName Name of the variable.
  114276. * @param matrix matrix to be set.
  114277. * @returns this effect.
  114278. */
  114279. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  114280. /**
  114281. * 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)
  114282. * @param uniformName Name of the variable.
  114283. * @param matrix matrix to be set.
  114284. * @returns this effect.
  114285. */
  114286. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114287. /**
  114288. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  114289. * @param uniformName Name of the variable.
  114290. * @param matrix matrix to be set.
  114291. * @returns this effect.
  114292. */
  114293. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114294. /**
  114295. * Sets a float on a uniform variable.
  114296. * @param uniformName Name of the variable.
  114297. * @param value value to be set.
  114298. * @returns this effect.
  114299. */
  114300. setFloat(uniformName: string, value: number): Effect;
  114301. /**
  114302. * Sets a boolean on a uniform variable.
  114303. * @param uniformName Name of the variable.
  114304. * @param bool value to be set.
  114305. * @returns this effect.
  114306. */
  114307. setBool(uniformName: string, bool: boolean): Effect;
  114308. /**
  114309. * Sets a Vector2 on a uniform variable.
  114310. * @param uniformName Name of the variable.
  114311. * @param vector2 vector2 to be set.
  114312. * @returns this effect.
  114313. */
  114314. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  114315. /**
  114316. * Sets a float2 on a uniform variable.
  114317. * @param uniformName Name of the variable.
  114318. * @param x First float in float2.
  114319. * @param y Second float in float2.
  114320. * @returns this effect.
  114321. */
  114322. setFloat2(uniformName: string, x: number, y: number): Effect;
  114323. /**
  114324. * Sets a Vector3 on a uniform variable.
  114325. * @param uniformName Name of the variable.
  114326. * @param vector3 Value to be set.
  114327. * @returns this effect.
  114328. */
  114329. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  114330. /**
  114331. * Sets a float3 on a uniform variable.
  114332. * @param uniformName Name of the variable.
  114333. * @param x First float in float3.
  114334. * @param y Second float in float3.
  114335. * @param z Third float in float3.
  114336. * @returns this effect.
  114337. */
  114338. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  114339. /**
  114340. * Sets a Vector4 on a uniform variable.
  114341. * @param uniformName Name of the variable.
  114342. * @param vector4 Value to be set.
  114343. * @returns this effect.
  114344. */
  114345. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  114346. /**
  114347. * Sets a float4 on a uniform variable.
  114348. * @param uniformName Name of the variable.
  114349. * @param x First float in float4.
  114350. * @param y Second float in float4.
  114351. * @param z Third float in float4.
  114352. * @param w Fourth float in float4.
  114353. * @returns this effect.
  114354. */
  114355. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  114356. /**
  114357. * Sets a Color3 on a uniform variable.
  114358. * @param uniformName Name of the variable.
  114359. * @param color3 Value to be set.
  114360. * @returns this effect.
  114361. */
  114362. setColor3(uniformName: string, color3: IColor3Like): Effect;
  114363. /**
  114364. * Sets a Color4 on a uniform variable.
  114365. * @param uniformName Name of the variable.
  114366. * @param color3 Value to be set.
  114367. * @param alpha Alpha value to be set.
  114368. * @returns this effect.
  114369. */
  114370. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  114371. /**
  114372. * Sets a Color4 on a uniform variable
  114373. * @param uniformName defines the name of the variable
  114374. * @param color4 defines the value to be set
  114375. * @returns this effect.
  114376. */
  114377. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  114378. /** Release all associated resources */
  114379. dispose(): void;
  114380. /**
  114381. * This function will add a new shader to the shader store
  114382. * @param name the name of the shader
  114383. * @param pixelShader optional pixel shader content
  114384. * @param vertexShader optional vertex shader content
  114385. */
  114386. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  114387. /**
  114388. * Store of each shader (The can be looked up using effect.key)
  114389. */
  114390. static ShadersStore: {
  114391. [key: string]: string;
  114392. };
  114393. /**
  114394. * Store of each included file for a shader (The can be looked up using effect.key)
  114395. */
  114396. static IncludesShadersStore: {
  114397. [key: string]: string;
  114398. };
  114399. /**
  114400. * Resets the cache of effects.
  114401. */
  114402. static ResetCache(): void;
  114403. }
  114404. }
  114405. declare module BABYLON {
  114406. /**
  114407. * Interface used to describe the capabilities of the engine relatively to the current browser
  114408. */
  114409. export interface EngineCapabilities {
  114410. /** Maximum textures units per fragment shader */
  114411. maxTexturesImageUnits: number;
  114412. /** Maximum texture units per vertex shader */
  114413. maxVertexTextureImageUnits: number;
  114414. /** Maximum textures units in the entire pipeline */
  114415. maxCombinedTexturesImageUnits: number;
  114416. /** Maximum texture size */
  114417. maxTextureSize: number;
  114418. /** Maximum texture samples */
  114419. maxSamples?: number;
  114420. /** Maximum cube texture size */
  114421. maxCubemapTextureSize: number;
  114422. /** Maximum render texture size */
  114423. maxRenderTextureSize: number;
  114424. /** Maximum number of vertex attributes */
  114425. maxVertexAttribs: number;
  114426. /** Maximum number of varyings */
  114427. maxVaryingVectors: number;
  114428. /** Maximum number of uniforms per vertex shader */
  114429. maxVertexUniformVectors: number;
  114430. /** Maximum number of uniforms per fragment shader */
  114431. maxFragmentUniformVectors: number;
  114432. /** Defines if standard derivates (dx/dy) are supported */
  114433. standardDerivatives: boolean;
  114434. /** Defines if s3tc texture compression is supported */
  114435. s3tc?: WEBGL_compressed_texture_s3tc;
  114436. /** Defines if pvrtc texture compression is supported */
  114437. pvrtc: any;
  114438. /** Defines if etc1 texture compression is supported */
  114439. etc1: any;
  114440. /** Defines if etc2 texture compression is supported */
  114441. etc2: any;
  114442. /** Defines if astc texture compression is supported */
  114443. astc: any;
  114444. /** Defines if float textures are supported */
  114445. textureFloat: boolean;
  114446. /** Defines if vertex array objects are supported */
  114447. vertexArrayObject: boolean;
  114448. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  114449. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  114450. /** Gets the maximum level of anisotropy supported */
  114451. maxAnisotropy: number;
  114452. /** Defines if instancing is supported */
  114453. instancedArrays: boolean;
  114454. /** Defines if 32 bits indices are supported */
  114455. uintIndices: boolean;
  114456. /** Defines if high precision shaders are supported */
  114457. highPrecisionShaderSupported: boolean;
  114458. /** Defines if depth reading in the fragment shader is supported */
  114459. fragmentDepthSupported: boolean;
  114460. /** Defines if float texture linear filtering is supported*/
  114461. textureFloatLinearFiltering: boolean;
  114462. /** Defines if rendering to float textures is supported */
  114463. textureFloatRender: boolean;
  114464. /** Defines if half float textures are supported*/
  114465. textureHalfFloat: boolean;
  114466. /** Defines if half float texture linear filtering is supported*/
  114467. textureHalfFloatLinearFiltering: boolean;
  114468. /** Defines if rendering to half float textures is supported */
  114469. textureHalfFloatRender: boolean;
  114470. /** Defines if textureLOD shader command is supported */
  114471. textureLOD: boolean;
  114472. /** Defines if draw buffers extension is supported */
  114473. drawBuffersExtension: boolean;
  114474. /** Defines if depth textures are supported */
  114475. depthTextureExtension: boolean;
  114476. /** Defines if float color buffer are supported */
  114477. colorBufferFloat: boolean;
  114478. /** Gets disjoint timer query extension (null if not supported) */
  114479. timerQuery?: EXT_disjoint_timer_query;
  114480. /** Defines if timestamp can be used with timer query */
  114481. canUseTimestampForTimerQuery: boolean;
  114482. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  114483. multiview?: any;
  114484. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  114485. oculusMultiview?: any;
  114486. /** Function used to let the system compiles shaders in background */
  114487. parallelShaderCompile?: {
  114488. COMPLETION_STATUS_KHR: number;
  114489. };
  114490. /** Max number of texture samples for MSAA */
  114491. maxMSAASamples: number;
  114492. /** Defines if the blend min max extension is supported */
  114493. blendMinMax: boolean;
  114494. }
  114495. }
  114496. declare module BABYLON {
  114497. /**
  114498. * @hidden
  114499. **/
  114500. export class DepthCullingState {
  114501. private _isDepthTestDirty;
  114502. private _isDepthMaskDirty;
  114503. private _isDepthFuncDirty;
  114504. private _isCullFaceDirty;
  114505. private _isCullDirty;
  114506. private _isZOffsetDirty;
  114507. private _isFrontFaceDirty;
  114508. private _depthTest;
  114509. private _depthMask;
  114510. private _depthFunc;
  114511. private _cull;
  114512. private _cullFace;
  114513. private _zOffset;
  114514. private _frontFace;
  114515. /**
  114516. * Initializes the state.
  114517. */
  114518. constructor();
  114519. get isDirty(): boolean;
  114520. get zOffset(): number;
  114521. set zOffset(value: number);
  114522. get cullFace(): Nullable<number>;
  114523. set cullFace(value: Nullable<number>);
  114524. get cull(): Nullable<boolean>;
  114525. set cull(value: Nullable<boolean>);
  114526. get depthFunc(): Nullable<number>;
  114527. set depthFunc(value: Nullable<number>);
  114528. get depthMask(): boolean;
  114529. set depthMask(value: boolean);
  114530. get depthTest(): boolean;
  114531. set depthTest(value: boolean);
  114532. get frontFace(): Nullable<number>;
  114533. set frontFace(value: Nullable<number>);
  114534. reset(): void;
  114535. apply(gl: WebGLRenderingContext): void;
  114536. }
  114537. }
  114538. declare module BABYLON {
  114539. /**
  114540. * @hidden
  114541. **/
  114542. export class StencilState {
  114543. /** 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 */
  114544. static readonly ALWAYS: number;
  114545. /** Passed to stencilOperation to specify that stencil value must be kept */
  114546. static readonly KEEP: number;
  114547. /** Passed to stencilOperation to specify that stencil value must be replaced */
  114548. static readonly REPLACE: number;
  114549. private _isStencilTestDirty;
  114550. private _isStencilMaskDirty;
  114551. private _isStencilFuncDirty;
  114552. private _isStencilOpDirty;
  114553. private _stencilTest;
  114554. private _stencilMask;
  114555. private _stencilFunc;
  114556. private _stencilFuncRef;
  114557. private _stencilFuncMask;
  114558. private _stencilOpStencilFail;
  114559. private _stencilOpDepthFail;
  114560. private _stencilOpStencilDepthPass;
  114561. get isDirty(): boolean;
  114562. get stencilFunc(): number;
  114563. set stencilFunc(value: number);
  114564. get stencilFuncRef(): number;
  114565. set stencilFuncRef(value: number);
  114566. get stencilFuncMask(): number;
  114567. set stencilFuncMask(value: number);
  114568. get stencilOpStencilFail(): number;
  114569. set stencilOpStencilFail(value: number);
  114570. get stencilOpDepthFail(): number;
  114571. set stencilOpDepthFail(value: number);
  114572. get stencilOpStencilDepthPass(): number;
  114573. set stencilOpStencilDepthPass(value: number);
  114574. get stencilMask(): number;
  114575. set stencilMask(value: number);
  114576. get stencilTest(): boolean;
  114577. set stencilTest(value: boolean);
  114578. constructor();
  114579. reset(): void;
  114580. apply(gl: WebGLRenderingContext): void;
  114581. }
  114582. }
  114583. declare module BABYLON {
  114584. /**
  114585. * @hidden
  114586. **/
  114587. export class AlphaState {
  114588. private _isAlphaBlendDirty;
  114589. private _isBlendFunctionParametersDirty;
  114590. private _isBlendEquationParametersDirty;
  114591. private _isBlendConstantsDirty;
  114592. private _alphaBlend;
  114593. private _blendFunctionParameters;
  114594. private _blendEquationParameters;
  114595. private _blendConstants;
  114596. /**
  114597. * Initializes the state.
  114598. */
  114599. constructor();
  114600. get isDirty(): boolean;
  114601. get alphaBlend(): boolean;
  114602. set alphaBlend(value: boolean);
  114603. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  114604. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  114605. setAlphaEquationParameters(rgb: number, alpha: number): void;
  114606. reset(): void;
  114607. apply(gl: WebGLRenderingContext): void;
  114608. }
  114609. }
  114610. declare module BABYLON {
  114611. /** @hidden */
  114612. export class WebGL2ShaderProcessor implements IShaderProcessor {
  114613. attributeProcessor(attribute: string): string;
  114614. varyingProcessor(varying: string, isFragment: boolean): string;
  114615. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  114616. }
  114617. }
  114618. declare module BABYLON {
  114619. /**
  114620. * Interface for attribute information associated with buffer instanciation
  114621. */
  114622. export interface InstancingAttributeInfo {
  114623. /**
  114624. * Name of the GLSL attribute
  114625. * if attribute index is not specified, this is used to retrieve the index from the effect
  114626. */
  114627. attributeName: string;
  114628. /**
  114629. * Index/offset of the attribute in the vertex shader
  114630. * if not specified, this will be computes from the name.
  114631. */
  114632. index?: number;
  114633. /**
  114634. * size of the attribute, 1, 2, 3 or 4
  114635. */
  114636. attributeSize: number;
  114637. /**
  114638. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  114639. */
  114640. offset: number;
  114641. /**
  114642. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  114643. * default to 1
  114644. */
  114645. divisor?: number;
  114646. /**
  114647. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  114648. * default is FLOAT
  114649. */
  114650. attributeType?: number;
  114651. /**
  114652. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  114653. */
  114654. normalized?: boolean;
  114655. }
  114656. }
  114657. declare module BABYLON {
  114658. interface ThinEngine {
  114659. /**
  114660. * Update a video texture
  114661. * @param texture defines the texture to update
  114662. * @param video defines the video element to use
  114663. * @param invertY defines if data must be stored with Y axis inverted
  114664. */
  114665. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  114666. }
  114667. }
  114668. declare module BABYLON {
  114669. interface ThinEngine {
  114670. /**
  114671. * Creates a dynamic texture
  114672. * @param width defines the width of the texture
  114673. * @param height defines the height of the texture
  114674. * @param generateMipMaps defines if the engine should generate the mip levels
  114675. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  114676. * @returns the dynamic texture inside an InternalTexture
  114677. */
  114678. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  114679. /**
  114680. * Update the content of a dynamic texture
  114681. * @param texture defines the texture to update
  114682. * @param canvas defines the canvas containing the source
  114683. * @param invertY defines if data must be stored with Y axis inverted
  114684. * @param premulAlpha defines if alpha is stored as premultiplied
  114685. * @param format defines the format of the data
  114686. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  114687. */
  114688. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  114689. }
  114690. }
  114691. declare module BABYLON {
  114692. /**
  114693. * Settings for finer control over video usage
  114694. */
  114695. export interface VideoTextureSettings {
  114696. /**
  114697. * Applies `autoplay` to video, if specified
  114698. */
  114699. autoPlay?: boolean;
  114700. /**
  114701. * Applies `loop` to video, if specified
  114702. */
  114703. loop?: boolean;
  114704. /**
  114705. * Automatically updates internal texture from video at every frame in the render loop
  114706. */
  114707. autoUpdateTexture: boolean;
  114708. /**
  114709. * Image src displayed during the video loading or until the user interacts with the video.
  114710. */
  114711. poster?: string;
  114712. }
  114713. /**
  114714. * If you want to display a video in your scene, this is the special texture for that.
  114715. * This special texture works similar to other textures, with the exception of a few parameters.
  114716. * @see https://doc.babylonjs.com/how_to/video_texture
  114717. */
  114718. export class VideoTexture extends Texture {
  114719. /**
  114720. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  114721. */
  114722. readonly autoUpdateTexture: boolean;
  114723. /**
  114724. * The video instance used by the texture internally
  114725. */
  114726. readonly video: HTMLVideoElement;
  114727. private _onUserActionRequestedObservable;
  114728. /**
  114729. * Event triggerd when a dom action is required by the user to play the video.
  114730. * This happens due to recent changes in browser policies preventing video to auto start.
  114731. */
  114732. get onUserActionRequestedObservable(): Observable<Texture>;
  114733. private _generateMipMaps;
  114734. private _stillImageCaptured;
  114735. private _displayingPosterTexture;
  114736. private _settings;
  114737. private _createInternalTextureOnEvent;
  114738. private _frameId;
  114739. private _currentSrc;
  114740. /**
  114741. * Creates a video texture.
  114742. * If you want to display a video in your scene, this is the special texture for that.
  114743. * This special texture works similar to other textures, with the exception of a few parameters.
  114744. * @see https://doc.babylonjs.com/how_to/video_texture
  114745. * @param name optional name, will detect from video source, if not defined
  114746. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  114747. * @param scene is obviously the current scene.
  114748. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  114749. * @param invertY is false by default but can be used to invert video on Y axis
  114750. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  114751. * @param settings allows finer control over video usage
  114752. */
  114753. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  114754. private _getName;
  114755. private _getVideo;
  114756. private _createInternalTexture;
  114757. private reset;
  114758. /**
  114759. * @hidden Internal method to initiate `update`.
  114760. */
  114761. _rebuild(): void;
  114762. /**
  114763. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  114764. */
  114765. update(): void;
  114766. /**
  114767. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  114768. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  114769. */
  114770. updateTexture(isVisible: boolean): void;
  114771. protected _updateInternalTexture: () => void;
  114772. /**
  114773. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  114774. * @param url New url.
  114775. */
  114776. updateURL(url: string): void;
  114777. /**
  114778. * Clones the texture.
  114779. * @returns the cloned texture
  114780. */
  114781. clone(): VideoTexture;
  114782. /**
  114783. * Dispose the texture and release its associated resources.
  114784. */
  114785. dispose(): void;
  114786. /**
  114787. * Creates a video texture straight from a stream.
  114788. * @param scene Define the scene the texture should be created in
  114789. * @param stream Define the stream the texture should be created from
  114790. * @returns The created video texture as a promise
  114791. */
  114792. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  114793. /**
  114794. * Creates a video texture straight from your WebCam video feed.
  114795. * @param scene Define the scene the texture should be created in
  114796. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114797. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114798. * @returns The created video texture as a promise
  114799. */
  114800. static CreateFromWebCamAsync(scene: Scene, constraints: {
  114801. minWidth: number;
  114802. maxWidth: number;
  114803. minHeight: number;
  114804. maxHeight: number;
  114805. deviceId: string;
  114806. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  114807. /**
  114808. * Creates a video texture straight from your WebCam video feed.
  114809. * @param scene Define the scene the texture should be created in
  114810. * @param onReady Define a callback to triggered once the texture will be ready
  114811. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114812. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114813. */
  114814. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  114815. minWidth: number;
  114816. maxWidth: number;
  114817. minHeight: number;
  114818. maxHeight: number;
  114819. deviceId: string;
  114820. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  114821. }
  114822. }
  114823. declare module BABYLON {
  114824. /**
  114825. * Defines the interface used by objects working like Scene
  114826. * @hidden
  114827. */
  114828. export interface ISceneLike {
  114829. _addPendingData(data: any): void;
  114830. _removePendingData(data: any): void;
  114831. offlineProvider: IOfflineProvider;
  114832. }
  114833. /**
  114834. * Information about the current host
  114835. */
  114836. export interface HostInformation {
  114837. /**
  114838. * Defines if the current host is a mobile
  114839. */
  114840. isMobile: boolean;
  114841. }
  114842. /** Interface defining initialization parameters for Engine class */
  114843. export interface EngineOptions extends WebGLContextAttributes {
  114844. /**
  114845. * Defines if the engine should no exceed a specified device ratio
  114846. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  114847. */
  114848. limitDeviceRatio?: number;
  114849. /**
  114850. * Defines if webvr should be enabled automatically
  114851. * @see https://doc.babylonjs.com/how_to/webvr_camera
  114852. */
  114853. autoEnableWebVR?: boolean;
  114854. /**
  114855. * Defines if webgl2 should be turned off even if supported
  114856. * @see https://doc.babylonjs.com/features/webgl2
  114857. */
  114858. disableWebGL2Support?: boolean;
  114859. /**
  114860. * Defines if webaudio should be initialized as well
  114861. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  114862. */
  114863. audioEngine?: boolean;
  114864. /**
  114865. * Defines if animations should run using a deterministic lock step
  114866. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  114867. */
  114868. deterministicLockstep?: boolean;
  114869. /** Defines the maximum steps to use with deterministic lock step mode */
  114870. lockstepMaxSteps?: number;
  114871. /** Defines the seconds between each deterministic lock step */
  114872. timeStep?: number;
  114873. /**
  114874. * Defines that engine should ignore context lost events
  114875. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  114876. */
  114877. doNotHandleContextLost?: boolean;
  114878. /**
  114879. * Defines that engine should ignore modifying touch action attribute and style
  114880. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  114881. */
  114882. doNotHandleTouchAction?: boolean;
  114883. /**
  114884. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  114885. */
  114886. useHighPrecisionFloats?: boolean;
  114887. /**
  114888. * Make the canvas XR Compatible for XR sessions
  114889. */
  114890. xrCompatible?: boolean;
  114891. /**
  114892. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  114893. */
  114894. useHighPrecisionMatrix?: boolean;
  114895. }
  114896. /**
  114897. * The base engine class (root of all engines)
  114898. */
  114899. export class ThinEngine {
  114900. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  114901. static ExceptionList: ({
  114902. key: string;
  114903. capture: string;
  114904. captureConstraint: number;
  114905. targets: string[];
  114906. } | {
  114907. key: string;
  114908. capture: null;
  114909. captureConstraint: null;
  114910. targets: string[];
  114911. })[];
  114912. /** @hidden */
  114913. static _TextureLoaders: IInternalTextureLoader[];
  114914. /**
  114915. * Returns the current npm package of the sdk
  114916. */
  114917. static get NpmPackage(): string;
  114918. /**
  114919. * Returns the current version of the framework
  114920. */
  114921. static get Version(): string;
  114922. /**
  114923. * Returns a string describing the current engine
  114924. */
  114925. get description(): string;
  114926. /**
  114927. * Gets or sets the epsilon value used by collision engine
  114928. */
  114929. static CollisionsEpsilon: number;
  114930. /**
  114931. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  114932. */
  114933. static get ShadersRepository(): string;
  114934. static set ShadersRepository(value: string);
  114935. /** @hidden */
  114936. _shaderProcessor: IShaderProcessor;
  114937. /**
  114938. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  114939. */
  114940. forcePOTTextures: boolean;
  114941. /**
  114942. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  114943. */
  114944. isFullscreen: boolean;
  114945. /**
  114946. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  114947. */
  114948. cullBackFaces: boolean;
  114949. /**
  114950. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  114951. */
  114952. renderEvenInBackground: boolean;
  114953. /**
  114954. * Gets or sets a boolean indicating that cache can be kept between frames
  114955. */
  114956. preventCacheWipeBetweenFrames: boolean;
  114957. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  114958. validateShaderPrograms: boolean;
  114959. /**
  114960. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  114961. * This can provide greater z depth for distant objects.
  114962. */
  114963. useReverseDepthBuffer: boolean;
  114964. /**
  114965. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  114966. */
  114967. disableUniformBuffers: boolean;
  114968. /** @hidden */
  114969. _uniformBuffers: UniformBuffer[];
  114970. /**
  114971. * Gets a boolean indicating that the engine supports uniform buffers
  114972. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  114973. */
  114974. get supportsUniformBuffers(): boolean;
  114975. /** @hidden */
  114976. _gl: WebGLRenderingContext;
  114977. /** @hidden */
  114978. _webGLVersion: number;
  114979. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  114980. protected _windowIsBackground: boolean;
  114981. protected _creationOptions: EngineOptions;
  114982. protected _highPrecisionShadersAllowed: boolean;
  114983. /** @hidden */
  114984. get _shouldUseHighPrecisionShader(): boolean;
  114985. /**
  114986. * Gets a boolean indicating that only power of 2 textures are supported
  114987. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  114988. */
  114989. get needPOTTextures(): boolean;
  114990. /** @hidden */
  114991. _badOS: boolean;
  114992. /** @hidden */
  114993. _badDesktopOS: boolean;
  114994. private _hardwareScalingLevel;
  114995. /** @hidden */
  114996. _caps: EngineCapabilities;
  114997. private _isStencilEnable;
  114998. private _glVersion;
  114999. private _glRenderer;
  115000. private _glVendor;
  115001. /** @hidden */
  115002. _videoTextureSupported: boolean;
  115003. protected _renderingQueueLaunched: boolean;
  115004. protected _activeRenderLoops: (() => void)[];
  115005. /**
  115006. * Observable signaled when a context lost event is raised
  115007. */
  115008. onContextLostObservable: Observable<ThinEngine>;
  115009. /**
  115010. * Observable signaled when a context restored event is raised
  115011. */
  115012. onContextRestoredObservable: Observable<ThinEngine>;
  115013. private _onContextLost;
  115014. private _onContextRestored;
  115015. protected _contextWasLost: boolean;
  115016. /** @hidden */
  115017. _doNotHandleContextLost: boolean;
  115018. /**
  115019. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  115020. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  115021. */
  115022. get doNotHandleContextLost(): boolean;
  115023. set doNotHandleContextLost(value: boolean);
  115024. /**
  115025. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  115026. */
  115027. disableVertexArrayObjects: boolean;
  115028. /** @hidden */
  115029. protected _colorWrite: boolean;
  115030. /** @hidden */
  115031. protected _colorWriteChanged: boolean;
  115032. /** @hidden */
  115033. protected _depthCullingState: DepthCullingState;
  115034. /** @hidden */
  115035. protected _stencilState: StencilState;
  115036. /** @hidden */
  115037. _alphaState: AlphaState;
  115038. /** @hidden */
  115039. _alphaMode: number;
  115040. /** @hidden */
  115041. _alphaEquation: number;
  115042. /** @hidden */
  115043. _internalTexturesCache: InternalTexture[];
  115044. /** @hidden */
  115045. protected _activeChannel: number;
  115046. private _currentTextureChannel;
  115047. /** @hidden */
  115048. protected _boundTexturesCache: {
  115049. [key: string]: Nullable<InternalTexture>;
  115050. };
  115051. /** @hidden */
  115052. protected _currentEffect: Nullable<Effect>;
  115053. /** @hidden */
  115054. protected _currentProgram: Nullable<WebGLProgram>;
  115055. private _compiledEffects;
  115056. private _vertexAttribArraysEnabled;
  115057. /** @hidden */
  115058. protected _cachedViewport: Nullable<IViewportLike>;
  115059. private _cachedVertexArrayObject;
  115060. /** @hidden */
  115061. protected _cachedVertexBuffers: any;
  115062. /** @hidden */
  115063. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  115064. /** @hidden */
  115065. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  115066. /** @hidden */
  115067. _currentRenderTarget: Nullable<InternalTexture>;
  115068. private _uintIndicesCurrentlySet;
  115069. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  115070. /** @hidden */
  115071. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  115072. /** @hidden */
  115073. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  115074. private _currentBufferPointers;
  115075. private _currentInstanceLocations;
  115076. private _currentInstanceBuffers;
  115077. private _textureUnits;
  115078. /** @hidden */
  115079. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  115080. /** @hidden */
  115081. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  115082. /** @hidden */
  115083. _boundRenderFunction: any;
  115084. private _vaoRecordInProgress;
  115085. private _mustWipeVertexAttributes;
  115086. private _emptyTexture;
  115087. private _emptyCubeTexture;
  115088. private _emptyTexture3D;
  115089. private _emptyTexture2DArray;
  115090. /** @hidden */
  115091. _frameHandler: number;
  115092. private _nextFreeTextureSlots;
  115093. private _maxSimultaneousTextures;
  115094. private _activeRequests;
  115095. /** @hidden */
  115096. _transformTextureUrl: Nullable<(url: string) => string>;
  115097. /**
  115098. * Gets information about the current host
  115099. */
  115100. hostInformation: HostInformation;
  115101. protected get _supportsHardwareTextureRescaling(): boolean;
  115102. private _framebufferDimensionsObject;
  115103. /**
  115104. * sets the object from which width and height will be taken from when getting render width and height
  115105. * Will fallback to the gl object
  115106. * @param dimensions the framebuffer width and height that will be used.
  115107. */
  115108. set framebufferDimensionsObject(dimensions: Nullable<{
  115109. framebufferWidth: number;
  115110. framebufferHeight: number;
  115111. }>);
  115112. /**
  115113. * Gets the current viewport
  115114. */
  115115. get currentViewport(): Nullable<IViewportLike>;
  115116. /**
  115117. * Gets the default empty texture
  115118. */
  115119. get emptyTexture(): InternalTexture;
  115120. /**
  115121. * Gets the default empty 3D texture
  115122. */
  115123. get emptyTexture3D(): InternalTexture;
  115124. /**
  115125. * Gets the default empty 2D array texture
  115126. */
  115127. get emptyTexture2DArray(): InternalTexture;
  115128. /**
  115129. * Gets the default empty cube texture
  115130. */
  115131. get emptyCubeTexture(): InternalTexture;
  115132. /**
  115133. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  115134. */
  115135. readonly premultipliedAlpha: boolean;
  115136. /**
  115137. * Observable event triggered before each texture is initialized
  115138. */
  115139. onBeforeTextureInitObservable: Observable<Texture>;
  115140. /**
  115141. * Creates a new engine
  115142. * @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
  115143. * @param antialias defines enable antialiasing (default: false)
  115144. * @param options defines further options to be sent to the getContext() function
  115145. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  115146. */
  115147. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  115148. private _rebuildInternalTextures;
  115149. private _rebuildEffects;
  115150. /**
  115151. * Gets a boolean indicating if all created effects are ready
  115152. * @returns true if all effects are ready
  115153. */
  115154. areAllEffectsReady(): boolean;
  115155. protected _rebuildBuffers(): void;
  115156. protected _initGLContext(): void;
  115157. /**
  115158. * Gets version of the current webGL context
  115159. */
  115160. get webGLVersion(): number;
  115161. /**
  115162. * Gets a string identifying the name of the class
  115163. * @returns "Engine" string
  115164. */
  115165. getClassName(): string;
  115166. /**
  115167. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  115168. */
  115169. get isStencilEnable(): boolean;
  115170. /** @hidden */
  115171. _prepareWorkingCanvas(): void;
  115172. /**
  115173. * Reset the texture cache to empty state
  115174. */
  115175. resetTextureCache(): void;
  115176. /**
  115177. * Gets an object containing information about the current webGL context
  115178. * @returns an object containing the vender, the renderer and the version of the current webGL context
  115179. */
  115180. getGlInfo(): {
  115181. vendor: string;
  115182. renderer: string;
  115183. version: string;
  115184. };
  115185. /**
  115186. * Defines the hardware scaling level.
  115187. * By default the hardware scaling level is computed from the window device ratio.
  115188. * 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.
  115189. * @param level defines the level to use
  115190. */
  115191. setHardwareScalingLevel(level: number): void;
  115192. /**
  115193. * Gets the current hardware scaling level.
  115194. * By default the hardware scaling level is computed from the window device ratio.
  115195. * 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.
  115196. * @returns a number indicating the current hardware scaling level
  115197. */
  115198. getHardwareScalingLevel(): number;
  115199. /**
  115200. * Gets the list of loaded textures
  115201. * @returns an array containing all loaded textures
  115202. */
  115203. getLoadedTexturesCache(): InternalTexture[];
  115204. /**
  115205. * Gets the object containing all engine capabilities
  115206. * @returns the EngineCapabilities object
  115207. */
  115208. getCaps(): EngineCapabilities;
  115209. /**
  115210. * stop executing a render loop function and remove it from the execution array
  115211. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  115212. */
  115213. stopRenderLoop(renderFunction?: () => void): void;
  115214. /** @hidden */
  115215. _renderLoop(): void;
  115216. /**
  115217. * Gets the HTML canvas attached with the current webGL context
  115218. * @returns a HTML canvas
  115219. */
  115220. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  115221. /**
  115222. * Gets host window
  115223. * @returns the host window object
  115224. */
  115225. getHostWindow(): Nullable<Window>;
  115226. /**
  115227. * Gets the current render width
  115228. * @param useScreen defines if screen size must be used (or the current render target if any)
  115229. * @returns a number defining the current render width
  115230. */
  115231. getRenderWidth(useScreen?: boolean): number;
  115232. /**
  115233. * Gets the current render height
  115234. * @param useScreen defines if screen size must be used (or the current render target if any)
  115235. * @returns a number defining the current render height
  115236. */
  115237. getRenderHeight(useScreen?: boolean): number;
  115238. /**
  115239. * Can be used to override the current requestAnimationFrame requester.
  115240. * @hidden
  115241. */
  115242. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  115243. /**
  115244. * Register and execute a render loop. The engine can have more than one render function
  115245. * @param renderFunction defines the function to continuously execute
  115246. */
  115247. runRenderLoop(renderFunction: () => void): void;
  115248. /**
  115249. * Clear the current render buffer or the current render target (if any is set up)
  115250. * @param color defines the color to use
  115251. * @param backBuffer defines if the back buffer must be cleared
  115252. * @param depth defines if the depth buffer must be cleared
  115253. * @param stencil defines if the stencil buffer must be cleared
  115254. */
  115255. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  115256. private _viewportCached;
  115257. /** @hidden */
  115258. _viewport(x: number, y: number, width: number, height: number): void;
  115259. /**
  115260. * Set the WebGL's viewport
  115261. * @param viewport defines the viewport element to be used
  115262. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  115263. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  115264. */
  115265. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  115266. /**
  115267. * Begin a new frame
  115268. */
  115269. beginFrame(): void;
  115270. /**
  115271. * Enf the current frame
  115272. */
  115273. endFrame(): void;
  115274. /**
  115275. * Resize the view according to the canvas' size
  115276. */
  115277. resize(): void;
  115278. /**
  115279. * Force a specific size of the canvas
  115280. * @param width defines the new canvas' width
  115281. * @param height defines the new canvas' height
  115282. * @returns true if the size was changed
  115283. */
  115284. setSize(width: number, height: number): boolean;
  115285. /**
  115286. * Binds the frame buffer to the specified texture.
  115287. * @param texture The texture to render to or null for the default canvas
  115288. * @param faceIndex The face of the texture to render to in case of cube texture
  115289. * @param requiredWidth The width of the target to render to
  115290. * @param requiredHeight The height of the target to render to
  115291. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  115292. * @param lodLevel defines the lod level to bind to the frame buffer
  115293. * @param layer defines the 2d array index to bind to frame buffer to
  115294. */
  115295. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  115296. /** @hidden */
  115297. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  115298. /**
  115299. * Unbind the current render target texture from the webGL context
  115300. * @param texture defines the render target texture to unbind
  115301. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  115302. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  115303. */
  115304. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  115305. /**
  115306. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  115307. */
  115308. flushFramebuffer(): void;
  115309. /**
  115310. * Unbind the current render target and bind the default framebuffer
  115311. */
  115312. restoreDefaultFramebuffer(): void;
  115313. /** @hidden */
  115314. protected _resetVertexBufferBinding(): void;
  115315. /**
  115316. * Creates a vertex buffer
  115317. * @param data the data for the vertex buffer
  115318. * @returns the new WebGL static buffer
  115319. */
  115320. createVertexBuffer(data: DataArray): DataBuffer;
  115321. private _createVertexBuffer;
  115322. /**
  115323. * Creates a dynamic vertex buffer
  115324. * @param data the data for the dynamic vertex buffer
  115325. * @returns the new WebGL dynamic buffer
  115326. */
  115327. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  115328. protected _resetIndexBufferBinding(): void;
  115329. /**
  115330. * Creates a new index buffer
  115331. * @param indices defines the content of the index buffer
  115332. * @param updatable defines if the index buffer must be updatable
  115333. * @returns a new webGL buffer
  115334. */
  115335. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  115336. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  115337. /**
  115338. * Bind a webGL buffer to the webGL context
  115339. * @param buffer defines the buffer to bind
  115340. */
  115341. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  115342. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  115343. private bindBuffer;
  115344. /**
  115345. * update the bound buffer with the given data
  115346. * @param data defines the data to update
  115347. */
  115348. updateArrayBuffer(data: Float32Array): void;
  115349. private _vertexAttribPointer;
  115350. /** @hidden */
  115351. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  115352. private _bindVertexBuffersAttributes;
  115353. /**
  115354. * Records a vertex array object
  115355. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115356. * @param vertexBuffers defines the list of vertex buffers to store
  115357. * @param indexBuffer defines the index buffer to store
  115358. * @param effect defines the effect to store
  115359. * @returns the new vertex array object
  115360. */
  115361. recordVertexArrayObject(vertexBuffers: {
  115362. [key: string]: VertexBuffer;
  115363. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  115364. /**
  115365. * Bind a specific vertex array object
  115366. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115367. * @param vertexArrayObject defines the vertex array object to bind
  115368. * @param indexBuffer defines the index buffer to bind
  115369. */
  115370. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  115371. /**
  115372. * Bind webGl buffers directly to the webGL context
  115373. * @param vertexBuffer defines the vertex buffer to bind
  115374. * @param indexBuffer defines the index buffer to bind
  115375. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  115376. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  115377. * @param effect defines the effect associated with the vertex buffer
  115378. */
  115379. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  115380. private _unbindVertexArrayObject;
  115381. /**
  115382. * Bind a list of vertex buffers to the webGL context
  115383. * @param vertexBuffers defines the list of vertex buffers to bind
  115384. * @param indexBuffer defines the index buffer to bind
  115385. * @param effect defines the effect associated with the vertex buffers
  115386. */
  115387. bindBuffers(vertexBuffers: {
  115388. [key: string]: Nullable<VertexBuffer>;
  115389. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  115390. /**
  115391. * Unbind all instance attributes
  115392. */
  115393. unbindInstanceAttributes(): void;
  115394. /**
  115395. * Release and free the memory of a vertex array object
  115396. * @param vao defines the vertex array object to delete
  115397. */
  115398. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  115399. /** @hidden */
  115400. _releaseBuffer(buffer: DataBuffer): boolean;
  115401. protected _deleteBuffer(buffer: DataBuffer): void;
  115402. /**
  115403. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  115404. * @param instancesBuffer defines the webGL buffer to update and bind
  115405. * @param data defines the data to store in the buffer
  115406. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  115407. */
  115408. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  115409. /**
  115410. * Bind the content of a webGL buffer used with instantiation
  115411. * @param instancesBuffer defines the webGL buffer to bind
  115412. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  115413. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  115414. */
  115415. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  115416. /**
  115417. * Disable the instance attribute corresponding to the name in parameter
  115418. * @param name defines the name of the attribute to disable
  115419. */
  115420. disableInstanceAttributeByName(name: string): void;
  115421. /**
  115422. * Disable the instance attribute corresponding to the location in parameter
  115423. * @param attributeLocation defines the attribute location of the attribute to disable
  115424. */
  115425. disableInstanceAttribute(attributeLocation: number): void;
  115426. /**
  115427. * Disable the attribute corresponding to the location in parameter
  115428. * @param attributeLocation defines the attribute location of the attribute to disable
  115429. */
  115430. disableAttributeByIndex(attributeLocation: number): void;
  115431. /**
  115432. * Send a draw order
  115433. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115434. * @param indexStart defines the starting index
  115435. * @param indexCount defines the number of index to draw
  115436. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115437. */
  115438. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  115439. /**
  115440. * Draw a list of points
  115441. * @param verticesStart defines the index of first vertex to draw
  115442. * @param verticesCount defines the count of vertices to draw
  115443. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115444. */
  115445. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115446. /**
  115447. * Draw a list of unindexed primitives
  115448. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115449. * @param verticesStart defines the index of first vertex to draw
  115450. * @param verticesCount defines the count of vertices to draw
  115451. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115452. */
  115453. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115454. /**
  115455. * Draw a list of indexed primitives
  115456. * @param fillMode defines the primitive to use
  115457. * @param indexStart defines the starting index
  115458. * @param indexCount defines the number of index to draw
  115459. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115460. */
  115461. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  115462. /**
  115463. * Draw a list of unindexed primitives
  115464. * @param fillMode defines the primitive to use
  115465. * @param verticesStart defines the index of first vertex to draw
  115466. * @param verticesCount defines the count of vertices to draw
  115467. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115468. */
  115469. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115470. private _drawMode;
  115471. /** @hidden */
  115472. protected _reportDrawCall(): void;
  115473. /** @hidden */
  115474. _releaseEffect(effect: Effect): void;
  115475. /** @hidden */
  115476. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  115477. /**
  115478. * Create a new effect (used to store vertex/fragment shaders)
  115479. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  115480. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  115481. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  115482. * @param samplers defines an array of string used to represent textures
  115483. * @param defines defines the string containing the defines to use to compile the shaders
  115484. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  115485. * @param onCompiled defines a function to call when the effect creation is successful
  115486. * @param onError defines a function to call when the effect creation has failed
  115487. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  115488. * @returns the new Effect
  115489. */
  115490. 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;
  115491. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  115492. private _compileShader;
  115493. private _compileRawShader;
  115494. /** @hidden */
  115495. _getShaderSource(shader: WebGLShader): Nullable<string>;
  115496. /**
  115497. * Directly creates a webGL program
  115498. * @param pipelineContext defines the pipeline context to attach to
  115499. * @param vertexCode defines the vertex shader code to use
  115500. * @param fragmentCode defines the fragment shader code to use
  115501. * @param context defines the webGL context to use (if not set, the current one will be used)
  115502. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115503. * @returns the new webGL program
  115504. */
  115505. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115506. /**
  115507. * Creates a webGL program
  115508. * @param pipelineContext defines the pipeline context to attach to
  115509. * @param vertexCode defines the vertex shader code to use
  115510. * @param fragmentCode defines the fragment shader code to use
  115511. * @param defines defines the string containing the defines to use to compile the shaders
  115512. * @param context defines the webGL context to use (if not set, the current one will be used)
  115513. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115514. * @returns the new webGL program
  115515. */
  115516. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115517. /**
  115518. * Creates a new pipeline context
  115519. * @returns the new pipeline
  115520. */
  115521. createPipelineContext(): IPipelineContext;
  115522. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115523. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  115524. /** @hidden */
  115525. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  115526. /** @hidden */
  115527. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  115528. /** @hidden */
  115529. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  115530. /**
  115531. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  115532. * @param pipelineContext defines the pipeline context to use
  115533. * @param uniformsNames defines the list of uniform names
  115534. * @returns an array of webGL uniform locations
  115535. */
  115536. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  115537. /**
  115538. * Gets the lsit of active attributes for a given webGL program
  115539. * @param pipelineContext defines the pipeline context to use
  115540. * @param attributesNames defines the list of attribute names to get
  115541. * @returns an array of indices indicating the offset of each attribute
  115542. */
  115543. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  115544. /**
  115545. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  115546. * @param effect defines the effect to activate
  115547. */
  115548. enableEffect(effect: Nullable<Effect>): void;
  115549. /**
  115550. * Set the value of an uniform to a number (int)
  115551. * @param uniform defines the webGL uniform location where to store the value
  115552. * @param value defines the int number to store
  115553. */
  115554. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115555. /**
  115556. * Set the value of an uniform to an array of int32
  115557. * @param uniform defines the webGL uniform location where to store the value
  115558. * @param array defines the array of int32 to store
  115559. */
  115560. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115561. /**
  115562. * Set the value of an uniform to an array of int32 (stored as vec2)
  115563. * @param uniform defines the webGL uniform location where to store the value
  115564. * @param array defines the array of int32 to store
  115565. */
  115566. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115567. /**
  115568. * Set the value of an uniform to an array of int32 (stored as vec3)
  115569. * @param uniform defines the webGL uniform location where to store the value
  115570. * @param array defines the array of int32 to store
  115571. */
  115572. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115573. /**
  115574. * Set the value of an uniform to an array of int32 (stored as vec4)
  115575. * @param uniform defines the webGL uniform location where to store the value
  115576. * @param array defines the array of int32 to store
  115577. */
  115578. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115579. /**
  115580. * Set the value of an uniform to an array of number
  115581. * @param uniform defines the webGL uniform location where to store the value
  115582. * @param array defines the array of number to store
  115583. */
  115584. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115585. /**
  115586. * Set the value of an uniform to an array of number (stored as vec2)
  115587. * @param uniform defines the webGL uniform location where to store the value
  115588. * @param array defines the array of number to store
  115589. */
  115590. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115591. /**
  115592. * Set the value of an uniform to an array of number (stored as vec3)
  115593. * @param uniform defines the webGL uniform location where to store the value
  115594. * @param array defines the array of number to store
  115595. */
  115596. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115597. /**
  115598. * Set the value of an uniform to an array of number (stored as vec4)
  115599. * @param uniform defines the webGL uniform location where to store the value
  115600. * @param array defines the array of number to store
  115601. */
  115602. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115603. /**
  115604. * Set the value of an uniform to an array of float32 (stored as matrices)
  115605. * @param uniform defines the webGL uniform location where to store the value
  115606. * @param matrices defines the array of float32 to store
  115607. */
  115608. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  115609. /**
  115610. * Set the value of an uniform to a matrix (3x3)
  115611. * @param uniform defines the webGL uniform location where to store the value
  115612. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  115613. */
  115614. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115615. /**
  115616. * Set the value of an uniform to a matrix (2x2)
  115617. * @param uniform defines the webGL uniform location where to store the value
  115618. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  115619. */
  115620. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115621. /**
  115622. * Set the value of an uniform to a number (float)
  115623. * @param uniform defines the webGL uniform location where to store the value
  115624. * @param value defines the float number to store
  115625. */
  115626. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115627. /**
  115628. * Set the value of an uniform to a vec2
  115629. * @param uniform defines the webGL uniform location where to store the value
  115630. * @param x defines the 1st component of the value
  115631. * @param y defines the 2nd component of the value
  115632. */
  115633. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  115634. /**
  115635. * Set the value of an uniform to a vec3
  115636. * @param uniform defines the webGL uniform location where to store the value
  115637. * @param x defines the 1st component of the value
  115638. * @param y defines the 2nd component of the value
  115639. * @param z defines the 3rd component of the value
  115640. */
  115641. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  115642. /**
  115643. * Set the value of an uniform to a vec4
  115644. * @param uniform defines the webGL uniform location where to store the value
  115645. * @param x defines the 1st component of the value
  115646. * @param y defines the 2nd component of the value
  115647. * @param z defines the 3rd component of the value
  115648. * @param w defines the 4th component of the value
  115649. */
  115650. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  115651. /**
  115652. * Apply all cached states (depth, culling, stencil and alpha)
  115653. */
  115654. applyStates(): void;
  115655. /**
  115656. * Enable or disable color writing
  115657. * @param enable defines the state to set
  115658. */
  115659. setColorWrite(enable: boolean): void;
  115660. /**
  115661. * Gets a boolean indicating if color writing is enabled
  115662. * @returns the current color writing state
  115663. */
  115664. getColorWrite(): boolean;
  115665. /**
  115666. * Gets the depth culling state manager
  115667. */
  115668. get depthCullingState(): DepthCullingState;
  115669. /**
  115670. * Gets the alpha state manager
  115671. */
  115672. get alphaState(): AlphaState;
  115673. /**
  115674. * Gets the stencil state manager
  115675. */
  115676. get stencilState(): StencilState;
  115677. /**
  115678. * Clears the list of texture accessible through engine.
  115679. * This can help preventing texture load conflict due to name collision.
  115680. */
  115681. clearInternalTexturesCache(): void;
  115682. /**
  115683. * Force the entire cache to be cleared
  115684. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  115685. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  115686. */
  115687. wipeCaches(bruteForce?: boolean): void;
  115688. /** @hidden */
  115689. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  115690. min: number;
  115691. mag: number;
  115692. };
  115693. /** @hidden */
  115694. _createTexture(): WebGLTexture;
  115695. /**
  115696. * Usually called from Texture.ts.
  115697. * Passed information to create a WebGLTexture
  115698. * @param url defines a value which contains one of the following:
  115699. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  115700. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  115701. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  115702. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  115703. * @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)
  115704. * @param scene needed for loading to the correct scene
  115705. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  115706. * @param onLoad optional callback to be called upon successful completion
  115707. * @param onError optional callback to be called upon failure
  115708. * @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
  115709. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  115710. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  115711. * @param forcedExtension defines the extension to use to pick the right loader
  115712. * @param mimeType defines an optional mime type
  115713. * @returns a InternalTexture for assignment back into BABYLON.Texture
  115714. */
  115715. 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;
  115716. /**
  115717. * Loads an image as an HTMLImageElement.
  115718. * @param input url string, ArrayBuffer, or Blob to load
  115719. * @param onLoad callback called when the image successfully loads
  115720. * @param onError callback called when the image fails to load
  115721. * @param offlineProvider offline provider for caching
  115722. * @param mimeType optional mime type
  115723. * @returns the HTMLImageElement of the loaded image
  115724. * @hidden
  115725. */
  115726. 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>;
  115727. /**
  115728. * @hidden
  115729. */
  115730. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  115731. private _unpackFlipYCached;
  115732. /**
  115733. * In case you are sharing the context with other applications, it might
  115734. * be interested to not cache the unpack flip y state to ensure a consistent
  115735. * value would be set.
  115736. */
  115737. enableUnpackFlipYCached: boolean;
  115738. /** @hidden */
  115739. _unpackFlipY(value: boolean): void;
  115740. /** @hidden */
  115741. _getUnpackAlignement(): number;
  115742. private _getTextureTarget;
  115743. /**
  115744. * Update the sampling mode of a given texture
  115745. * @param samplingMode defines the required sampling mode
  115746. * @param texture defines the texture to update
  115747. * @param generateMipMaps defines whether to generate mipmaps for the texture
  115748. */
  115749. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  115750. /**
  115751. * Update the sampling mode of a given texture
  115752. * @param texture defines the texture to update
  115753. * @param wrapU defines the texture wrap mode of the u coordinates
  115754. * @param wrapV defines the texture wrap mode of the v coordinates
  115755. * @param wrapR defines the texture wrap mode of the r coordinates
  115756. */
  115757. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  115758. /** @hidden */
  115759. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  115760. width: number;
  115761. height: number;
  115762. layers?: number;
  115763. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  115764. /** @hidden */
  115765. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115766. /** @hidden */
  115767. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  115768. /**
  115769. * Update a portion of an internal texture
  115770. * @param texture defines the texture to update
  115771. * @param imageData defines the data to store into the texture
  115772. * @param xOffset defines the x coordinates of the update rectangle
  115773. * @param yOffset defines the y coordinates of the update rectangle
  115774. * @param width defines the width of the update rectangle
  115775. * @param height defines the height of the update rectangle
  115776. * @param faceIndex defines the face index if texture is a cube (0 by default)
  115777. * @param lod defines the lod level to update (0 by default)
  115778. */
  115779. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  115780. /** @hidden */
  115781. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115782. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  115783. private _prepareWebGLTexture;
  115784. /** @hidden */
  115785. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  115786. private _getDepthStencilBuffer;
  115787. /** @hidden */
  115788. _releaseFramebufferObjects(texture: InternalTexture): void;
  115789. /** @hidden */
  115790. _releaseTexture(texture: InternalTexture): void;
  115791. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  115792. protected _setProgram(program: WebGLProgram): void;
  115793. protected _boundUniforms: {
  115794. [key: number]: WebGLUniformLocation;
  115795. };
  115796. /**
  115797. * Binds an effect to the webGL context
  115798. * @param effect defines the effect to bind
  115799. */
  115800. bindSamplers(effect: Effect): void;
  115801. private _activateCurrentTexture;
  115802. /** @hidden */
  115803. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  115804. /** @hidden */
  115805. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  115806. /**
  115807. * Unbind all textures from the webGL context
  115808. */
  115809. unbindAllTextures(): void;
  115810. /**
  115811. * Sets a texture to the according uniform.
  115812. * @param channel The texture channel
  115813. * @param uniform The uniform to set
  115814. * @param texture The texture to apply
  115815. */
  115816. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  115817. private _bindSamplerUniformToChannel;
  115818. private _getTextureWrapMode;
  115819. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  115820. /**
  115821. * Sets an array of texture to the webGL context
  115822. * @param channel defines the channel where the texture array must be set
  115823. * @param uniform defines the associated uniform location
  115824. * @param textures defines the array of textures to bind
  115825. */
  115826. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  115827. /** @hidden */
  115828. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  115829. private _setTextureParameterFloat;
  115830. private _setTextureParameterInteger;
  115831. /**
  115832. * Unbind all vertex attributes from the webGL context
  115833. */
  115834. unbindAllAttributes(): void;
  115835. /**
  115836. * 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
  115837. */
  115838. releaseEffects(): void;
  115839. /**
  115840. * Dispose and release all associated resources
  115841. */
  115842. dispose(): void;
  115843. /**
  115844. * Attach a new callback raised when context lost event is fired
  115845. * @param callback defines the callback to call
  115846. */
  115847. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115848. /**
  115849. * Attach a new callback raised when context restored event is fired
  115850. * @param callback defines the callback to call
  115851. */
  115852. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115853. /**
  115854. * Get the current error code of the webGL context
  115855. * @returns the error code
  115856. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  115857. */
  115858. getError(): number;
  115859. private _canRenderToFloatFramebuffer;
  115860. private _canRenderToHalfFloatFramebuffer;
  115861. private _canRenderToFramebuffer;
  115862. /** @hidden */
  115863. _getWebGLTextureType(type: number): number;
  115864. /** @hidden */
  115865. _getInternalFormat(format: number): number;
  115866. /** @hidden */
  115867. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  115868. /** @hidden */
  115869. _getRGBAMultiSampleBufferFormat(type: number): number;
  115870. /** @hidden */
  115871. _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;
  115872. /**
  115873. * Loads a file from a url
  115874. * @param url url to load
  115875. * @param onSuccess callback called when the file successfully loads
  115876. * @param onProgress callback called while file is loading (if the server supports this mode)
  115877. * @param offlineProvider defines the offline provider for caching
  115878. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  115879. * @param onError callback called when the file fails to load
  115880. * @returns a file request object
  115881. * @hidden
  115882. */
  115883. 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;
  115884. /**
  115885. * Reads pixels from the current frame buffer. Please note that this function can be slow
  115886. * @param x defines the x coordinate of the rectangle where pixels must be read
  115887. * @param y defines the y coordinate of the rectangle where pixels must be read
  115888. * @param width defines the width of the rectangle where pixels must be read
  115889. * @param height defines the height of the rectangle where pixels must be read
  115890. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  115891. * @returns a Uint8Array containing RGBA colors
  115892. */
  115893. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  115894. private static _isSupported;
  115895. /**
  115896. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  115897. * @returns true if the engine can be created
  115898. * @ignorenaming
  115899. */
  115900. static isSupported(): boolean;
  115901. /**
  115902. * Find the next highest power of two.
  115903. * @param x Number to start search from.
  115904. * @return Next highest power of two.
  115905. */
  115906. static CeilingPOT(x: number): number;
  115907. /**
  115908. * Find the next lowest power of two.
  115909. * @param x Number to start search from.
  115910. * @return Next lowest power of two.
  115911. */
  115912. static FloorPOT(x: number): number;
  115913. /**
  115914. * Find the nearest power of two.
  115915. * @param x Number to start search from.
  115916. * @return Next nearest power of two.
  115917. */
  115918. static NearestPOT(x: number): number;
  115919. /**
  115920. * Get the closest exponent of two
  115921. * @param value defines the value to approximate
  115922. * @param max defines the maximum value to return
  115923. * @param mode defines how to define the closest value
  115924. * @returns closest exponent of two of the given value
  115925. */
  115926. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  115927. /**
  115928. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  115929. * @param func - the function to be called
  115930. * @param requester - the object that will request the next frame. Falls back to window.
  115931. * @returns frame number
  115932. */
  115933. static QueueNewFrame(func: () => void, requester?: any): number;
  115934. /**
  115935. * Gets host document
  115936. * @returns the host document object
  115937. */
  115938. getHostDocument(): Nullable<Document>;
  115939. }
  115940. }
  115941. declare module BABYLON {
  115942. /**
  115943. * Class representing spherical harmonics coefficients to the 3rd degree
  115944. */
  115945. export class SphericalHarmonics {
  115946. /**
  115947. * Defines whether or not the harmonics have been prescaled for rendering.
  115948. */
  115949. preScaled: boolean;
  115950. /**
  115951. * The l0,0 coefficients of the spherical harmonics
  115952. */
  115953. l00: Vector3;
  115954. /**
  115955. * The l1,-1 coefficients of the spherical harmonics
  115956. */
  115957. l1_1: Vector3;
  115958. /**
  115959. * The l1,0 coefficients of the spherical harmonics
  115960. */
  115961. l10: Vector3;
  115962. /**
  115963. * The l1,1 coefficients of the spherical harmonics
  115964. */
  115965. l11: Vector3;
  115966. /**
  115967. * The l2,-2 coefficients of the spherical harmonics
  115968. */
  115969. l2_2: Vector3;
  115970. /**
  115971. * The l2,-1 coefficients of the spherical harmonics
  115972. */
  115973. l2_1: Vector3;
  115974. /**
  115975. * The l2,0 coefficients of the spherical harmonics
  115976. */
  115977. l20: Vector3;
  115978. /**
  115979. * The l2,1 coefficients of the spherical harmonics
  115980. */
  115981. l21: Vector3;
  115982. /**
  115983. * The l2,2 coefficients of the spherical harmonics
  115984. */
  115985. l22: Vector3;
  115986. /**
  115987. * Adds a light to the spherical harmonics
  115988. * @param direction the direction of the light
  115989. * @param color the color of the light
  115990. * @param deltaSolidAngle the delta solid angle of the light
  115991. */
  115992. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  115993. /**
  115994. * Scales the spherical harmonics by the given amount
  115995. * @param scale the amount to scale
  115996. */
  115997. scaleInPlace(scale: number): void;
  115998. /**
  115999. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  116000. *
  116001. * ```
  116002. * E_lm = A_l * L_lm
  116003. * ```
  116004. *
  116005. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  116006. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  116007. * the scaling factors are given in equation 9.
  116008. */
  116009. convertIncidentRadianceToIrradiance(): void;
  116010. /**
  116011. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  116012. *
  116013. * ```
  116014. * L = (1/pi) * E * rho
  116015. * ```
  116016. *
  116017. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  116018. */
  116019. convertIrradianceToLambertianRadiance(): void;
  116020. /**
  116021. * Integrates the reconstruction coefficients directly in to the SH preventing further
  116022. * required operations at run time.
  116023. *
  116024. * This is simply done by scaling back the SH with Ylm constants parameter.
  116025. * The trigonometric part being applied by the shader at run time.
  116026. */
  116027. preScaleForRendering(): void;
  116028. /**
  116029. * Constructs a spherical harmonics from an array.
  116030. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  116031. * @returns the spherical harmonics
  116032. */
  116033. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  116034. /**
  116035. * Gets the spherical harmonics from polynomial
  116036. * @param polynomial the spherical polynomial
  116037. * @returns the spherical harmonics
  116038. */
  116039. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  116040. }
  116041. /**
  116042. * Class representing spherical polynomial coefficients to the 3rd degree
  116043. */
  116044. export class SphericalPolynomial {
  116045. private _harmonics;
  116046. /**
  116047. * The spherical harmonics used to create the polynomials.
  116048. */
  116049. get preScaledHarmonics(): SphericalHarmonics;
  116050. /**
  116051. * The x coefficients of the spherical polynomial
  116052. */
  116053. x: Vector3;
  116054. /**
  116055. * The y coefficients of the spherical polynomial
  116056. */
  116057. y: Vector3;
  116058. /**
  116059. * The z coefficients of the spherical polynomial
  116060. */
  116061. z: Vector3;
  116062. /**
  116063. * The xx coefficients of the spherical polynomial
  116064. */
  116065. xx: Vector3;
  116066. /**
  116067. * The yy coefficients of the spherical polynomial
  116068. */
  116069. yy: Vector3;
  116070. /**
  116071. * The zz coefficients of the spherical polynomial
  116072. */
  116073. zz: Vector3;
  116074. /**
  116075. * The xy coefficients of the spherical polynomial
  116076. */
  116077. xy: Vector3;
  116078. /**
  116079. * The yz coefficients of the spherical polynomial
  116080. */
  116081. yz: Vector3;
  116082. /**
  116083. * The zx coefficients of the spherical polynomial
  116084. */
  116085. zx: Vector3;
  116086. /**
  116087. * Adds an ambient color to the spherical polynomial
  116088. * @param color the color to add
  116089. */
  116090. addAmbient(color: Color3): void;
  116091. /**
  116092. * Scales the spherical polynomial by the given amount
  116093. * @param scale the amount to scale
  116094. */
  116095. scaleInPlace(scale: number): void;
  116096. /**
  116097. * Gets the spherical polynomial from harmonics
  116098. * @param harmonics the spherical harmonics
  116099. * @returns the spherical polynomial
  116100. */
  116101. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  116102. /**
  116103. * Constructs a spherical polynomial from an array.
  116104. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  116105. * @returns the spherical polynomial
  116106. */
  116107. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  116108. }
  116109. }
  116110. declare module BABYLON {
  116111. /**
  116112. * Defines the source of the internal texture
  116113. */
  116114. export enum InternalTextureSource {
  116115. /**
  116116. * The source of the texture data is unknown
  116117. */
  116118. Unknown = 0,
  116119. /**
  116120. * Texture data comes from an URL
  116121. */
  116122. Url = 1,
  116123. /**
  116124. * Texture data is only used for temporary storage
  116125. */
  116126. Temp = 2,
  116127. /**
  116128. * Texture data comes from raw data (ArrayBuffer)
  116129. */
  116130. Raw = 3,
  116131. /**
  116132. * Texture content is dynamic (video or dynamic texture)
  116133. */
  116134. Dynamic = 4,
  116135. /**
  116136. * Texture content is generated by rendering to it
  116137. */
  116138. RenderTarget = 5,
  116139. /**
  116140. * Texture content is part of a multi render target process
  116141. */
  116142. MultiRenderTarget = 6,
  116143. /**
  116144. * Texture data comes from a cube data file
  116145. */
  116146. Cube = 7,
  116147. /**
  116148. * Texture data comes from a raw cube data
  116149. */
  116150. CubeRaw = 8,
  116151. /**
  116152. * Texture data come from a prefiltered cube data file
  116153. */
  116154. CubePrefiltered = 9,
  116155. /**
  116156. * Texture content is raw 3D data
  116157. */
  116158. Raw3D = 10,
  116159. /**
  116160. * Texture content is raw 2D array data
  116161. */
  116162. Raw2DArray = 11,
  116163. /**
  116164. * Texture content is a depth texture
  116165. */
  116166. Depth = 12,
  116167. /**
  116168. * Texture data comes from a raw cube data encoded with RGBD
  116169. */
  116170. CubeRawRGBD = 13
  116171. }
  116172. /**
  116173. * Class used to store data associated with WebGL texture data for the engine
  116174. * This class should not be used directly
  116175. */
  116176. export class InternalTexture {
  116177. /** @hidden */
  116178. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  116179. /**
  116180. * Defines if the texture is ready
  116181. */
  116182. isReady: boolean;
  116183. /**
  116184. * Defines if the texture is a cube texture
  116185. */
  116186. isCube: boolean;
  116187. /**
  116188. * Defines if the texture contains 3D data
  116189. */
  116190. is3D: boolean;
  116191. /**
  116192. * Defines if the texture contains 2D array data
  116193. */
  116194. is2DArray: boolean;
  116195. /**
  116196. * Defines if the texture contains multiview data
  116197. */
  116198. isMultiview: boolean;
  116199. /**
  116200. * Gets the URL used to load this texture
  116201. */
  116202. url: string;
  116203. /**
  116204. * Gets the sampling mode of the texture
  116205. */
  116206. samplingMode: number;
  116207. /**
  116208. * Gets a boolean indicating if the texture needs mipmaps generation
  116209. */
  116210. generateMipMaps: boolean;
  116211. /**
  116212. * Gets the number of samples used by the texture (WebGL2+ only)
  116213. */
  116214. samples: number;
  116215. /**
  116216. * Gets the type of the texture (int, float...)
  116217. */
  116218. type: number;
  116219. /**
  116220. * Gets the format of the texture (RGB, RGBA...)
  116221. */
  116222. format: number;
  116223. /**
  116224. * Observable called when the texture is loaded
  116225. */
  116226. onLoadedObservable: Observable<InternalTexture>;
  116227. /**
  116228. * Gets the width of the texture
  116229. */
  116230. width: number;
  116231. /**
  116232. * Gets the height of the texture
  116233. */
  116234. height: number;
  116235. /**
  116236. * Gets the depth of the texture
  116237. */
  116238. depth: number;
  116239. /**
  116240. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  116241. */
  116242. baseWidth: number;
  116243. /**
  116244. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  116245. */
  116246. baseHeight: number;
  116247. /**
  116248. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  116249. */
  116250. baseDepth: number;
  116251. /**
  116252. * Gets a boolean indicating if the texture is inverted on Y axis
  116253. */
  116254. invertY: boolean;
  116255. /** @hidden */
  116256. _invertVScale: boolean;
  116257. /** @hidden */
  116258. _associatedChannel: number;
  116259. /** @hidden */
  116260. _source: InternalTextureSource;
  116261. /** @hidden */
  116262. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  116263. /** @hidden */
  116264. _bufferView: Nullable<ArrayBufferView>;
  116265. /** @hidden */
  116266. _bufferViewArray: Nullable<ArrayBufferView[]>;
  116267. /** @hidden */
  116268. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  116269. /** @hidden */
  116270. _size: number;
  116271. /** @hidden */
  116272. _extension: string;
  116273. /** @hidden */
  116274. _files: Nullable<string[]>;
  116275. /** @hidden */
  116276. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  116277. /** @hidden */
  116278. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  116279. /** @hidden */
  116280. _framebuffer: Nullable<WebGLFramebuffer>;
  116281. /** @hidden */
  116282. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  116283. /** @hidden */
  116284. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  116285. /** @hidden */
  116286. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  116287. /** @hidden */
  116288. _attachments: Nullable<number[]>;
  116289. /** @hidden */
  116290. _textureArray: Nullable<InternalTexture[]>;
  116291. /** @hidden */
  116292. _cachedCoordinatesMode: Nullable<number>;
  116293. /** @hidden */
  116294. _cachedWrapU: Nullable<number>;
  116295. /** @hidden */
  116296. _cachedWrapV: Nullable<number>;
  116297. /** @hidden */
  116298. _cachedWrapR: Nullable<number>;
  116299. /** @hidden */
  116300. _cachedAnisotropicFilteringLevel: Nullable<number>;
  116301. /** @hidden */
  116302. _isDisabled: boolean;
  116303. /** @hidden */
  116304. _compression: Nullable<string>;
  116305. /** @hidden */
  116306. _generateStencilBuffer: boolean;
  116307. /** @hidden */
  116308. _generateDepthBuffer: boolean;
  116309. /** @hidden */
  116310. _comparisonFunction: number;
  116311. /** @hidden */
  116312. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  116313. /** @hidden */
  116314. _lodGenerationScale: number;
  116315. /** @hidden */
  116316. _lodGenerationOffset: number;
  116317. /** @hidden */
  116318. _depthStencilTexture: Nullable<InternalTexture>;
  116319. /** @hidden */
  116320. _colorTextureArray: Nullable<WebGLTexture>;
  116321. /** @hidden */
  116322. _depthStencilTextureArray: Nullable<WebGLTexture>;
  116323. /** @hidden */
  116324. _lodTextureHigh: Nullable<BaseTexture>;
  116325. /** @hidden */
  116326. _lodTextureMid: Nullable<BaseTexture>;
  116327. /** @hidden */
  116328. _lodTextureLow: Nullable<BaseTexture>;
  116329. /** @hidden */
  116330. _isRGBD: boolean;
  116331. /** @hidden */
  116332. _linearSpecularLOD: boolean;
  116333. /** @hidden */
  116334. _irradianceTexture: Nullable<BaseTexture>;
  116335. /** @hidden */
  116336. _webGLTexture: Nullable<WebGLTexture>;
  116337. /** @hidden */
  116338. _references: number;
  116339. private _engine;
  116340. /**
  116341. * Gets the Engine the texture belongs to.
  116342. * @returns The babylon engine
  116343. */
  116344. getEngine(): ThinEngine;
  116345. /**
  116346. * Gets the data source type of the texture
  116347. */
  116348. get source(): InternalTextureSource;
  116349. /**
  116350. * Creates a new InternalTexture
  116351. * @param engine defines the engine to use
  116352. * @param source defines the type of data that will be used
  116353. * @param delayAllocation if the texture allocation should be delayed (default: false)
  116354. */
  116355. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  116356. /**
  116357. * Increments the number of references (ie. the number of Texture that point to it)
  116358. */
  116359. incrementReferences(): void;
  116360. /**
  116361. * Change the size of the texture (not the size of the content)
  116362. * @param width defines the new width
  116363. * @param height defines the new height
  116364. * @param depth defines the new depth (1 by default)
  116365. */
  116366. updateSize(width: int, height: int, depth?: int): void;
  116367. /** @hidden */
  116368. _rebuild(): void;
  116369. /** @hidden */
  116370. _swapAndDie(target: InternalTexture): void;
  116371. /**
  116372. * Dispose the current allocated resources
  116373. */
  116374. dispose(): void;
  116375. }
  116376. }
  116377. declare module BABYLON {
  116378. /**
  116379. * Class used to work with sound analyzer using fast fourier transform (FFT)
  116380. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116381. */
  116382. export class Analyser {
  116383. /**
  116384. * Gets or sets the smoothing
  116385. * @ignorenaming
  116386. */
  116387. SMOOTHING: number;
  116388. /**
  116389. * Gets or sets the FFT table size
  116390. * @ignorenaming
  116391. */
  116392. FFT_SIZE: number;
  116393. /**
  116394. * Gets or sets the bar graph amplitude
  116395. * @ignorenaming
  116396. */
  116397. BARGRAPHAMPLITUDE: number;
  116398. /**
  116399. * Gets or sets the position of the debug canvas
  116400. * @ignorenaming
  116401. */
  116402. DEBUGCANVASPOS: {
  116403. x: number;
  116404. y: number;
  116405. };
  116406. /**
  116407. * Gets or sets the debug canvas size
  116408. * @ignorenaming
  116409. */
  116410. DEBUGCANVASSIZE: {
  116411. width: number;
  116412. height: number;
  116413. };
  116414. private _byteFreqs;
  116415. private _byteTime;
  116416. private _floatFreqs;
  116417. private _webAudioAnalyser;
  116418. private _debugCanvas;
  116419. private _debugCanvasContext;
  116420. private _scene;
  116421. private _registerFunc;
  116422. private _audioEngine;
  116423. /**
  116424. * Creates a new analyser
  116425. * @param scene defines hosting scene
  116426. */
  116427. constructor(scene: Scene);
  116428. /**
  116429. * Get the number of data values you will have to play with for the visualization
  116430. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  116431. * @returns a number
  116432. */
  116433. getFrequencyBinCount(): number;
  116434. /**
  116435. * Gets the current frequency data as a byte array
  116436. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116437. * @returns a Uint8Array
  116438. */
  116439. getByteFrequencyData(): Uint8Array;
  116440. /**
  116441. * Gets the current waveform as a byte array
  116442. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  116443. * @returns a Uint8Array
  116444. */
  116445. getByteTimeDomainData(): Uint8Array;
  116446. /**
  116447. * Gets the current frequency data as a float array
  116448. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116449. * @returns a Float32Array
  116450. */
  116451. getFloatFrequencyData(): Float32Array;
  116452. /**
  116453. * Renders the debug canvas
  116454. */
  116455. drawDebugCanvas(): void;
  116456. /**
  116457. * Stops rendering the debug canvas and removes it
  116458. */
  116459. stopDebugCanvas(): void;
  116460. /**
  116461. * Connects two audio nodes
  116462. * @param inputAudioNode defines first node to connect
  116463. * @param outputAudioNode defines second node to connect
  116464. */
  116465. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  116466. /**
  116467. * Releases all associated resources
  116468. */
  116469. dispose(): void;
  116470. }
  116471. }
  116472. declare module BABYLON {
  116473. /**
  116474. * This represents an audio engine and it is responsible
  116475. * to play, synchronize and analyse sounds throughout the application.
  116476. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116477. */
  116478. export interface IAudioEngine extends IDisposable {
  116479. /**
  116480. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116481. */
  116482. readonly canUseWebAudio: boolean;
  116483. /**
  116484. * Gets the current AudioContext if available.
  116485. */
  116486. readonly audioContext: Nullable<AudioContext>;
  116487. /**
  116488. * The master gain node defines the global audio volume of your audio engine.
  116489. */
  116490. readonly masterGain: GainNode;
  116491. /**
  116492. * Gets whether or not mp3 are supported by your browser.
  116493. */
  116494. readonly isMP3supported: boolean;
  116495. /**
  116496. * Gets whether or not ogg are supported by your browser.
  116497. */
  116498. readonly isOGGsupported: boolean;
  116499. /**
  116500. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116501. * @ignoreNaming
  116502. */
  116503. WarnedWebAudioUnsupported: boolean;
  116504. /**
  116505. * Defines if the audio engine relies on a custom unlocked button.
  116506. * In this case, the embedded button will not be displayed.
  116507. */
  116508. useCustomUnlockedButton: boolean;
  116509. /**
  116510. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  116511. */
  116512. readonly unlocked: boolean;
  116513. /**
  116514. * Event raised when audio has been unlocked on the browser.
  116515. */
  116516. onAudioUnlockedObservable: Observable<AudioEngine>;
  116517. /**
  116518. * Event raised when audio has been locked on the browser.
  116519. */
  116520. onAudioLockedObservable: Observable<AudioEngine>;
  116521. /**
  116522. * Flags the audio engine in Locked state.
  116523. * This happens due to new browser policies preventing audio to autoplay.
  116524. */
  116525. lock(): void;
  116526. /**
  116527. * Unlocks the audio engine once a user action has been done on the dom.
  116528. * This is helpful to resume play once browser policies have been satisfied.
  116529. */
  116530. unlock(): void;
  116531. /**
  116532. * Gets the global volume sets on the master gain.
  116533. * @returns the global volume if set or -1 otherwise
  116534. */
  116535. getGlobalVolume(): number;
  116536. /**
  116537. * Sets the global volume of your experience (sets on the master gain).
  116538. * @param newVolume Defines the new global volume of the application
  116539. */
  116540. setGlobalVolume(newVolume: number): void;
  116541. /**
  116542. * Connect the audio engine to an audio analyser allowing some amazing
  116543. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116544. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116545. * @param analyser The analyser to connect to the engine
  116546. */
  116547. connectToAnalyser(analyser: Analyser): void;
  116548. }
  116549. /**
  116550. * This represents the default audio engine used in babylon.
  116551. * It is responsible to play, synchronize and analyse sounds throughout the application.
  116552. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116553. */
  116554. export class AudioEngine implements IAudioEngine {
  116555. private _audioContext;
  116556. private _audioContextInitialized;
  116557. private _muteButton;
  116558. private _hostElement;
  116559. /**
  116560. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116561. */
  116562. canUseWebAudio: boolean;
  116563. /**
  116564. * The master gain node defines the global audio volume of your audio engine.
  116565. */
  116566. masterGain: GainNode;
  116567. /**
  116568. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116569. * @ignoreNaming
  116570. */
  116571. WarnedWebAudioUnsupported: boolean;
  116572. /**
  116573. * Gets whether or not mp3 are supported by your browser.
  116574. */
  116575. isMP3supported: boolean;
  116576. /**
  116577. * Gets whether or not ogg are supported by your browser.
  116578. */
  116579. isOGGsupported: boolean;
  116580. /**
  116581. * Gets whether audio has been unlocked on the device.
  116582. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  116583. * a user interaction has happened.
  116584. */
  116585. unlocked: boolean;
  116586. /**
  116587. * Defines if the audio engine relies on a custom unlocked button.
  116588. * In this case, the embedded button will not be displayed.
  116589. */
  116590. useCustomUnlockedButton: boolean;
  116591. /**
  116592. * Event raised when audio has been unlocked on the browser.
  116593. */
  116594. onAudioUnlockedObservable: Observable<AudioEngine>;
  116595. /**
  116596. * Event raised when audio has been locked on the browser.
  116597. */
  116598. onAudioLockedObservable: Observable<AudioEngine>;
  116599. /**
  116600. * Gets the current AudioContext if available.
  116601. */
  116602. get audioContext(): Nullable<AudioContext>;
  116603. private _connectedAnalyser;
  116604. /**
  116605. * Instantiates a new audio engine.
  116606. *
  116607. * There should be only one per page as some browsers restrict the number
  116608. * of audio contexts you can create.
  116609. * @param hostElement defines the host element where to display the mute icon if necessary
  116610. */
  116611. constructor(hostElement?: Nullable<HTMLElement>);
  116612. /**
  116613. * Flags the audio engine in Locked state.
  116614. * This happens due to new browser policies preventing audio to autoplay.
  116615. */
  116616. lock(): void;
  116617. /**
  116618. * Unlocks the audio engine once a user action has been done on the dom.
  116619. * This is helpful to resume play once browser policies have been satisfied.
  116620. */
  116621. unlock(): void;
  116622. private _resumeAudioContext;
  116623. private _initializeAudioContext;
  116624. private _tryToRun;
  116625. private _triggerRunningState;
  116626. private _triggerSuspendedState;
  116627. private _displayMuteButton;
  116628. private _moveButtonToTopLeft;
  116629. private _onResize;
  116630. private _hideMuteButton;
  116631. /**
  116632. * Destroy and release the resources associated with the audio ccontext.
  116633. */
  116634. dispose(): void;
  116635. /**
  116636. * Gets the global volume sets on the master gain.
  116637. * @returns the global volume if set or -1 otherwise
  116638. */
  116639. getGlobalVolume(): number;
  116640. /**
  116641. * Sets the global volume of your experience (sets on the master gain).
  116642. * @param newVolume Defines the new global volume of the application
  116643. */
  116644. setGlobalVolume(newVolume: number): void;
  116645. /**
  116646. * Connect the audio engine to an audio analyser allowing some amazing
  116647. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116648. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116649. * @param analyser The analyser to connect to the engine
  116650. */
  116651. connectToAnalyser(analyser: Analyser): void;
  116652. }
  116653. }
  116654. declare module BABYLON {
  116655. /**
  116656. * Interface used to present a loading screen while loading a scene
  116657. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116658. */
  116659. export interface ILoadingScreen {
  116660. /**
  116661. * Function called to display the loading screen
  116662. */
  116663. displayLoadingUI: () => void;
  116664. /**
  116665. * Function called to hide the loading screen
  116666. */
  116667. hideLoadingUI: () => void;
  116668. /**
  116669. * Gets or sets the color to use for the background
  116670. */
  116671. loadingUIBackgroundColor: string;
  116672. /**
  116673. * Gets or sets the text to display while loading
  116674. */
  116675. loadingUIText: string;
  116676. }
  116677. /**
  116678. * Class used for the default loading screen
  116679. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116680. */
  116681. export class DefaultLoadingScreen implements ILoadingScreen {
  116682. private _renderingCanvas;
  116683. private _loadingText;
  116684. private _loadingDivBackgroundColor;
  116685. private _loadingDiv;
  116686. private _loadingTextDiv;
  116687. /** Gets or sets the logo url to use for the default loading screen */
  116688. static DefaultLogoUrl: string;
  116689. /** Gets or sets the spinner url to use for the default loading screen */
  116690. static DefaultSpinnerUrl: string;
  116691. /**
  116692. * Creates a new default loading screen
  116693. * @param _renderingCanvas defines the canvas used to render the scene
  116694. * @param _loadingText defines the default text to display
  116695. * @param _loadingDivBackgroundColor defines the default background color
  116696. */
  116697. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  116698. /**
  116699. * Function called to display the loading screen
  116700. */
  116701. displayLoadingUI(): void;
  116702. /**
  116703. * Function called to hide the loading screen
  116704. */
  116705. hideLoadingUI(): void;
  116706. /**
  116707. * Gets or sets the text to display while loading
  116708. */
  116709. set loadingUIText(text: string);
  116710. get loadingUIText(): string;
  116711. /**
  116712. * Gets or sets the color to use for the background
  116713. */
  116714. get loadingUIBackgroundColor(): string;
  116715. set loadingUIBackgroundColor(color: string);
  116716. private _resizeLoadingUI;
  116717. }
  116718. }
  116719. declare module BABYLON {
  116720. /**
  116721. * Interface for any object that can request an animation frame
  116722. */
  116723. export interface ICustomAnimationFrameRequester {
  116724. /**
  116725. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  116726. */
  116727. renderFunction?: Function;
  116728. /**
  116729. * Called to request the next frame to render to
  116730. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  116731. */
  116732. requestAnimationFrame: Function;
  116733. /**
  116734. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  116735. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  116736. */
  116737. requestID?: number;
  116738. }
  116739. }
  116740. declare module BABYLON {
  116741. /**
  116742. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  116743. */
  116744. export class PerformanceMonitor {
  116745. private _enabled;
  116746. private _rollingFrameTime;
  116747. private _lastFrameTimeMs;
  116748. /**
  116749. * constructor
  116750. * @param frameSampleSize The number of samples required to saturate the sliding window
  116751. */
  116752. constructor(frameSampleSize?: number);
  116753. /**
  116754. * Samples current frame
  116755. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  116756. */
  116757. sampleFrame(timeMs?: number): void;
  116758. /**
  116759. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116760. */
  116761. get averageFrameTime(): number;
  116762. /**
  116763. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116764. */
  116765. get averageFrameTimeVariance(): number;
  116766. /**
  116767. * Returns the frame time of the most recent frame
  116768. */
  116769. get instantaneousFrameTime(): number;
  116770. /**
  116771. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  116772. */
  116773. get averageFPS(): number;
  116774. /**
  116775. * Returns the average framerate in frames per second using the most recent frame time
  116776. */
  116777. get instantaneousFPS(): number;
  116778. /**
  116779. * Returns true if enough samples have been taken to completely fill the sliding window
  116780. */
  116781. get isSaturated(): boolean;
  116782. /**
  116783. * Enables contributions to the sliding window sample set
  116784. */
  116785. enable(): void;
  116786. /**
  116787. * Disables contributions to the sliding window sample set
  116788. * Samples will not be interpolated over the disabled period
  116789. */
  116790. disable(): void;
  116791. /**
  116792. * Returns true if sampling is enabled
  116793. */
  116794. get isEnabled(): boolean;
  116795. /**
  116796. * Resets performance monitor
  116797. */
  116798. reset(): void;
  116799. }
  116800. /**
  116801. * RollingAverage
  116802. *
  116803. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  116804. */
  116805. export class RollingAverage {
  116806. /**
  116807. * Current average
  116808. */
  116809. average: number;
  116810. /**
  116811. * Current variance
  116812. */
  116813. variance: number;
  116814. protected _samples: Array<number>;
  116815. protected _sampleCount: number;
  116816. protected _pos: number;
  116817. protected _m2: number;
  116818. /**
  116819. * constructor
  116820. * @param length The number of samples required to saturate the sliding window
  116821. */
  116822. constructor(length: number);
  116823. /**
  116824. * Adds a sample to the sample set
  116825. * @param v The sample value
  116826. */
  116827. add(v: number): void;
  116828. /**
  116829. * Returns previously added values or null if outside of history or outside the sliding window domain
  116830. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  116831. * @return Value previously recorded with add() or null if outside of range
  116832. */
  116833. history(i: number): number;
  116834. /**
  116835. * Returns true if enough samples have been taken to completely fill the sliding window
  116836. * @return true if sample-set saturated
  116837. */
  116838. isSaturated(): boolean;
  116839. /**
  116840. * Resets the rolling average (equivalent to 0 samples taken so far)
  116841. */
  116842. reset(): void;
  116843. /**
  116844. * Wraps a value around the sample range boundaries
  116845. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  116846. * @return Wrapped position in sample range
  116847. */
  116848. protected _wrapPosition(i: number): number;
  116849. }
  116850. }
  116851. declare module BABYLON {
  116852. /**
  116853. * This class is used to track a performance counter which is number based.
  116854. * The user has access to many properties which give statistics of different nature.
  116855. *
  116856. * The implementer can track two kinds of Performance Counter: time and count.
  116857. * 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.
  116858. * 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.
  116859. */
  116860. export class PerfCounter {
  116861. /**
  116862. * Gets or sets a global boolean to turn on and off all the counters
  116863. */
  116864. static Enabled: boolean;
  116865. /**
  116866. * Returns the smallest value ever
  116867. */
  116868. get min(): number;
  116869. /**
  116870. * Returns the biggest value ever
  116871. */
  116872. get max(): number;
  116873. /**
  116874. * Returns the average value since the performance counter is running
  116875. */
  116876. get average(): number;
  116877. /**
  116878. * Returns the average value of the last second the counter was monitored
  116879. */
  116880. get lastSecAverage(): number;
  116881. /**
  116882. * Returns the current value
  116883. */
  116884. get current(): number;
  116885. /**
  116886. * Gets the accumulated total
  116887. */
  116888. get total(): number;
  116889. /**
  116890. * Gets the total value count
  116891. */
  116892. get count(): number;
  116893. /**
  116894. * Creates a new counter
  116895. */
  116896. constructor();
  116897. /**
  116898. * Call this method to start monitoring a new frame.
  116899. * 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.
  116900. */
  116901. fetchNewFrame(): void;
  116902. /**
  116903. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  116904. * @param newCount the count value to add to the monitored count
  116905. * @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.
  116906. */
  116907. addCount(newCount: number, fetchResult: boolean): void;
  116908. /**
  116909. * Start monitoring this performance counter
  116910. */
  116911. beginMonitoring(): void;
  116912. /**
  116913. * Compute the time lapsed since the previous beginMonitoring() call.
  116914. * @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
  116915. */
  116916. endMonitoring(newFrame?: boolean): void;
  116917. private _fetchResult;
  116918. private _startMonitoringTime;
  116919. private _min;
  116920. private _max;
  116921. private _average;
  116922. private _current;
  116923. private _totalValueCount;
  116924. private _totalAccumulated;
  116925. private _lastSecAverage;
  116926. private _lastSecAccumulated;
  116927. private _lastSecTime;
  116928. private _lastSecValueCount;
  116929. }
  116930. }
  116931. declare module BABYLON {
  116932. interface ThinEngine {
  116933. /** @hidden */
  116934. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  116935. }
  116936. }
  116937. declare module BABYLON {
  116938. /**
  116939. * Defines the interface used by display changed events
  116940. */
  116941. export interface IDisplayChangedEventArgs {
  116942. /** Gets the vrDisplay object (if any) */
  116943. vrDisplay: Nullable<any>;
  116944. /** Gets a boolean indicating if webVR is supported */
  116945. vrSupported: boolean;
  116946. }
  116947. /**
  116948. * Defines the interface used by objects containing a viewport (like a camera)
  116949. */
  116950. interface IViewportOwnerLike {
  116951. /**
  116952. * Gets or sets the viewport
  116953. */
  116954. viewport: IViewportLike;
  116955. }
  116956. /**
  116957. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  116958. */
  116959. export class Engine extends ThinEngine {
  116960. /** Defines that alpha blending is disabled */
  116961. static readonly ALPHA_DISABLE: number;
  116962. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  116963. static readonly ALPHA_ADD: number;
  116964. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  116965. static readonly ALPHA_COMBINE: number;
  116966. /** Defines that alpha blending to DEST - SRC * DEST */
  116967. static readonly ALPHA_SUBTRACT: number;
  116968. /** Defines that alpha blending to SRC * DEST */
  116969. static readonly ALPHA_MULTIPLY: number;
  116970. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  116971. static readonly ALPHA_MAXIMIZED: number;
  116972. /** Defines that alpha blending to SRC + DEST */
  116973. static readonly ALPHA_ONEONE: number;
  116974. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  116975. static readonly ALPHA_PREMULTIPLIED: number;
  116976. /**
  116977. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  116978. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  116979. */
  116980. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  116981. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  116982. static readonly ALPHA_INTERPOLATE: number;
  116983. /**
  116984. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  116985. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  116986. */
  116987. static readonly ALPHA_SCREENMODE: number;
  116988. /** Defines that the ressource is not delayed*/
  116989. static readonly DELAYLOADSTATE_NONE: number;
  116990. /** Defines that the ressource was successfully delay loaded */
  116991. static readonly DELAYLOADSTATE_LOADED: number;
  116992. /** Defines that the ressource is currently delay loading */
  116993. static readonly DELAYLOADSTATE_LOADING: number;
  116994. /** Defines that the ressource is delayed and has not started loading */
  116995. static readonly DELAYLOADSTATE_NOTLOADED: number;
  116996. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  116997. static readonly NEVER: number;
  116998. /** 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 */
  116999. static readonly ALWAYS: number;
  117000. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  117001. static readonly LESS: number;
  117002. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  117003. static readonly EQUAL: number;
  117004. /** 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 */
  117005. static readonly LEQUAL: number;
  117006. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  117007. static readonly GREATER: number;
  117008. /** 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 */
  117009. static readonly GEQUAL: number;
  117010. /** 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 */
  117011. static readonly NOTEQUAL: number;
  117012. /** Passed to stencilOperation to specify that stencil value must be kept */
  117013. static readonly KEEP: number;
  117014. /** Passed to stencilOperation to specify that stencil value must be replaced */
  117015. static readonly REPLACE: number;
  117016. /** Passed to stencilOperation to specify that stencil value must be incremented */
  117017. static readonly INCR: number;
  117018. /** Passed to stencilOperation to specify that stencil value must be decremented */
  117019. static readonly DECR: number;
  117020. /** Passed to stencilOperation to specify that stencil value must be inverted */
  117021. static readonly INVERT: number;
  117022. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  117023. static readonly INCR_WRAP: number;
  117024. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  117025. static readonly DECR_WRAP: number;
  117026. /** Texture is not repeating outside of 0..1 UVs */
  117027. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  117028. /** Texture is repeating outside of 0..1 UVs */
  117029. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  117030. /** Texture is repeating and mirrored */
  117031. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  117032. /** ALPHA */
  117033. static readonly TEXTUREFORMAT_ALPHA: number;
  117034. /** LUMINANCE */
  117035. static readonly TEXTUREFORMAT_LUMINANCE: number;
  117036. /** LUMINANCE_ALPHA */
  117037. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  117038. /** RGB */
  117039. static readonly TEXTUREFORMAT_RGB: number;
  117040. /** RGBA */
  117041. static readonly TEXTUREFORMAT_RGBA: number;
  117042. /** RED */
  117043. static readonly TEXTUREFORMAT_RED: number;
  117044. /** RED (2nd reference) */
  117045. static readonly TEXTUREFORMAT_R: number;
  117046. /** RG */
  117047. static readonly TEXTUREFORMAT_RG: number;
  117048. /** RED_INTEGER */
  117049. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  117050. /** RED_INTEGER (2nd reference) */
  117051. static readonly TEXTUREFORMAT_R_INTEGER: number;
  117052. /** RG_INTEGER */
  117053. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  117054. /** RGB_INTEGER */
  117055. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  117056. /** RGBA_INTEGER */
  117057. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  117058. /** UNSIGNED_BYTE */
  117059. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  117060. /** UNSIGNED_BYTE (2nd reference) */
  117061. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  117062. /** FLOAT */
  117063. static readonly TEXTURETYPE_FLOAT: number;
  117064. /** HALF_FLOAT */
  117065. static readonly TEXTURETYPE_HALF_FLOAT: number;
  117066. /** BYTE */
  117067. static readonly TEXTURETYPE_BYTE: number;
  117068. /** SHORT */
  117069. static readonly TEXTURETYPE_SHORT: number;
  117070. /** UNSIGNED_SHORT */
  117071. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  117072. /** INT */
  117073. static readonly TEXTURETYPE_INT: number;
  117074. /** UNSIGNED_INT */
  117075. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  117076. /** UNSIGNED_SHORT_4_4_4_4 */
  117077. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  117078. /** UNSIGNED_SHORT_5_5_5_1 */
  117079. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  117080. /** UNSIGNED_SHORT_5_6_5 */
  117081. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  117082. /** UNSIGNED_INT_2_10_10_10_REV */
  117083. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  117084. /** UNSIGNED_INT_24_8 */
  117085. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  117086. /** UNSIGNED_INT_10F_11F_11F_REV */
  117087. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  117088. /** UNSIGNED_INT_5_9_9_9_REV */
  117089. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  117090. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  117091. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  117092. /** nearest is mag = nearest and min = nearest and mip = linear */
  117093. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  117094. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117095. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  117096. /** Trilinear is mag = linear and min = linear and mip = linear */
  117097. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  117098. /** nearest is mag = nearest and min = nearest and mip = linear */
  117099. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  117100. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117101. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  117102. /** Trilinear is mag = linear and min = linear and mip = linear */
  117103. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  117104. /** mag = nearest and min = nearest and mip = nearest */
  117105. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  117106. /** mag = nearest and min = linear and mip = nearest */
  117107. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  117108. /** mag = nearest and min = linear and mip = linear */
  117109. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  117110. /** mag = nearest and min = linear and mip = none */
  117111. static readonly TEXTURE_NEAREST_LINEAR: number;
  117112. /** mag = nearest and min = nearest and mip = none */
  117113. static readonly TEXTURE_NEAREST_NEAREST: number;
  117114. /** mag = linear and min = nearest and mip = nearest */
  117115. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  117116. /** mag = linear and min = nearest and mip = linear */
  117117. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  117118. /** mag = linear and min = linear and mip = none */
  117119. static readonly TEXTURE_LINEAR_LINEAR: number;
  117120. /** mag = linear and min = nearest and mip = none */
  117121. static readonly TEXTURE_LINEAR_NEAREST: number;
  117122. /** Explicit coordinates mode */
  117123. static readonly TEXTURE_EXPLICIT_MODE: number;
  117124. /** Spherical coordinates mode */
  117125. static readonly TEXTURE_SPHERICAL_MODE: number;
  117126. /** Planar coordinates mode */
  117127. static readonly TEXTURE_PLANAR_MODE: number;
  117128. /** Cubic coordinates mode */
  117129. static readonly TEXTURE_CUBIC_MODE: number;
  117130. /** Projection coordinates mode */
  117131. static readonly TEXTURE_PROJECTION_MODE: number;
  117132. /** Skybox coordinates mode */
  117133. static readonly TEXTURE_SKYBOX_MODE: number;
  117134. /** Inverse Cubic coordinates mode */
  117135. static readonly TEXTURE_INVCUBIC_MODE: number;
  117136. /** Equirectangular coordinates mode */
  117137. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  117138. /** Equirectangular Fixed coordinates mode */
  117139. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  117140. /** Equirectangular Fixed Mirrored coordinates mode */
  117141. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  117142. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  117143. static readonly SCALEMODE_FLOOR: number;
  117144. /** Defines that texture rescaling will look for the nearest power of 2 size */
  117145. static readonly SCALEMODE_NEAREST: number;
  117146. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  117147. static readonly SCALEMODE_CEILING: number;
  117148. /**
  117149. * Returns the current npm package of the sdk
  117150. */
  117151. static get NpmPackage(): string;
  117152. /**
  117153. * Returns the current version of the framework
  117154. */
  117155. static get Version(): string;
  117156. /** Gets the list of created engines */
  117157. static get Instances(): Engine[];
  117158. /**
  117159. * Gets the latest created engine
  117160. */
  117161. static get LastCreatedEngine(): Nullable<Engine>;
  117162. /**
  117163. * Gets the latest created scene
  117164. */
  117165. static get LastCreatedScene(): Nullable<Scene>;
  117166. /**
  117167. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  117168. * @param flag defines which part of the materials must be marked as dirty
  117169. * @param predicate defines a predicate used to filter which materials should be affected
  117170. */
  117171. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  117172. /**
  117173. * Method called to create the default loading screen.
  117174. * This can be overriden in your own app.
  117175. * @param canvas The rendering canvas element
  117176. * @returns The loading screen
  117177. */
  117178. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  117179. /**
  117180. * Method called to create the default rescale post process on each engine.
  117181. */
  117182. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  117183. /**
  117184. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  117185. **/
  117186. enableOfflineSupport: boolean;
  117187. /**
  117188. * 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)
  117189. **/
  117190. disableManifestCheck: boolean;
  117191. /**
  117192. * Gets the list of created scenes
  117193. */
  117194. scenes: Scene[];
  117195. /**
  117196. * Event raised when a new scene is created
  117197. */
  117198. onNewSceneAddedObservable: Observable<Scene>;
  117199. /**
  117200. * Gets the list of created postprocesses
  117201. */
  117202. postProcesses: PostProcess[];
  117203. /**
  117204. * Gets a boolean indicating if the pointer is currently locked
  117205. */
  117206. isPointerLock: boolean;
  117207. /**
  117208. * Observable event triggered each time the rendering canvas is resized
  117209. */
  117210. onResizeObservable: Observable<Engine>;
  117211. /**
  117212. * Observable event triggered each time the canvas loses focus
  117213. */
  117214. onCanvasBlurObservable: Observable<Engine>;
  117215. /**
  117216. * Observable event triggered each time the canvas gains focus
  117217. */
  117218. onCanvasFocusObservable: Observable<Engine>;
  117219. /**
  117220. * Observable event triggered each time the canvas receives pointerout event
  117221. */
  117222. onCanvasPointerOutObservable: Observable<PointerEvent>;
  117223. /**
  117224. * Observable raised when the engine begins a new frame
  117225. */
  117226. onBeginFrameObservable: Observable<Engine>;
  117227. /**
  117228. * If set, will be used to request the next animation frame for the render loop
  117229. */
  117230. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  117231. /**
  117232. * Observable raised when the engine ends the current frame
  117233. */
  117234. onEndFrameObservable: Observable<Engine>;
  117235. /**
  117236. * Observable raised when the engine is about to compile a shader
  117237. */
  117238. onBeforeShaderCompilationObservable: Observable<Engine>;
  117239. /**
  117240. * Observable raised when the engine has jsut compiled a shader
  117241. */
  117242. onAfterShaderCompilationObservable: Observable<Engine>;
  117243. /**
  117244. * Gets the audio engine
  117245. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117246. * @ignorenaming
  117247. */
  117248. static audioEngine: IAudioEngine;
  117249. /**
  117250. * Default AudioEngine factory responsible of creating the Audio Engine.
  117251. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  117252. */
  117253. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  117254. /**
  117255. * Default offline support factory responsible of creating a tool used to store data locally.
  117256. * By default, this will create a Database object if the workload has been embedded.
  117257. */
  117258. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  117259. private _loadingScreen;
  117260. private _pointerLockRequested;
  117261. private _rescalePostProcess;
  117262. private _deterministicLockstep;
  117263. private _lockstepMaxSteps;
  117264. private _timeStep;
  117265. protected get _supportsHardwareTextureRescaling(): boolean;
  117266. private _fps;
  117267. private _deltaTime;
  117268. /** @hidden */
  117269. _drawCalls: PerfCounter;
  117270. /** 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 */
  117271. canvasTabIndex: number;
  117272. /**
  117273. * Turn this value on if you want to pause FPS computation when in background
  117274. */
  117275. disablePerformanceMonitorInBackground: boolean;
  117276. private _performanceMonitor;
  117277. /**
  117278. * Gets the performance monitor attached to this engine
  117279. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  117280. */
  117281. get performanceMonitor(): PerformanceMonitor;
  117282. private _onFocus;
  117283. private _onBlur;
  117284. private _onCanvasPointerOut;
  117285. private _onCanvasBlur;
  117286. private _onCanvasFocus;
  117287. private _onFullscreenChange;
  117288. private _onPointerLockChange;
  117289. /**
  117290. * Gets the HTML element used to attach event listeners
  117291. * @returns a HTML element
  117292. */
  117293. getInputElement(): Nullable<HTMLElement>;
  117294. /**
  117295. * Creates a new engine
  117296. * @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
  117297. * @param antialias defines enable antialiasing (default: false)
  117298. * @param options defines further options to be sent to the getContext() function
  117299. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  117300. */
  117301. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  117302. /**
  117303. * Gets current aspect ratio
  117304. * @param viewportOwner defines the camera to use to get the aspect ratio
  117305. * @param useScreen defines if screen size must be used (or the current render target if any)
  117306. * @returns a number defining the aspect ratio
  117307. */
  117308. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  117309. /**
  117310. * Gets current screen aspect ratio
  117311. * @returns a number defining the aspect ratio
  117312. */
  117313. getScreenAspectRatio(): number;
  117314. /**
  117315. * Gets the client rect of the HTML canvas attached with the current webGL context
  117316. * @returns a client rectanglee
  117317. */
  117318. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  117319. /**
  117320. * Gets the client rect of the HTML element used for events
  117321. * @returns a client rectanglee
  117322. */
  117323. getInputElementClientRect(): Nullable<ClientRect>;
  117324. /**
  117325. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  117326. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117327. * @returns true if engine is in deterministic lock step mode
  117328. */
  117329. isDeterministicLockStep(): boolean;
  117330. /**
  117331. * Gets the max steps when engine is running in deterministic lock step
  117332. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117333. * @returns the max steps
  117334. */
  117335. getLockstepMaxSteps(): number;
  117336. /**
  117337. * Returns the time in ms between steps when using deterministic lock step.
  117338. * @returns time step in (ms)
  117339. */
  117340. getTimeStep(): number;
  117341. /**
  117342. * Force the mipmap generation for the given render target texture
  117343. * @param texture defines the render target texture to use
  117344. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  117345. */
  117346. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  117347. /** States */
  117348. /**
  117349. * Set various states to the webGL context
  117350. * @param culling defines backface culling state
  117351. * @param zOffset defines the value to apply to zOffset (0 by default)
  117352. * @param force defines if states must be applied even if cache is up to date
  117353. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  117354. */
  117355. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  117356. /**
  117357. * Set the z offset to apply to current rendering
  117358. * @param value defines the offset to apply
  117359. */
  117360. setZOffset(value: number): void;
  117361. /**
  117362. * Gets the current value of the zOffset
  117363. * @returns the current zOffset state
  117364. */
  117365. getZOffset(): number;
  117366. /**
  117367. * Enable or disable depth buffering
  117368. * @param enable defines the state to set
  117369. */
  117370. setDepthBuffer(enable: boolean): void;
  117371. /**
  117372. * Gets a boolean indicating if depth writing is enabled
  117373. * @returns the current depth writing state
  117374. */
  117375. getDepthWrite(): boolean;
  117376. /**
  117377. * Enable or disable depth writing
  117378. * @param enable defines the state to set
  117379. */
  117380. setDepthWrite(enable: boolean): void;
  117381. /**
  117382. * Gets a boolean indicating if stencil buffer is enabled
  117383. * @returns the current stencil buffer state
  117384. */
  117385. getStencilBuffer(): boolean;
  117386. /**
  117387. * Enable or disable the stencil buffer
  117388. * @param enable defines if the stencil buffer must be enabled or disabled
  117389. */
  117390. setStencilBuffer(enable: boolean): void;
  117391. /**
  117392. * Gets the current stencil mask
  117393. * @returns a number defining the new stencil mask to use
  117394. */
  117395. getStencilMask(): number;
  117396. /**
  117397. * Sets the current stencil mask
  117398. * @param mask defines the new stencil mask to use
  117399. */
  117400. setStencilMask(mask: number): void;
  117401. /**
  117402. * Gets the current stencil function
  117403. * @returns a number defining the stencil function to use
  117404. */
  117405. getStencilFunction(): number;
  117406. /**
  117407. * Gets the current stencil reference value
  117408. * @returns a number defining the stencil reference value to use
  117409. */
  117410. getStencilFunctionReference(): number;
  117411. /**
  117412. * Gets the current stencil mask
  117413. * @returns a number defining the stencil mask to use
  117414. */
  117415. getStencilFunctionMask(): number;
  117416. /**
  117417. * Sets the current stencil function
  117418. * @param stencilFunc defines the new stencil function to use
  117419. */
  117420. setStencilFunction(stencilFunc: number): void;
  117421. /**
  117422. * Sets the current stencil reference
  117423. * @param reference defines the new stencil reference to use
  117424. */
  117425. setStencilFunctionReference(reference: number): void;
  117426. /**
  117427. * Sets the current stencil mask
  117428. * @param mask defines the new stencil mask to use
  117429. */
  117430. setStencilFunctionMask(mask: number): void;
  117431. /**
  117432. * Gets the current stencil operation when stencil fails
  117433. * @returns a number defining stencil operation to use when stencil fails
  117434. */
  117435. getStencilOperationFail(): number;
  117436. /**
  117437. * Gets the current stencil operation when depth fails
  117438. * @returns a number defining stencil operation to use when depth fails
  117439. */
  117440. getStencilOperationDepthFail(): number;
  117441. /**
  117442. * Gets the current stencil operation when stencil passes
  117443. * @returns a number defining stencil operation to use when stencil passes
  117444. */
  117445. getStencilOperationPass(): number;
  117446. /**
  117447. * Sets the stencil operation to use when stencil fails
  117448. * @param operation defines the stencil operation to use when stencil fails
  117449. */
  117450. setStencilOperationFail(operation: number): void;
  117451. /**
  117452. * Sets the stencil operation to use when depth fails
  117453. * @param operation defines the stencil operation to use when depth fails
  117454. */
  117455. setStencilOperationDepthFail(operation: number): void;
  117456. /**
  117457. * Sets the stencil operation to use when stencil passes
  117458. * @param operation defines the stencil operation to use when stencil passes
  117459. */
  117460. setStencilOperationPass(operation: number): void;
  117461. /**
  117462. * Sets a boolean indicating if the dithering state is enabled or disabled
  117463. * @param value defines the dithering state
  117464. */
  117465. setDitheringState(value: boolean): void;
  117466. /**
  117467. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  117468. * @param value defines the rasterizer state
  117469. */
  117470. setRasterizerState(value: boolean): void;
  117471. /**
  117472. * Gets the current depth function
  117473. * @returns a number defining the depth function
  117474. */
  117475. getDepthFunction(): Nullable<number>;
  117476. /**
  117477. * Sets the current depth function
  117478. * @param depthFunc defines the function to use
  117479. */
  117480. setDepthFunction(depthFunc: number): void;
  117481. /**
  117482. * Sets the current depth function to GREATER
  117483. */
  117484. setDepthFunctionToGreater(): void;
  117485. /**
  117486. * Sets the current depth function to GEQUAL
  117487. */
  117488. setDepthFunctionToGreaterOrEqual(): void;
  117489. /**
  117490. * Sets the current depth function to LESS
  117491. */
  117492. setDepthFunctionToLess(): void;
  117493. /**
  117494. * Sets the current depth function to LEQUAL
  117495. */
  117496. setDepthFunctionToLessOrEqual(): void;
  117497. private _cachedStencilBuffer;
  117498. private _cachedStencilFunction;
  117499. private _cachedStencilMask;
  117500. private _cachedStencilOperationPass;
  117501. private _cachedStencilOperationFail;
  117502. private _cachedStencilOperationDepthFail;
  117503. private _cachedStencilReference;
  117504. /**
  117505. * Caches the the state of the stencil buffer
  117506. */
  117507. cacheStencilState(): void;
  117508. /**
  117509. * Restores the state of the stencil buffer
  117510. */
  117511. restoreStencilState(): void;
  117512. /**
  117513. * Directly set the WebGL Viewport
  117514. * @param x defines the x coordinate of the viewport (in screen space)
  117515. * @param y defines the y coordinate of the viewport (in screen space)
  117516. * @param width defines the width of the viewport (in screen space)
  117517. * @param height defines the height of the viewport (in screen space)
  117518. * @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
  117519. */
  117520. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  117521. /**
  117522. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  117523. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117524. * @param y defines the y-coordinate of the corner of the clear rectangle
  117525. * @param width defines the width of the clear rectangle
  117526. * @param height defines the height of the clear rectangle
  117527. * @param clearColor defines the clear color
  117528. */
  117529. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  117530. /**
  117531. * Enable scissor test on a specific rectangle (ie. render will only be executed 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. */
  117537. enableScissor(x: number, y: number, width: number, height: number): void;
  117538. /**
  117539. * Disable previously set scissor test rectangle
  117540. */
  117541. disableScissor(): void;
  117542. protected _reportDrawCall(): void;
  117543. /**
  117544. * Initializes a webVR display and starts listening to display change events
  117545. * The onVRDisplayChangedObservable will be notified upon these changes
  117546. * @returns The onVRDisplayChangedObservable
  117547. */
  117548. initWebVR(): Observable<IDisplayChangedEventArgs>;
  117549. /** @hidden */
  117550. _prepareVRComponent(): void;
  117551. /** @hidden */
  117552. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  117553. /** @hidden */
  117554. _submitVRFrame(): void;
  117555. /**
  117556. * Call this function to leave webVR mode
  117557. * Will do nothing if webVR is not supported or if there is no webVR device
  117558. * @see https://doc.babylonjs.com/how_to/webvr_camera
  117559. */
  117560. disableVR(): void;
  117561. /**
  117562. * Gets a boolean indicating that the system is in VR mode and is presenting
  117563. * @returns true if VR mode is engaged
  117564. */
  117565. isVRPresenting(): boolean;
  117566. /** @hidden */
  117567. _requestVRFrame(): void;
  117568. /** @hidden */
  117569. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  117570. /**
  117571. * Gets the source code of the vertex shader associated with a specific webGL program
  117572. * @param program defines the program to use
  117573. * @returns a string containing the source code of the vertex shader associated with the program
  117574. */
  117575. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  117576. /**
  117577. * Gets the source code of the fragment shader associated with a specific webGL program
  117578. * @param program defines the program to use
  117579. * @returns a string containing the source code of the fragment shader associated with the program
  117580. */
  117581. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  117582. /**
  117583. * Sets a depth stencil texture from a render target to the according uniform.
  117584. * @param channel The texture channel
  117585. * @param uniform The uniform to set
  117586. * @param texture The render target texture containing the depth stencil texture to apply
  117587. */
  117588. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  117589. /**
  117590. * Sets a texture to the webGL context from a postprocess
  117591. * @param channel defines the channel to use
  117592. * @param postProcess defines the source postprocess
  117593. */
  117594. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  117595. /**
  117596. * Binds the output of the passed in post process to the texture channel specified
  117597. * @param channel The channel the texture should be bound to
  117598. * @param postProcess The post process which's output should be bound
  117599. */
  117600. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  117601. protected _rebuildBuffers(): void;
  117602. /** @hidden */
  117603. _renderFrame(): void;
  117604. _renderLoop(): void;
  117605. /** @hidden */
  117606. _renderViews(): boolean;
  117607. /**
  117608. * Toggle full screen mode
  117609. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117610. */
  117611. switchFullscreen(requestPointerLock: boolean): void;
  117612. /**
  117613. * Enters full screen mode
  117614. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117615. */
  117616. enterFullscreen(requestPointerLock: boolean): void;
  117617. /**
  117618. * Exits full screen mode
  117619. */
  117620. exitFullscreen(): void;
  117621. /**
  117622. * Enters Pointerlock mode
  117623. */
  117624. enterPointerlock(): void;
  117625. /**
  117626. * Exits Pointerlock mode
  117627. */
  117628. exitPointerlock(): void;
  117629. /**
  117630. * Begin a new frame
  117631. */
  117632. beginFrame(): void;
  117633. /**
  117634. * Enf the current frame
  117635. */
  117636. endFrame(): void;
  117637. resize(): void;
  117638. /**
  117639. * Force a specific size of the canvas
  117640. * @param width defines the new canvas' width
  117641. * @param height defines the new canvas' height
  117642. * @returns true if the size was changed
  117643. */
  117644. setSize(width: number, height: number): boolean;
  117645. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  117646. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117647. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117648. _releaseTexture(texture: InternalTexture): void;
  117649. /**
  117650. * @hidden
  117651. * Rescales a texture
  117652. * @param source input texutre
  117653. * @param destination destination texture
  117654. * @param scene scene to use to render the resize
  117655. * @param internalFormat format to use when resizing
  117656. * @param onComplete callback to be called when resize has completed
  117657. */
  117658. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  117659. /**
  117660. * Gets the current framerate
  117661. * @returns a number representing the framerate
  117662. */
  117663. getFps(): number;
  117664. /**
  117665. * Gets the time spent between current and previous frame
  117666. * @returns a number representing the delta time in ms
  117667. */
  117668. getDeltaTime(): number;
  117669. private _measureFps;
  117670. /** @hidden */
  117671. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  117672. /**
  117673. * Updates the sample count of a render target texture
  117674. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  117675. * @param texture defines the texture to update
  117676. * @param samples defines the sample count to set
  117677. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  117678. */
  117679. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  117680. /**
  117681. * Updates a depth texture Comparison Mode and Function.
  117682. * If the comparison Function is equal to 0, the mode will be set to none.
  117683. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  117684. * @param texture The texture to set the comparison function for
  117685. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  117686. */
  117687. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  117688. /**
  117689. * Creates a webGL buffer to use with instanciation
  117690. * @param capacity defines the size of the buffer
  117691. * @returns the webGL buffer
  117692. */
  117693. createInstancesBuffer(capacity: number): DataBuffer;
  117694. /**
  117695. * Delete a webGL buffer used with instanciation
  117696. * @param buffer defines the webGL buffer to delete
  117697. */
  117698. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  117699. private _clientWaitAsync;
  117700. /** @hidden */
  117701. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  117702. dispose(): void;
  117703. private _disableTouchAction;
  117704. /**
  117705. * Display the loading screen
  117706. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117707. */
  117708. displayLoadingUI(): void;
  117709. /**
  117710. * Hide the loading screen
  117711. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117712. */
  117713. hideLoadingUI(): void;
  117714. /**
  117715. * Gets the current loading screen object
  117716. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117717. */
  117718. get loadingScreen(): ILoadingScreen;
  117719. /**
  117720. * Sets the current loading screen object
  117721. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117722. */
  117723. set loadingScreen(loadingScreen: ILoadingScreen);
  117724. /**
  117725. * Sets the current loading screen text
  117726. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117727. */
  117728. set loadingUIText(text: string);
  117729. /**
  117730. * Sets the current loading screen background color
  117731. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117732. */
  117733. set loadingUIBackgroundColor(color: string);
  117734. /** Pointerlock and fullscreen */
  117735. /**
  117736. * Ask the browser to promote the current element to pointerlock mode
  117737. * @param element defines the DOM element to promote
  117738. */
  117739. static _RequestPointerlock(element: HTMLElement): void;
  117740. /**
  117741. * Asks the browser to exit pointerlock mode
  117742. */
  117743. static _ExitPointerlock(): void;
  117744. /**
  117745. * Ask the browser to promote the current element to fullscreen rendering mode
  117746. * @param element defines the DOM element to promote
  117747. */
  117748. static _RequestFullscreen(element: HTMLElement): void;
  117749. /**
  117750. * Asks the browser to exit fullscreen mode
  117751. */
  117752. static _ExitFullscreen(): void;
  117753. }
  117754. }
  117755. declare module BABYLON {
  117756. /**
  117757. * The engine store class is responsible to hold all the instances of Engine and Scene created
  117758. * during the life time of the application.
  117759. */
  117760. export class EngineStore {
  117761. /** Gets the list of created engines */
  117762. static Instances: Engine[];
  117763. /** @hidden */
  117764. static _LastCreatedScene: Nullable<Scene>;
  117765. /**
  117766. * Gets the latest created engine
  117767. */
  117768. static get LastCreatedEngine(): Nullable<Engine>;
  117769. /**
  117770. * Gets the latest created scene
  117771. */
  117772. static get LastCreatedScene(): Nullable<Scene>;
  117773. /**
  117774. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117775. * @ignorenaming
  117776. */
  117777. static UseFallbackTexture: boolean;
  117778. /**
  117779. * Texture content used if a texture cannot loaded
  117780. * @ignorenaming
  117781. */
  117782. static FallbackTexture: string;
  117783. }
  117784. }
  117785. declare module BABYLON {
  117786. /**
  117787. * Helper class that provides a small promise polyfill
  117788. */
  117789. export class PromisePolyfill {
  117790. /**
  117791. * Static function used to check if the polyfill is required
  117792. * If this is the case then the function will inject the polyfill to window.Promise
  117793. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  117794. */
  117795. static Apply(force?: boolean): void;
  117796. }
  117797. }
  117798. declare module BABYLON {
  117799. /**
  117800. * Interface for screenshot methods with describe argument called `size` as object with options
  117801. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  117802. */
  117803. export interface IScreenshotSize {
  117804. /**
  117805. * number in pixels for canvas height
  117806. */
  117807. height?: number;
  117808. /**
  117809. * multiplier allowing render at a higher or lower resolution
  117810. * If value is defined then height and width will be ignored and taken from camera
  117811. */
  117812. precision?: number;
  117813. /**
  117814. * number in pixels for canvas width
  117815. */
  117816. width?: number;
  117817. }
  117818. }
  117819. declare module BABYLON {
  117820. interface IColor4Like {
  117821. r: float;
  117822. g: float;
  117823. b: float;
  117824. a: float;
  117825. }
  117826. /**
  117827. * Class containing a set of static utilities functions
  117828. */
  117829. export class Tools {
  117830. /**
  117831. * Gets or sets the base URL to use to load assets
  117832. */
  117833. static get BaseUrl(): string;
  117834. static set BaseUrl(value: string);
  117835. /**
  117836. * Enable/Disable Custom HTTP Request Headers globally.
  117837. * default = false
  117838. * @see CustomRequestHeaders
  117839. */
  117840. static UseCustomRequestHeaders: boolean;
  117841. /**
  117842. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  117843. * i.e. when loading files, where the server/service expects an Authorization header
  117844. */
  117845. static CustomRequestHeaders: {
  117846. [key: string]: string;
  117847. };
  117848. /**
  117849. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  117850. */
  117851. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  117852. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  117853. /**
  117854. * Default behaviour for cors in the application.
  117855. * It can be a string if the expected behavior is identical in the entire app.
  117856. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  117857. */
  117858. static get CorsBehavior(): string | ((url: string | string[]) => string);
  117859. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  117860. /**
  117861. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117862. * @ignorenaming
  117863. */
  117864. static get UseFallbackTexture(): boolean;
  117865. static set UseFallbackTexture(value: boolean);
  117866. /**
  117867. * Use this object to register external classes like custom textures or material
  117868. * to allow the laoders to instantiate them
  117869. */
  117870. static get RegisteredExternalClasses(): {
  117871. [key: string]: Object;
  117872. };
  117873. static set RegisteredExternalClasses(classes: {
  117874. [key: string]: Object;
  117875. });
  117876. /**
  117877. * Texture content used if a texture cannot loaded
  117878. * @ignorenaming
  117879. */
  117880. static get fallbackTexture(): string;
  117881. static set fallbackTexture(value: string);
  117882. /**
  117883. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  117884. * @param u defines the coordinate on X axis
  117885. * @param v defines the coordinate on Y axis
  117886. * @param width defines the width of the source data
  117887. * @param height defines the height of the source data
  117888. * @param pixels defines the source byte array
  117889. * @param color defines the output color
  117890. */
  117891. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  117892. /**
  117893. * Interpolates between a and b via alpha
  117894. * @param a The lower value (returned when alpha = 0)
  117895. * @param b The upper value (returned when alpha = 1)
  117896. * @param alpha The interpolation-factor
  117897. * @return The mixed value
  117898. */
  117899. static Mix(a: number, b: number, alpha: number): number;
  117900. /**
  117901. * Tries to instantiate a new object from a given class name
  117902. * @param className defines the class name to instantiate
  117903. * @returns the new object or null if the system was not able to do the instantiation
  117904. */
  117905. static Instantiate(className: string): any;
  117906. /**
  117907. * Provides a slice function that will work even on IE
  117908. * @param data defines the array to slice
  117909. * @param start defines the start of the data (optional)
  117910. * @param end defines the end of the data (optional)
  117911. * @returns the new sliced array
  117912. */
  117913. static Slice<T>(data: T, start?: number, end?: number): T;
  117914. /**
  117915. * Polyfill for setImmediate
  117916. * @param action defines the action to execute after the current execution block
  117917. */
  117918. static SetImmediate(action: () => void): void;
  117919. /**
  117920. * Function indicating if a number is an exponent of 2
  117921. * @param value defines the value to test
  117922. * @returns true if the value is an exponent of 2
  117923. */
  117924. static IsExponentOfTwo(value: number): boolean;
  117925. private static _tmpFloatArray;
  117926. /**
  117927. * Returns the nearest 32-bit single precision float representation of a Number
  117928. * @param value A Number. If the parameter is of a different type, it will get converted
  117929. * to a number or to NaN if it cannot be converted
  117930. * @returns number
  117931. */
  117932. static FloatRound(value: number): number;
  117933. /**
  117934. * Extracts the filename from a path
  117935. * @param path defines the path to use
  117936. * @returns the filename
  117937. */
  117938. static GetFilename(path: string): string;
  117939. /**
  117940. * Extracts the "folder" part of a path (everything before the filename).
  117941. * @param uri The URI to extract the info from
  117942. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  117943. * @returns The "folder" part of the path
  117944. */
  117945. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  117946. /**
  117947. * Extracts text content from a DOM element hierarchy
  117948. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  117949. */
  117950. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  117951. /**
  117952. * Convert an angle in radians to degrees
  117953. * @param angle defines the angle to convert
  117954. * @returns the angle in degrees
  117955. */
  117956. static ToDegrees(angle: number): number;
  117957. /**
  117958. * Convert an angle in degrees to radians
  117959. * @param angle defines the angle to convert
  117960. * @returns the angle in radians
  117961. */
  117962. static ToRadians(angle: number): number;
  117963. /**
  117964. * Returns an array if obj is not an array
  117965. * @param obj defines the object to evaluate as an array
  117966. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  117967. * @returns either obj directly if obj is an array or a new array containing obj
  117968. */
  117969. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  117970. /**
  117971. * Gets the pointer prefix to use
  117972. * @param engine defines the engine we are finding the prefix for
  117973. * @returns "pointer" if touch is enabled. Else returns "mouse"
  117974. */
  117975. static GetPointerPrefix(engine: Engine): string;
  117976. /**
  117977. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  117978. * @param url define the url we are trying
  117979. * @param element define the dom element where to configure the cors policy
  117980. */
  117981. static SetCorsBehavior(url: string | string[], element: {
  117982. crossOrigin: string | null;
  117983. }): void;
  117984. /**
  117985. * Removes unwanted characters from an url
  117986. * @param url defines the url to clean
  117987. * @returns the cleaned url
  117988. */
  117989. static CleanUrl(url: string): string;
  117990. /**
  117991. * Gets or sets a function used to pre-process url before using them to load assets
  117992. */
  117993. static get PreprocessUrl(): (url: string) => string;
  117994. static set PreprocessUrl(processor: (url: string) => string);
  117995. /**
  117996. * Loads an image as an HTMLImageElement.
  117997. * @param input url string, ArrayBuffer, or Blob to load
  117998. * @param onLoad callback called when the image successfully loads
  117999. * @param onError callback called when the image fails to load
  118000. * @param offlineProvider offline provider for caching
  118001. * @param mimeType optional mime type
  118002. * @returns the HTMLImageElement of the loaded image
  118003. */
  118004. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  118005. /**
  118006. * Loads a file from a url
  118007. * @param url url string, ArrayBuffer, or Blob to load
  118008. * @param onSuccess callback called when the file successfully loads
  118009. * @param onProgress callback called while file is loading (if the server supports this mode)
  118010. * @param offlineProvider defines the offline provider for caching
  118011. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118012. * @param onError callback called when the file fails to load
  118013. * @returns a file request object
  118014. */
  118015. 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;
  118016. /**
  118017. * Loads a file from a url
  118018. * @param url the file url to load
  118019. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118020. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  118021. */
  118022. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  118023. /**
  118024. * Load a script (identified by an url). When the url returns, the
  118025. * content of this file is added into a new script element, attached to the DOM (body element)
  118026. * @param scriptUrl defines the url of the script to laod
  118027. * @param onSuccess defines the callback called when the script is loaded
  118028. * @param onError defines the callback to call if an error occurs
  118029. * @param scriptId defines the id of the script element
  118030. */
  118031. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  118032. /**
  118033. * Load an asynchronous 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 scriptId defines the id of the script element
  118037. * @returns a promise request object
  118038. */
  118039. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  118040. /**
  118041. * Loads a file from a blob
  118042. * @param fileToLoad defines the blob to use
  118043. * @param callback defines the callback to call when data is loaded
  118044. * @param progressCallback defines the callback to call during loading process
  118045. * @returns a file request object
  118046. */
  118047. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  118048. /**
  118049. * Reads a file from a File object
  118050. * @param file defines the file to load
  118051. * @param onSuccess defines the callback to call when data is loaded
  118052. * @param onProgress defines the callback to call during loading process
  118053. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  118054. * @param onError defines the callback to call when an error occurs
  118055. * @returns a file request object
  118056. */
  118057. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  118058. /**
  118059. * Creates a data url from a given string content
  118060. * @param content defines the content to convert
  118061. * @returns the new data url link
  118062. */
  118063. static FileAsURL(content: string): string;
  118064. /**
  118065. * Format the given number to a specific decimal format
  118066. * @param value defines the number to format
  118067. * @param decimals defines the number of decimals to use
  118068. * @returns the formatted string
  118069. */
  118070. static Format(value: number, decimals?: number): string;
  118071. /**
  118072. * Tries to copy an object by duplicating every property
  118073. * @param source defines the source object
  118074. * @param destination defines the target object
  118075. * @param doNotCopyList defines a list of properties to avoid
  118076. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  118077. */
  118078. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  118079. /**
  118080. * Gets a boolean indicating if the given object has no own property
  118081. * @param obj defines the object to test
  118082. * @returns true if object has no own property
  118083. */
  118084. static IsEmpty(obj: any): boolean;
  118085. /**
  118086. * Function used to register events at window level
  118087. * @param windowElement defines the Window object to use
  118088. * @param events defines the events to register
  118089. */
  118090. static RegisterTopRootEvents(windowElement: Window, events: {
  118091. name: string;
  118092. handler: Nullable<(e: FocusEvent) => any>;
  118093. }[]): void;
  118094. /**
  118095. * Function used to unregister events from window level
  118096. * @param windowElement defines the Window object to use
  118097. * @param events defines the events to unregister
  118098. */
  118099. static UnregisterTopRootEvents(windowElement: Window, events: {
  118100. name: string;
  118101. handler: Nullable<(e: FocusEvent) => any>;
  118102. }[]): void;
  118103. /**
  118104. * @ignore
  118105. */
  118106. static _ScreenshotCanvas: HTMLCanvasElement;
  118107. /**
  118108. * Dumps the current bound framebuffer
  118109. * @param width defines the rendering width
  118110. * @param height defines the rendering height
  118111. * @param engine defines the hosting engine
  118112. * @param successCallback defines the callback triggered once the data are available
  118113. * @param mimeType defines the mime type of the result
  118114. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  118115. */
  118116. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118117. /**
  118118. * Converts the canvas data to blob.
  118119. * This acts as a polyfill for browsers not supporting the to blob function.
  118120. * @param canvas Defines the canvas to extract the data from
  118121. * @param successCallback Defines the callback triggered once the data are available
  118122. * @param mimeType Defines the mime type of the result
  118123. */
  118124. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  118125. /**
  118126. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  118127. * @param successCallback defines the callback triggered once the data are available
  118128. * @param mimeType defines the mime type of the result
  118129. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  118130. */
  118131. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118132. /**
  118133. * Downloads a blob in the browser
  118134. * @param blob defines the blob to download
  118135. * @param fileName defines the name of the downloaded file
  118136. */
  118137. static Download(blob: Blob, fileName: string): void;
  118138. /**
  118139. * Captures a screenshot of the current rendering
  118140. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118141. * @param engine defines the rendering engine
  118142. * @param camera defines the source camera
  118143. * @param size This parameter can be set to a single number or to an object with the
  118144. * following (optional) properties: precision, width, height. If a single number is passed,
  118145. * it will be used for both width and height. If an object is passed, the screenshot size
  118146. * will be derived from the parameters. The precision property is a multiplier allowing
  118147. * rendering at a higher or lower resolution
  118148. * @param successCallback defines the callback receives a single parameter which contains the
  118149. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118150. * src parameter of an <img> to display it
  118151. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118152. * Check your browser for supported MIME types
  118153. */
  118154. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  118155. /**
  118156. * Captures a screenshot of the current rendering
  118157. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118158. * @param engine defines the rendering engine
  118159. * @param camera defines the source camera
  118160. * @param size This parameter can be set to a single number or to an object with the
  118161. * following (optional) properties: precision, width, height. If a single number is passed,
  118162. * it will be used for both width and height. If an object is passed, the screenshot size
  118163. * will be derived from the parameters. The precision property is a multiplier allowing
  118164. * rendering at a higher or lower resolution
  118165. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118166. * Check your browser for supported MIME types
  118167. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118168. * to the src parameter of an <img> to display it
  118169. */
  118170. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  118171. /**
  118172. * Generates an image screenshot from the specified camera.
  118173. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118174. * @param engine The engine to use for rendering
  118175. * @param camera The camera to use for rendering
  118176. * @param size This parameter can be set to a single number or to an object with the
  118177. * following (optional) properties: precision, width, height. If a single number is passed,
  118178. * it will be used for both width and height. If an object is passed, the screenshot size
  118179. * will be derived from the parameters. The precision property is a multiplier allowing
  118180. * rendering at a higher or lower resolution
  118181. * @param successCallback The callback receives a single parameter which contains the
  118182. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118183. * src parameter of an <img> to display it
  118184. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118185. * Check your browser for supported MIME types
  118186. * @param samples Texture samples (default: 1)
  118187. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118188. * @param fileName A name for for the downloaded file.
  118189. */
  118190. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  118191. /**
  118192. * Generates an image screenshot from the specified camera.
  118193. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118194. * @param engine The engine to use for rendering
  118195. * @param camera The camera to use for rendering
  118196. * @param size This parameter can be set to a single number or to an object with the
  118197. * following (optional) properties: precision, width, height. If a single number is passed,
  118198. * it will be used for both width and height. If an object is passed, the screenshot size
  118199. * will be derived from the parameters. The precision property is a multiplier allowing
  118200. * rendering at a higher or lower resolution
  118201. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118202. * Check your browser for supported MIME types
  118203. * @param samples Texture samples (default: 1)
  118204. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118205. * @param fileName A name for for the downloaded file.
  118206. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118207. * to the src parameter of an <img> to display it
  118208. */
  118209. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  118210. /**
  118211. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  118212. * Be aware Math.random() could cause collisions, but:
  118213. * "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"
  118214. * @returns a pseudo random id
  118215. */
  118216. static RandomId(): string;
  118217. /**
  118218. * Test if the given uri is a base64 string
  118219. * @param uri The uri to test
  118220. * @return True if the uri is a base64 string or false otherwise
  118221. */
  118222. static IsBase64(uri: string): boolean;
  118223. /**
  118224. * Decode the given base64 uri.
  118225. * @param uri The uri to decode
  118226. * @return The decoded base64 data.
  118227. */
  118228. static DecodeBase64(uri: string): ArrayBuffer;
  118229. /**
  118230. * Gets the absolute url.
  118231. * @param url the input url
  118232. * @return the absolute url
  118233. */
  118234. static GetAbsoluteUrl(url: string): string;
  118235. /**
  118236. * No log
  118237. */
  118238. static readonly NoneLogLevel: number;
  118239. /**
  118240. * Only message logs
  118241. */
  118242. static readonly MessageLogLevel: number;
  118243. /**
  118244. * Only warning logs
  118245. */
  118246. static readonly WarningLogLevel: number;
  118247. /**
  118248. * Only error logs
  118249. */
  118250. static readonly ErrorLogLevel: number;
  118251. /**
  118252. * All logs
  118253. */
  118254. static readonly AllLogLevel: number;
  118255. /**
  118256. * Gets a value indicating the number of loading errors
  118257. * @ignorenaming
  118258. */
  118259. static get errorsCount(): number;
  118260. /**
  118261. * Callback called when a new log is added
  118262. */
  118263. static OnNewCacheEntry: (entry: string) => void;
  118264. /**
  118265. * Log a message to the console
  118266. * @param message defines the message to log
  118267. */
  118268. static Log(message: string): void;
  118269. /**
  118270. * Write a warning message to the console
  118271. * @param message defines the message to log
  118272. */
  118273. static Warn(message: string): void;
  118274. /**
  118275. * Write an error message to the console
  118276. * @param message defines the message to log
  118277. */
  118278. static Error(message: string): void;
  118279. /**
  118280. * Gets current log cache (list of logs)
  118281. */
  118282. static get LogCache(): string;
  118283. /**
  118284. * Clears the log cache
  118285. */
  118286. static ClearLogCache(): void;
  118287. /**
  118288. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  118289. */
  118290. static set LogLevels(level: number);
  118291. /**
  118292. * Checks if the window object exists
  118293. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  118294. */
  118295. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  118296. /**
  118297. * No performance log
  118298. */
  118299. static readonly PerformanceNoneLogLevel: number;
  118300. /**
  118301. * Use user marks to log performance
  118302. */
  118303. static readonly PerformanceUserMarkLogLevel: number;
  118304. /**
  118305. * Log performance to the console
  118306. */
  118307. static readonly PerformanceConsoleLogLevel: number;
  118308. private static _performance;
  118309. /**
  118310. * Sets the current performance log level
  118311. */
  118312. static set PerformanceLogLevel(level: number);
  118313. private static _StartPerformanceCounterDisabled;
  118314. private static _EndPerformanceCounterDisabled;
  118315. private static _StartUserMark;
  118316. private static _EndUserMark;
  118317. private static _StartPerformanceConsole;
  118318. private static _EndPerformanceConsole;
  118319. /**
  118320. * Starts a performance counter
  118321. */
  118322. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118323. /**
  118324. * Ends a specific performance coutner
  118325. */
  118326. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118327. /**
  118328. * Gets either window.performance.now() if supported or Date.now() else
  118329. */
  118330. static get Now(): number;
  118331. /**
  118332. * This method will return the name of the class used to create the instance of the given object.
  118333. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  118334. * @param object the object to get the class name from
  118335. * @param isType defines if the object is actually a type
  118336. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  118337. */
  118338. static GetClassName(object: any, isType?: boolean): string;
  118339. /**
  118340. * Gets the first element of an array satisfying a given predicate
  118341. * @param array defines the array to browse
  118342. * @param predicate defines the predicate to use
  118343. * @returns null if not found or the element
  118344. */
  118345. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  118346. /**
  118347. * This method will return the name of the full name of the class, including its owning module (if any).
  118348. * 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).
  118349. * @param object the object to get the class name from
  118350. * @param isType defines if the object is actually a type
  118351. * @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.
  118352. * @ignorenaming
  118353. */
  118354. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  118355. /**
  118356. * Returns a promise that resolves after the given amount of time.
  118357. * @param delay Number of milliseconds to delay
  118358. * @returns Promise that resolves after the given amount of time
  118359. */
  118360. static DelayAsync(delay: number): Promise<void>;
  118361. /**
  118362. * Utility function to detect if the current user agent is Safari
  118363. * @returns whether or not the current user agent is safari
  118364. */
  118365. static IsSafari(): boolean;
  118366. }
  118367. /**
  118368. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  118369. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  118370. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  118371. * @param name The name of the class, case should be preserved
  118372. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  118373. */
  118374. export function className(name: string, module?: string): (target: Object) => void;
  118375. /**
  118376. * An implementation of a loop for asynchronous functions.
  118377. */
  118378. export class AsyncLoop {
  118379. /**
  118380. * Defines the number of iterations for the loop
  118381. */
  118382. iterations: number;
  118383. /**
  118384. * Defines the current index of the loop.
  118385. */
  118386. index: number;
  118387. private _done;
  118388. private _fn;
  118389. private _successCallback;
  118390. /**
  118391. * Constructor.
  118392. * @param iterations the number of iterations.
  118393. * @param func the function to run each iteration
  118394. * @param successCallback the callback that will be called upon succesful execution
  118395. * @param offset starting offset.
  118396. */
  118397. constructor(
  118398. /**
  118399. * Defines the number of iterations for the loop
  118400. */
  118401. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  118402. /**
  118403. * Execute the next iteration. Must be called after the last iteration was finished.
  118404. */
  118405. executeNext(): void;
  118406. /**
  118407. * Break the loop and run the success callback.
  118408. */
  118409. breakLoop(): void;
  118410. /**
  118411. * Create and run an async loop.
  118412. * @param iterations the number of iterations.
  118413. * @param fn the function to run each iteration
  118414. * @param successCallback the callback that will be called upon succesful execution
  118415. * @param offset starting offset.
  118416. * @returns the created async loop object
  118417. */
  118418. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  118419. /**
  118420. * A for-loop that will run a given number of iterations synchronous and the rest async.
  118421. * @param iterations total number of iterations
  118422. * @param syncedIterations number of synchronous iterations in each async iteration.
  118423. * @param fn the function to call each iteration.
  118424. * @param callback a success call back that will be called when iterating stops.
  118425. * @param breakFunction a break condition (optional)
  118426. * @param timeout timeout settings for the setTimeout function. default - 0.
  118427. * @returns the created async loop object
  118428. */
  118429. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  118430. }
  118431. }
  118432. declare module BABYLON {
  118433. /**
  118434. * This class implement a typical dictionary using a string as key and the generic type T as value.
  118435. * The underlying implementation relies on an associative array to ensure the best performances.
  118436. * The value can be anything including 'null' but except 'undefined'
  118437. */
  118438. export class StringDictionary<T> {
  118439. /**
  118440. * This will clear this dictionary and copy the content from the 'source' one.
  118441. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  118442. * @param source the dictionary to take the content from and copy to this dictionary
  118443. */
  118444. copyFrom(source: StringDictionary<T>): void;
  118445. /**
  118446. * Get a value based from its key
  118447. * @param key the given key to get the matching value from
  118448. * @return the value if found, otherwise undefined is returned
  118449. */
  118450. get(key: string): T | undefined;
  118451. /**
  118452. * Get a value from its key or add it if it doesn't exist.
  118453. * This method will ensure you that a given key/data will be present in the dictionary.
  118454. * @param key the given key to get the matching value from
  118455. * @param factory the factory that will create the value if the key is not present in the dictionary.
  118456. * The factory will only be invoked if there's no data for the given key.
  118457. * @return the value corresponding to the key.
  118458. */
  118459. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  118460. /**
  118461. * Get a value from its key if present in the dictionary otherwise add it
  118462. * @param key the key to get the value from
  118463. * @param val if there's no such key/value pair in the dictionary add it with this value
  118464. * @return the value corresponding to the key
  118465. */
  118466. getOrAdd(key: string, val: T): T;
  118467. /**
  118468. * Check if there's a given key in the dictionary
  118469. * @param key the key to check for
  118470. * @return true if the key is present, false otherwise
  118471. */
  118472. contains(key: string): boolean;
  118473. /**
  118474. * Add a new key and its corresponding value
  118475. * @param key the key to add
  118476. * @param value the value corresponding to the key
  118477. * @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
  118478. */
  118479. add(key: string, value: T): boolean;
  118480. /**
  118481. * Update a specific value associated to a key
  118482. * @param key defines the key to use
  118483. * @param value defines the value to store
  118484. * @returns true if the value was updated (or false if the key was not found)
  118485. */
  118486. set(key: string, value: T): boolean;
  118487. /**
  118488. * Get the element of the given key and remove it from the dictionary
  118489. * @param key defines the key to search
  118490. * @returns the value associated with the key or null if not found
  118491. */
  118492. getAndRemove(key: string): Nullable<T>;
  118493. /**
  118494. * Remove a key/value from the dictionary.
  118495. * @param key the key to remove
  118496. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  118497. */
  118498. remove(key: string): boolean;
  118499. /**
  118500. * Clear the whole content of the dictionary
  118501. */
  118502. clear(): void;
  118503. /**
  118504. * Gets the current count
  118505. */
  118506. get count(): number;
  118507. /**
  118508. * Execute a callback on each key/val of the dictionary.
  118509. * Note that you can remove any element in this dictionary in the callback implementation
  118510. * @param callback the callback to execute on a given key/value pair
  118511. */
  118512. forEach(callback: (key: string, val: T) => void): void;
  118513. /**
  118514. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  118515. * If the callback returns null or undefined the method will iterate to the next key/value pair
  118516. * Note that you can remove any element in this dictionary in the callback implementation
  118517. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  118518. * @returns the first item
  118519. */
  118520. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  118521. private _count;
  118522. private _data;
  118523. }
  118524. }
  118525. declare module BABYLON {
  118526. /** @hidden */
  118527. export interface ICollisionCoordinator {
  118528. createCollider(): Collider;
  118529. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118530. init(scene: Scene): void;
  118531. }
  118532. /** @hidden */
  118533. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  118534. private _scene;
  118535. private _scaledPosition;
  118536. private _scaledVelocity;
  118537. private _finalPosition;
  118538. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118539. createCollider(): Collider;
  118540. init(scene: Scene): void;
  118541. private _collideWithWorld;
  118542. }
  118543. }
  118544. declare module BABYLON {
  118545. /**
  118546. * Class used to manage all inputs for the scene.
  118547. */
  118548. export class InputManager {
  118549. /** The distance in pixel that you have to move to prevent some events */
  118550. static DragMovementThreshold: number;
  118551. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  118552. static LongPressDelay: number;
  118553. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  118554. static DoubleClickDelay: number;
  118555. /** If you need to check double click without raising a single click at first click, enable this flag */
  118556. static ExclusiveDoubleClickMode: boolean;
  118557. /** 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. */
  118558. private _alreadyAttached;
  118559. private _wheelEventName;
  118560. private _onPointerMove;
  118561. private _onPointerDown;
  118562. private _onPointerUp;
  118563. private _initClickEvent;
  118564. private _initActionManager;
  118565. private _delayedSimpleClick;
  118566. private _delayedSimpleClickTimeout;
  118567. private _previousDelayedSimpleClickTimeout;
  118568. private _meshPickProceed;
  118569. private _previousButtonPressed;
  118570. private _currentPickResult;
  118571. private _previousPickResult;
  118572. private _totalPointersPressed;
  118573. private _doubleClickOccured;
  118574. private _pointerOverMesh;
  118575. private _pickedDownMesh;
  118576. private _pickedUpMesh;
  118577. private _pointerX;
  118578. private _pointerY;
  118579. private _unTranslatedPointerX;
  118580. private _unTranslatedPointerY;
  118581. private _startingPointerPosition;
  118582. private _previousStartingPointerPosition;
  118583. private _startingPointerTime;
  118584. private _previousStartingPointerTime;
  118585. private _pointerCaptures;
  118586. private _meshUnderPointerId;
  118587. private _onKeyDown;
  118588. private _onKeyUp;
  118589. private _onCanvasFocusObserver;
  118590. private _onCanvasBlurObserver;
  118591. private _scene;
  118592. /**
  118593. * Creates a new InputManager
  118594. * @param scene defines the hosting scene
  118595. */
  118596. constructor(scene: Scene);
  118597. /**
  118598. * Gets the mesh that is currently under the pointer
  118599. */
  118600. get meshUnderPointer(): Nullable<AbstractMesh>;
  118601. /**
  118602. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  118603. * @param pointerId the pointer id to use
  118604. * @returns The mesh under this pointer id or null if not found
  118605. */
  118606. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  118607. /**
  118608. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  118609. */
  118610. get unTranslatedPointer(): Vector2;
  118611. /**
  118612. * Gets or sets the current on-screen X position of the pointer
  118613. */
  118614. get pointerX(): number;
  118615. set pointerX(value: number);
  118616. /**
  118617. * Gets or sets the current on-screen Y position of the pointer
  118618. */
  118619. get pointerY(): number;
  118620. set pointerY(value: number);
  118621. private _updatePointerPosition;
  118622. private _processPointerMove;
  118623. private _setRayOnPointerInfo;
  118624. private _checkPrePointerObservable;
  118625. /**
  118626. * Use this method to simulate a pointer move on a mesh
  118627. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118628. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118629. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118630. */
  118631. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118632. /**
  118633. * Use this method to simulate a pointer down on a mesh
  118634. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118635. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118636. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118637. */
  118638. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118639. private _processPointerDown;
  118640. /** @hidden */
  118641. _isPointerSwiping(): boolean;
  118642. /**
  118643. * Use this method to simulate a pointer up on a mesh
  118644. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118645. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118646. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118647. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  118648. */
  118649. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  118650. private _processPointerUp;
  118651. /**
  118652. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  118653. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  118654. * @returns true if the pointer was captured
  118655. */
  118656. isPointerCaptured(pointerId?: number): boolean;
  118657. /**
  118658. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  118659. * @param attachUp defines if you want to attach events to pointerup
  118660. * @param attachDown defines if you want to attach events to pointerdown
  118661. * @param attachMove defines if you want to attach events to pointermove
  118662. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  118663. */
  118664. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  118665. /**
  118666. * Detaches all event handlers
  118667. */
  118668. detachControl(): void;
  118669. /**
  118670. * Force the value of meshUnderPointer
  118671. * @param mesh defines the mesh to use
  118672. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  118673. */
  118674. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  118675. /**
  118676. * Gets the mesh under the pointer
  118677. * @returns a Mesh or null if no mesh is under the pointer
  118678. */
  118679. getPointerOverMesh(): Nullable<AbstractMesh>;
  118680. }
  118681. }
  118682. declare module BABYLON {
  118683. /**
  118684. * This class defines the direct association between an animation and a target
  118685. */
  118686. export class TargetedAnimation {
  118687. /**
  118688. * Animation to perform
  118689. */
  118690. animation: Animation;
  118691. /**
  118692. * Target to animate
  118693. */
  118694. target: any;
  118695. /**
  118696. * Returns the string "TargetedAnimation"
  118697. * @returns "TargetedAnimation"
  118698. */
  118699. getClassName(): string;
  118700. /**
  118701. * Serialize the object
  118702. * @returns the JSON object representing the current entity
  118703. */
  118704. serialize(): any;
  118705. }
  118706. /**
  118707. * Use this class to create coordinated animations on multiple targets
  118708. */
  118709. export class AnimationGroup implements IDisposable {
  118710. /** The name of the animation group */
  118711. name: string;
  118712. private _scene;
  118713. private _targetedAnimations;
  118714. private _animatables;
  118715. private _from;
  118716. private _to;
  118717. private _isStarted;
  118718. private _isPaused;
  118719. private _speedRatio;
  118720. private _loopAnimation;
  118721. private _isAdditive;
  118722. /**
  118723. * Gets or sets the unique id of the node
  118724. */
  118725. uniqueId: number;
  118726. /**
  118727. * This observable will notify when one animation have ended
  118728. */
  118729. onAnimationEndObservable: Observable<TargetedAnimation>;
  118730. /**
  118731. * Observer raised when one animation loops
  118732. */
  118733. onAnimationLoopObservable: Observable<TargetedAnimation>;
  118734. /**
  118735. * Observer raised when all animations have looped
  118736. */
  118737. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  118738. /**
  118739. * This observable will notify when all animations have ended.
  118740. */
  118741. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  118742. /**
  118743. * This observable will notify when all animations have paused.
  118744. */
  118745. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  118746. /**
  118747. * This observable will notify when all animations are playing.
  118748. */
  118749. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  118750. /**
  118751. * Gets the first frame
  118752. */
  118753. get from(): number;
  118754. /**
  118755. * Gets the last frame
  118756. */
  118757. get to(): number;
  118758. /**
  118759. * Define if the animations are started
  118760. */
  118761. get isStarted(): boolean;
  118762. /**
  118763. * Gets a value indicating that the current group is playing
  118764. */
  118765. get isPlaying(): boolean;
  118766. /**
  118767. * Gets or sets the speed ratio to use for all animations
  118768. */
  118769. get speedRatio(): number;
  118770. /**
  118771. * Gets or sets the speed ratio to use for all animations
  118772. */
  118773. set speedRatio(value: number);
  118774. /**
  118775. * Gets or sets if all animations should loop or not
  118776. */
  118777. get loopAnimation(): boolean;
  118778. set loopAnimation(value: boolean);
  118779. /**
  118780. * Gets or sets if all animations should be evaluated additively
  118781. */
  118782. get isAdditive(): boolean;
  118783. set isAdditive(value: boolean);
  118784. /**
  118785. * Gets the targeted animations for this animation group
  118786. */
  118787. get targetedAnimations(): Array<TargetedAnimation>;
  118788. /**
  118789. * returning the list of animatables controlled by this animation group.
  118790. */
  118791. get animatables(): Array<Animatable>;
  118792. /**
  118793. * Gets the list of target animations
  118794. */
  118795. get children(): TargetedAnimation[];
  118796. /**
  118797. * Instantiates a new Animation Group.
  118798. * This helps managing several animations at once.
  118799. * @see https://doc.babylonjs.com/how_to/group
  118800. * @param name Defines the name of the group
  118801. * @param scene Defines the scene the group belongs to
  118802. */
  118803. constructor(
  118804. /** The name of the animation group */
  118805. name: string, scene?: Nullable<Scene>);
  118806. /**
  118807. * Add an animation (with its target) in the group
  118808. * @param animation defines the animation we want to add
  118809. * @param target defines the target of the animation
  118810. * @returns the TargetedAnimation object
  118811. */
  118812. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  118813. /**
  118814. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  118815. * It can add constant keys at begin or end
  118816. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  118817. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  118818. * @returns the animation group
  118819. */
  118820. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  118821. private _animationLoopCount;
  118822. private _animationLoopFlags;
  118823. private _processLoop;
  118824. /**
  118825. * Start all animations on given targets
  118826. * @param loop defines if animations must loop
  118827. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  118828. * @param from defines the from key (optional)
  118829. * @param to defines the to key (optional)
  118830. * @param isAdditive defines the additive state for the resulting animatables (optional)
  118831. * @returns the current animation group
  118832. */
  118833. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  118834. /**
  118835. * Pause all animations
  118836. * @returns the animation group
  118837. */
  118838. pause(): AnimationGroup;
  118839. /**
  118840. * Play all animations to initial state
  118841. * This function will start() the animations if they were not started or will restart() them if they were paused
  118842. * @param loop defines if animations must loop
  118843. * @returns the animation group
  118844. */
  118845. play(loop?: boolean): AnimationGroup;
  118846. /**
  118847. * Reset all animations to initial state
  118848. * @returns the animation group
  118849. */
  118850. reset(): AnimationGroup;
  118851. /**
  118852. * Restart animations from key 0
  118853. * @returns the animation group
  118854. */
  118855. restart(): AnimationGroup;
  118856. /**
  118857. * Stop all animations
  118858. * @returns the animation group
  118859. */
  118860. stop(): AnimationGroup;
  118861. /**
  118862. * Set animation weight for all animatables
  118863. * @param weight defines the weight to use
  118864. * @return the animationGroup
  118865. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118866. */
  118867. setWeightForAllAnimatables(weight: number): AnimationGroup;
  118868. /**
  118869. * Synchronize and normalize all animatables with a source animatable
  118870. * @param root defines the root animatable to synchronize with
  118871. * @return the animationGroup
  118872. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118873. */
  118874. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  118875. /**
  118876. * Goes to a specific frame in this animation group
  118877. * @param frame the frame number to go to
  118878. * @return the animationGroup
  118879. */
  118880. goToFrame(frame: number): AnimationGroup;
  118881. /**
  118882. * Dispose all associated resources
  118883. */
  118884. dispose(): void;
  118885. private _checkAnimationGroupEnded;
  118886. /**
  118887. * Clone the current animation group and returns a copy
  118888. * @param newName defines the name of the new group
  118889. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  118890. * @returns the new aniamtion group
  118891. */
  118892. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  118893. /**
  118894. * Serializes the animationGroup to an object
  118895. * @returns Serialized object
  118896. */
  118897. serialize(): any;
  118898. /**
  118899. * Returns a new AnimationGroup object parsed from the source provided.
  118900. * @param parsedAnimationGroup defines the source
  118901. * @param scene defines the scene that will receive the animationGroup
  118902. * @returns a new AnimationGroup
  118903. */
  118904. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  118905. /**
  118906. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  118907. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  118908. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  118909. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  118910. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  118911. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  118912. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  118913. */
  118914. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  118915. /**
  118916. * Returns the string "AnimationGroup"
  118917. * @returns "AnimationGroup"
  118918. */
  118919. getClassName(): string;
  118920. /**
  118921. * Creates a detailled string about the object
  118922. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  118923. * @returns a string representing the object
  118924. */
  118925. toString(fullDetails?: boolean): string;
  118926. }
  118927. }
  118928. declare module BABYLON {
  118929. /**
  118930. * Define an interface for all classes that will hold resources
  118931. */
  118932. export interface IDisposable {
  118933. /**
  118934. * Releases all held resources
  118935. */
  118936. dispose(): void;
  118937. }
  118938. /** Interface defining initialization parameters for Scene class */
  118939. export interface SceneOptions {
  118940. /**
  118941. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  118942. * It will improve performance when the number of geometries becomes important.
  118943. */
  118944. useGeometryUniqueIdsMap?: boolean;
  118945. /**
  118946. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  118947. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118948. */
  118949. useMaterialMeshMap?: boolean;
  118950. /**
  118951. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  118952. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118953. */
  118954. useClonedMeshMap?: boolean;
  118955. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  118956. virtual?: boolean;
  118957. }
  118958. /**
  118959. * Represents a scene to be rendered by the engine.
  118960. * @see https://doc.babylonjs.com/features/scene
  118961. */
  118962. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  118963. /** The fog is deactivated */
  118964. static readonly FOGMODE_NONE: number;
  118965. /** The fog density is following an exponential function */
  118966. static readonly FOGMODE_EXP: number;
  118967. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  118968. static readonly FOGMODE_EXP2: number;
  118969. /** The fog density is following a linear function. */
  118970. static readonly FOGMODE_LINEAR: number;
  118971. /**
  118972. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  118973. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118974. */
  118975. static MinDeltaTime: number;
  118976. /**
  118977. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  118978. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118979. */
  118980. static MaxDeltaTime: number;
  118981. /**
  118982. * Factory used to create the default material.
  118983. * @param name The name of the material to create
  118984. * @param scene The scene to create the material for
  118985. * @returns The default material
  118986. */
  118987. static DefaultMaterialFactory(scene: Scene): Material;
  118988. /**
  118989. * Factory used to create the a collision coordinator.
  118990. * @returns The collision coordinator
  118991. */
  118992. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  118993. /** @hidden */
  118994. _inputManager: InputManager;
  118995. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  118996. cameraToUseForPointers: Nullable<Camera>;
  118997. /** @hidden */
  118998. readonly _isScene: boolean;
  118999. /** @hidden */
  119000. _blockEntityCollection: boolean;
  119001. /**
  119002. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  119003. */
  119004. autoClear: boolean;
  119005. /**
  119006. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  119007. */
  119008. autoClearDepthAndStencil: boolean;
  119009. /**
  119010. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  119011. */
  119012. clearColor: Color4;
  119013. /**
  119014. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  119015. */
  119016. ambientColor: Color3;
  119017. /**
  119018. * This is use to store the default BRDF lookup for PBR materials in your scene.
  119019. * It should only be one of the following (if not the default embedded one):
  119020. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  119021. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  119022. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  119023. * The material properties need to be setup according to the type of texture in use.
  119024. */
  119025. environmentBRDFTexture: BaseTexture;
  119026. /**
  119027. * Texture used in all pbr material as the reflection texture.
  119028. * As in the majority of the scene they are the same (exception for multi room and so on),
  119029. * this is easier to reference from here than from all the materials.
  119030. */
  119031. get environmentTexture(): Nullable<BaseTexture>;
  119032. /**
  119033. * Texture used in all pbr material as the reflection texture.
  119034. * As in the majority of the scene they are the same (exception for multi room and so on),
  119035. * this is easier to set here than in all the materials.
  119036. */
  119037. set environmentTexture(value: Nullable<BaseTexture>);
  119038. /** @hidden */
  119039. protected _environmentIntensity: number;
  119040. /**
  119041. * Intensity of the environment in all pbr material.
  119042. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119043. * As in the majority of the scene they are the same (exception for multi room and so on),
  119044. * this is easier to reference from here than from all the materials.
  119045. */
  119046. get environmentIntensity(): number;
  119047. /**
  119048. * Intensity of the environment in all pbr material.
  119049. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119050. * As in the majority of the scene they are the same (exception for multi room and so on),
  119051. * this is easier to set here than in all the materials.
  119052. */
  119053. set environmentIntensity(value: number);
  119054. /** @hidden */
  119055. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  119056. /**
  119057. * Default image processing configuration used either in the rendering
  119058. * Forward main pass or through the imageProcessingPostProcess if present.
  119059. * As in the majority of the scene they are the same (exception for multi camera),
  119060. * this is easier to reference from here than from all the materials and post process.
  119061. *
  119062. * No setter as we it is a shared configuration, you can set the values instead.
  119063. */
  119064. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  119065. private _forceWireframe;
  119066. /**
  119067. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  119068. */
  119069. set forceWireframe(value: boolean);
  119070. get forceWireframe(): boolean;
  119071. private _skipFrustumClipping;
  119072. /**
  119073. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  119074. */
  119075. set skipFrustumClipping(value: boolean);
  119076. get skipFrustumClipping(): boolean;
  119077. private _forcePointsCloud;
  119078. /**
  119079. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  119080. */
  119081. set forcePointsCloud(value: boolean);
  119082. get forcePointsCloud(): boolean;
  119083. /**
  119084. * Gets or sets the active clipplane 1
  119085. */
  119086. clipPlane: Nullable<Plane>;
  119087. /**
  119088. * Gets or sets the active clipplane 2
  119089. */
  119090. clipPlane2: Nullable<Plane>;
  119091. /**
  119092. * Gets or sets the active clipplane 3
  119093. */
  119094. clipPlane3: Nullable<Plane>;
  119095. /**
  119096. * Gets or sets the active clipplane 4
  119097. */
  119098. clipPlane4: Nullable<Plane>;
  119099. /**
  119100. * Gets or sets the active clipplane 5
  119101. */
  119102. clipPlane5: Nullable<Plane>;
  119103. /**
  119104. * Gets or sets the active clipplane 6
  119105. */
  119106. clipPlane6: Nullable<Plane>;
  119107. /**
  119108. * Gets or sets a boolean indicating if animations are enabled
  119109. */
  119110. animationsEnabled: boolean;
  119111. private _animationPropertiesOverride;
  119112. /**
  119113. * Gets or sets the animation properties override
  119114. */
  119115. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  119116. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  119117. /**
  119118. * Gets or sets a boolean indicating if a constant deltatime has to be used
  119119. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  119120. */
  119121. useConstantAnimationDeltaTime: boolean;
  119122. /**
  119123. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  119124. * Please note that it requires to run a ray cast through the scene on every frame
  119125. */
  119126. constantlyUpdateMeshUnderPointer: boolean;
  119127. /**
  119128. * Defines the HTML cursor to use when hovering over interactive elements
  119129. */
  119130. hoverCursor: string;
  119131. /**
  119132. * Defines the HTML default cursor to use (empty by default)
  119133. */
  119134. defaultCursor: string;
  119135. /**
  119136. * Defines whether cursors are handled by the scene.
  119137. */
  119138. doNotHandleCursors: boolean;
  119139. /**
  119140. * This is used to call preventDefault() on pointer down
  119141. * in order to block unwanted artifacts like system double clicks
  119142. */
  119143. preventDefaultOnPointerDown: boolean;
  119144. /**
  119145. * This is used to call preventDefault() on pointer up
  119146. * in order to block unwanted artifacts like system double clicks
  119147. */
  119148. preventDefaultOnPointerUp: boolean;
  119149. /**
  119150. * Gets or sets user defined metadata
  119151. */
  119152. metadata: any;
  119153. /**
  119154. * For internal use only. Please do not use.
  119155. */
  119156. reservedDataStore: any;
  119157. /**
  119158. * Gets the name of the plugin used to load this scene (null by default)
  119159. */
  119160. loadingPluginName: string;
  119161. /**
  119162. * Use this array to add regular expressions used to disable offline support for specific urls
  119163. */
  119164. disableOfflineSupportExceptionRules: RegExp[];
  119165. /**
  119166. * An event triggered when the scene is disposed.
  119167. */
  119168. onDisposeObservable: Observable<Scene>;
  119169. private _onDisposeObserver;
  119170. /** Sets a function to be executed when this scene is disposed. */
  119171. set onDispose(callback: () => void);
  119172. /**
  119173. * An event triggered before rendering the scene (right after animations and physics)
  119174. */
  119175. onBeforeRenderObservable: Observable<Scene>;
  119176. private _onBeforeRenderObserver;
  119177. /** Sets a function to be executed before rendering this scene */
  119178. set beforeRender(callback: Nullable<() => void>);
  119179. /**
  119180. * An event triggered after rendering the scene
  119181. */
  119182. onAfterRenderObservable: Observable<Scene>;
  119183. /**
  119184. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  119185. */
  119186. onAfterRenderCameraObservable: Observable<Camera>;
  119187. private _onAfterRenderObserver;
  119188. /** Sets a function to be executed after rendering this scene */
  119189. set afterRender(callback: Nullable<() => void>);
  119190. /**
  119191. * An event triggered before animating the scene
  119192. */
  119193. onBeforeAnimationsObservable: Observable<Scene>;
  119194. /**
  119195. * An event triggered after animations processing
  119196. */
  119197. onAfterAnimationsObservable: Observable<Scene>;
  119198. /**
  119199. * An event triggered before draw calls are ready to be sent
  119200. */
  119201. onBeforeDrawPhaseObservable: Observable<Scene>;
  119202. /**
  119203. * An event triggered after draw calls have been sent
  119204. */
  119205. onAfterDrawPhaseObservable: Observable<Scene>;
  119206. /**
  119207. * An event triggered when the scene is ready
  119208. */
  119209. onReadyObservable: Observable<Scene>;
  119210. /**
  119211. * An event triggered before rendering a camera
  119212. */
  119213. onBeforeCameraRenderObservable: Observable<Camera>;
  119214. private _onBeforeCameraRenderObserver;
  119215. /** Sets a function to be executed before rendering a camera*/
  119216. set beforeCameraRender(callback: () => void);
  119217. /**
  119218. * An event triggered after rendering a camera
  119219. */
  119220. onAfterCameraRenderObservable: Observable<Camera>;
  119221. private _onAfterCameraRenderObserver;
  119222. /** Sets a function to be executed after rendering a camera*/
  119223. set afterCameraRender(callback: () => void);
  119224. /**
  119225. * An event triggered when active meshes evaluation is about to start
  119226. */
  119227. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  119228. /**
  119229. * An event triggered when active meshes evaluation is done
  119230. */
  119231. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  119232. /**
  119233. * An event triggered when particles rendering is about to start
  119234. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119235. */
  119236. onBeforeParticlesRenderingObservable: Observable<Scene>;
  119237. /**
  119238. * An event triggered when particles rendering is done
  119239. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119240. */
  119241. onAfterParticlesRenderingObservable: Observable<Scene>;
  119242. /**
  119243. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  119244. */
  119245. onDataLoadedObservable: Observable<Scene>;
  119246. /**
  119247. * An event triggered when a camera is created
  119248. */
  119249. onNewCameraAddedObservable: Observable<Camera>;
  119250. /**
  119251. * An event triggered when a camera is removed
  119252. */
  119253. onCameraRemovedObservable: Observable<Camera>;
  119254. /**
  119255. * An event triggered when a light is created
  119256. */
  119257. onNewLightAddedObservable: Observable<Light>;
  119258. /**
  119259. * An event triggered when a light is removed
  119260. */
  119261. onLightRemovedObservable: Observable<Light>;
  119262. /**
  119263. * An event triggered when a geometry is created
  119264. */
  119265. onNewGeometryAddedObservable: Observable<Geometry>;
  119266. /**
  119267. * An event triggered when a geometry is removed
  119268. */
  119269. onGeometryRemovedObservable: Observable<Geometry>;
  119270. /**
  119271. * An event triggered when a transform node is created
  119272. */
  119273. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  119274. /**
  119275. * An event triggered when a transform node is removed
  119276. */
  119277. onTransformNodeRemovedObservable: Observable<TransformNode>;
  119278. /**
  119279. * An event triggered when a mesh is created
  119280. */
  119281. onNewMeshAddedObservable: Observable<AbstractMesh>;
  119282. /**
  119283. * An event triggered when a mesh is removed
  119284. */
  119285. onMeshRemovedObservable: Observable<AbstractMesh>;
  119286. /**
  119287. * An event triggered when a skeleton is created
  119288. */
  119289. onNewSkeletonAddedObservable: Observable<Skeleton>;
  119290. /**
  119291. * An event triggered when a skeleton is removed
  119292. */
  119293. onSkeletonRemovedObservable: Observable<Skeleton>;
  119294. /**
  119295. * An event triggered when a material is created
  119296. */
  119297. onNewMaterialAddedObservable: Observable<Material>;
  119298. /**
  119299. * An event triggered when a material is removed
  119300. */
  119301. onMaterialRemovedObservable: Observable<Material>;
  119302. /**
  119303. * An event triggered when a texture is created
  119304. */
  119305. onNewTextureAddedObservable: Observable<BaseTexture>;
  119306. /**
  119307. * An event triggered when a texture is removed
  119308. */
  119309. onTextureRemovedObservable: Observable<BaseTexture>;
  119310. /**
  119311. * An event triggered when render targets are about to be rendered
  119312. * Can happen multiple times per frame.
  119313. */
  119314. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  119315. /**
  119316. * An event triggered when render targets were rendered.
  119317. * Can happen multiple times per frame.
  119318. */
  119319. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  119320. /**
  119321. * An event triggered before calculating deterministic simulation step
  119322. */
  119323. onBeforeStepObservable: Observable<Scene>;
  119324. /**
  119325. * An event triggered after calculating deterministic simulation step
  119326. */
  119327. onAfterStepObservable: Observable<Scene>;
  119328. /**
  119329. * An event triggered when the activeCamera property is updated
  119330. */
  119331. onActiveCameraChanged: Observable<Scene>;
  119332. /**
  119333. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  119334. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119335. * 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)
  119336. */
  119337. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119338. /**
  119339. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  119340. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119341. * 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)
  119342. */
  119343. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119344. /**
  119345. * This Observable will when a mesh has been imported into the scene.
  119346. */
  119347. onMeshImportedObservable: Observable<AbstractMesh>;
  119348. /**
  119349. * This Observable will when an animation file has been imported into the scene.
  119350. */
  119351. onAnimationFileImportedObservable: Observable<Scene>;
  119352. /**
  119353. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  119354. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  119355. */
  119356. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  119357. /** @hidden */
  119358. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  119359. /**
  119360. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  119361. */
  119362. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  119363. /**
  119364. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  119365. */
  119366. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  119367. /**
  119368. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  119369. */
  119370. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  119371. /** Callback called when a pointer move is detected */
  119372. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119373. /** Callback called when a pointer down is detected */
  119374. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119375. /** Callback called when a pointer up is detected */
  119376. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  119377. /** Callback called when a pointer pick is detected */
  119378. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  119379. /**
  119380. * 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).
  119381. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  119382. */
  119383. onPrePointerObservable: Observable<PointerInfoPre>;
  119384. /**
  119385. * Observable event triggered each time an input event is received from the rendering canvas
  119386. */
  119387. onPointerObservable: Observable<PointerInfo>;
  119388. /**
  119389. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  119390. */
  119391. get unTranslatedPointer(): Vector2;
  119392. /**
  119393. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  119394. */
  119395. static get DragMovementThreshold(): number;
  119396. static set DragMovementThreshold(value: number);
  119397. /**
  119398. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  119399. */
  119400. static get LongPressDelay(): number;
  119401. static set LongPressDelay(value: number);
  119402. /**
  119403. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  119404. */
  119405. static get DoubleClickDelay(): number;
  119406. static set DoubleClickDelay(value: number);
  119407. /** If you need to check double click without raising a single click at first click, enable this flag */
  119408. static get ExclusiveDoubleClickMode(): boolean;
  119409. static set ExclusiveDoubleClickMode(value: boolean);
  119410. /** @hidden */
  119411. _mirroredCameraPosition: Nullable<Vector3>;
  119412. /**
  119413. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  119414. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  119415. */
  119416. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  119417. /**
  119418. * Observable event triggered each time an keyboard event is received from the hosting window
  119419. */
  119420. onKeyboardObservable: Observable<KeyboardInfo>;
  119421. private _useRightHandedSystem;
  119422. /**
  119423. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  119424. */
  119425. set useRightHandedSystem(value: boolean);
  119426. get useRightHandedSystem(): boolean;
  119427. private _timeAccumulator;
  119428. private _currentStepId;
  119429. private _currentInternalStep;
  119430. /**
  119431. * Sets the step Id used by deterministic lock step
  119432. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119433. * @param newStepId defines the step Id
  119434. */
  119435. setStepId(newStepId: number): void;
  119436. /**
  119437. * Gets the step Id used by deterministic lock step
  119438. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119439. * @returns the step Id
  119440. */
  119441. getStepId(): number;
  119442. /**
  119443. * Gets the internal step used by deterministic lock step
  119444. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119445. * @returns the internal step
  119446. */
  119447. getInternalStep(): number;
  119448. private _fogEnabled;
  119449. /**
  119450. * Gets or sets a boolean indicating if fog is enabled on this scene
  119451. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119452. * (Default is true)
  119453. */
  119454. set fogEnabled(value: boolean);
  119455. get fogEnabled(): boolean;
  119456. private _fogMode;
  119457. /**
  119458. * Gets or sets the fog mode to use
  119459. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119460. * | mode | value |
  119461. * | --- | --- |
  119462. * | FOGMODE_NONE | 0 |
  119463. * | FOGMODE_EXP | 1 |
  119464. * | FOGMODE_EXP2 | 2 |
  119465. * | FOGMODE_LINEAR | 3 |
  119466. */
  119467. set fogMode(value: number);
  119468. get fogMode(): number;
  119469. /**
  119470. * Gets or sets the fog color to use
  119471. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119472. * (Default is Color3(0.2, 0.2, 0.3))
  119473. */
  119474. fogColor: Color3;
  119475. /**
  119476. * Gets or sets the fog density to use
  119477. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119478. * (Default is 0.1)
  119479. */
  119480. fogDensity: number;
  119481. /**
  119482. * Gets or sets the fog start distance to use
  119483. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119484. * (Default is 0)
  119485. */
  119486. fogStart: number;
  119487. /**
  119488. * Gets or sets the fog end distance to use
  119489. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119490. * (Default is 1000)
  119491. */
  119492. fogEnd: number;
  119493. /**
  119494. * Flag indicating that the frame buffer binding is handled by another component
  119495. */
  119496. prePass: boolean;
  119497. private _shadowsEnabled;
  119498. /**
  119499. * Gets or sets a boolean indicating if shadows are enabled on this scene
  119500. */
  119501. set shadowsEnabled(value: boolean);
  119502. get shadowsEnabled(): boolean;
  119503. private _lightsEnabled;
  119504. /**
  119505. * Gets or sets a boolean indicating if lights are enabled on this scene
  119506. */
  119507. set lightsEnabled(value: boolean);
  119508. get lightsEnabled(): boolean;
  119509. /** All of the active cameras added to this scene. */
  119510. activeCameras: Camera[];
  119511. /** @hidden */
  119512. _activeCamera: Nullable<Camera>;
  119513. /** Gets or sets the current active camera */
  119514. get activeCamera(): Nullable<Camera>;
  119515. set activeCamera(value: Nullable<Camera>);
  119516. private _defaultMaterial;
  119517. /** The default material used on meshes when no material is affected */
  119518. get defaultMaterial(): Material;
  119519. /** The default material used on meshes when no material is affected */
  119520. set defaultMaterial(value: Material);
  119521. private _texturesEnabled;
  119522. /**
  119523. * Gets or sets a boolean indicating if textures are enabled on this scene
  119524. */
  119525. set texturesEnabled(value: boolean);
  119526. get texturesEnabled(): boolean;
  119527. /**
  119528. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  119529. */
  119530. physicsEnabled: boolean;
  119531. /**
  119532. * Gets or sets a boolean indicating if particles are enabled on this scene
  119533. */
  119534. particlesEnabled: boolean;
  119535. /**
  119536. * Gets or sets a boolean indicating if sprites are enabled on this scene
  119537. */
  119538. spritesEnabled: boolean;
  119539. private _skeletonsEnabled;
  119540. /**
  119541. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  119542. */
  119543. set skeletonsEnabled(value: boolean);
  119544. get skeletonsEnabled(): boolean;
  119545. /**
  119546. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  119547. */
  119548. lensFlaresEnabled: boolean;
  119549. /**
  119550. * Gets or sets a boolean indicating if collisions are enabled on this scene
  119551. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119552. */
  119553. collisionsEnabled: boolean;
  119554. private _collisionCoordinator;
  119555. /** @hidden */
  119556. get collisionCoordinator(): ICollisionCoordinator;
  119557. /**
  119558. * Defines the gravity applied to this scene (used only for collisions)
  119559. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119560. */
  119561. gravity: Vector3;
  119562. /**
  119563. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  119564. */
  119565. postProcessesEnabled: boolean;
  119566. /**
  119567. * Gets the current postprocess manager
  119568. */
  119569. postProcessManager: PostProcessManager;
  119570. /**
  119571. * Gets or sets a boolean indicating if render targets are enabled on this scene
  119572. */
  119573. renderTargetsEnabled: boolean;
  119574. /**
  119575. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  119576. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  119577. */
  119578. dumpNextRenderTargets: boolean;
  119579. /**
  119580. * The list of user defined render targets added to the scene
  119581. */
  119582. customRenderTargets: RenderTargetTexture[];
  119583. /**
  119584. * Defines if texture loading must be delayed
  119585. * If true, textures will only be loaded when they need to be rendered
  119586. */
  119587. useDelayedTextureLoading: boolean;
  119588. /**
  119589. * Gets the list of meshes imported to the scene through SceneLoader
  119590. */
  119591. importedMeshesFiles: String[];
  119592. /**
  119593. * Gets or sets a boolean indicating if probes are enabled on this scene
  119594. */
  119595. probesEnabled: boolean;
  119596. /**
  119597. * Gets or sets the current offline provider to use to store scene data
  119598. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  119599. */
  119600. offlineProvider: IOfflineProvider;
  119601. /**
  119602. * Gets or sets the action manager associated with the scene
  119603. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  119604. */
  119605. actionManager: AbstractActionManager;
  119606. private _meshesForIntersections;
  119607. /**
  119608. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  119609. */
  119610. proceduralTexturesEnabled: boolean;
  119611. private _engine;
  119612. private _totalVertices;
  119613. /** @hidden */
  119614. _activeIndices: PerfCounter;
  119615. /** @hidden */
  119616. _activeParticles: PerfCounter;
  119617. /** @hidden */
  119618. _activeBones: PerfCounter;
  119619. private _animationRatio;
  119620. /** @hidden */
  119621. _animationTimeLast: number;
  119622. /** @hidden */
  119623. _animationTime: number;
  119624. /**
  119625. * Gets or sets a general scale for animation speed
  119626. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  119627. */
  119628. animationTimeScale: number;
  119629. /** @hidden */
  119630. _cachedMaterial: Nullable<Material>;
  119631. /** @hidden */
  119632. _cachedEffect: Nullable<Effect>;
  119633. /** @hidden */
  119634. _cachedVisibility: Nullable<number>;
  119635. private _renderId;
  119636. private _frameId;
  119637. private _executeWhenReadyTimeoutId;
  119638. private _intermediateRendering;
  119639. private _viewUpdateFlag;
  119640. private _projectionUpdateFlag;
  119641. /** @hidden */
  119642. _toBeDisposed: Nullable<IDisposable>[];
  119643. private _activeRequests;
  119644. /** @hidden */
  119645. _pendingData: any[];
  119646. private _isDisposed;
  119647. /**
  119648. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  119649. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  119650. */
  119651. dispatchAllSubMeshesOfActiveMeshes: boolean;
  119652. private _activeMeshes;
  119653. private _processedMaterials;
  119654. private _renderTargets;
  119655. /** @hidden */
  119656. _activeParticleSystems: SmartArray<IParticleSystem>;
  119657. private _activeSkeletons;
  119658. private _softwareSkinnedMeshes;
  119659. private _renderingManager;
  119660. /** @hidden */
  119661. _activeAnimatables: Animatable[];
  119662. private _transformMatrix;
  119663. private _sceneUbo;
  119664. /** @hidden */
  119665. _viewMatrix: Matrix;
  119666. private _projectionMatrix;
  119667. /** @hidden */
  119668. _forcedViewPosition: Nullable<Vector3>;
  119669. /** @hidden */
  119670. _frustumPlanes: Plane[];
  119671. /**
  119672. * Gets the list of frustum planes (built from the active camera)
  119673. */
  119674. get frustumPlanes(): Plane[];
  119675. /**
  119676. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  119677. * This is useful if there are more lights that the maximum simulteanous authorized
  119678. */
  119679. requireLightSorting: boolean;
  119680. /** @hidden */
  119681. readonly useMaterialMeshMap: boolean;
  119682. /** @hidden */
  119683. readonly useClonedMeshMap: boolean;
  119684. private _externalData;
  119685. private _uid;
  119686. /**
  119687. * @hidden
  119688. * Backing store of defined scene components.
  119689. */
  119690. _components: ISceneComponent[];
  119691. /**
  119692. * @hidden
  119693. * Backing store of defined scene components.
  119694. */
  119695. _serializableComponents: ISceneSerializableComponent[];
  119696. /**
  119697. * List of components to register on the next registration step.
  119698. */
  119699. private _transientComponents;
  119700. /**
  119701. * Registers the transient components if needed.
  119702. */
  119703. private _registerTransientComponents;
  119704. /**
  119705. * @hidden
  119706. * Add a component to the scene.
  119707. * Note that the ccomponent could be registered on th next frame if this is called after
  119708. * the register component stage.
  119709. * @param component Defines the component to add to the scene
  119710. */
  119711. _addComponent(component: ISceneComponent): void;
  119712. /**
  119713. * @hidden
  119714. * Gets a component from the scene.
  119715. * @param name defines the name of the component to retrieve
  119716. * @returns the component or null if not present
  119717. */
  119718. _getComponent(name: string): Nullable<ISceneComponent>;
  119719. /**
  119720. * @hidden
  119721. * Defines the actions happening before camera updates.
  119722. */
  119723. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  119724. /**
  119725. * @hidden
  119726. * Defines the actions happening before clear the canvas.
  119727. */
  119728. _beforeClearStage: Stage<SimpleStageAction>;
  119729. /**
  119730. * @hidden
  119731. * Defines the actions when collecting render targets for the frame.
  119732. */
  119733. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119734. /**
  119735. * @hidden
  119736. * Defines the actions happening for one camera in the frame.
  119737. */
  119738. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119739. /**
  119740. * @hidden
  119741. * Defines the actions happening during the per mesh ready checks.
  119742. */
  119743. _isReadyForMeshStage: Stage<MeshStageAction>;
  119744. /**
  119745. * @hidden
  119746. * Defines the actions happening before evaluate active mesh checks.
  119747. */
  119748. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  119749. /**
  119750. * @hidden
  119751. * Defines the actions happening during the evaluate sub mesh checks.
  119752. */
  119753. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  119754. /**
  119755. * @hidden
  119756. * Defines the actions happening during the active mesh stage.
  119757. */
  119758. _activeMeshStage: Stage<ActiveMeshStageAction>;
  119759. /**
  119760. * @hidden
  119761. * Defines the actions happening during the per camera render target step.
  119762. */
  119763. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  119764. /**
  119765. * @hidden
  119766. * Defines the actions happening just before the active camera is drawing.
  119767. */
  119768. _beforeCameraDrawStage: Stage<CameraStageAction>;
  119769. /**
  119770. * @hidden
  119771. * Defines the actions happening just before a render target is drawing.
  119772. */
  119773. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119774. /**
  119775. * @hidden
  119776. * Defines the actions happening just before a rendering group is drawing.
  119777. */
  119778. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119779. /**
  119780. * @hidden
  119781. * Defines the actions happening just before a mesh is drawing.
  119782. */
  119783. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119784. /**
  119785. * @hidden
  119786. * Defines the actions happening just after a mesh has been drawn.
  119787. */
  119788. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119789. /**
  119790. * @hidden
  119791. * Defines the actions happening just after a rendering group has been drawn.
  119792. */
  119793. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119794. /**
  119795. * @hidden
  119796. * Defines the actions happening just after the active camera has been drawn.
  119797. */
  119798. _afterCameraDrawStage: Stage<CameraStageAction>;
  119799. /**
  119800. * @hidden
  119801. * Defines the actions happening just after a render target has been drawn.
  119802. */
  119803. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119804. /**
  119805. * @hidden
  119806. * Defines the actions happening just after rendering all cameras and computing intersections.
  119807. */
  119808. _afterRenderStage: Stage<SimpleStageAction>;
  119809. /**
  119810. * @hidden
  119811. * Defines the actions happening when a pointer move event happens.
  119812. */
  119813. _pointerMoveStage: Stage<PointerMoveStageAction>;
  119814. /**
  119815. * @hidden
  119816. * Defines the actions happening when a pointer down event happens.
  119817. */
  119818. _pointerDownStage: Stage<PointerUpDownStageAction>;
  119819. /**
  119820. * @hidden
  119821. * Defines the actions happening when a pointer up event happens.
  119822. */
  119823. _pointerUpStage: Stage<PointerUpDownStageAction>;
  119824. /**
  119825. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  119826. */
  119827. private geometriesByUniqueId;
  119828. /**
  119829. * Creates a new Scene
  119830. * @param engine defines the engine to use to render this scene
  119831. * @param options defines the scene options
  119832. */
  119833. constructor(engine: Engine, options?: SceneOptions);
  119834. /**
  119835. * Gets a string identifying the name of the class
  119836. * @returns "Scene" string
  119837. */
  119838. getClassName(): string;
  119839. private _defaultMeshCandidates;
  119840. /**
  119841. * @hidden
  119842. */
  119843. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  119844. private _defaultSubMeshCandidates;
  119845. /**
  119846. * @hidden
  119847. */
  119848. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  119849. /**
  119850. * Sets the default candidate providers for the scene.
  119851. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  119852. * and getCollidingSubMeshCandidates to their default function
  119853. */
  119854. setDefaultCandidateProviders(): void;
  119855. /**
  119856. * Gets the mesh that is currently under the pointer
  119857. */
  119858. get meshUnderPointer(): Nullable<AbstractMesh>;
  119859. /**
  119860. * Gets or sets the current on-screen X position of the pointer
  119861. */
  119862. get pointerX(): number;
  119863. set pointerX(value: number);
  119864. /**
  119865. * Gets or sets the current on-screen Y position of the pointer
  119866. */
  119867. get pointerY(): number;
  119868. set pointerY(value: number);
  119869. /**
  119870. * Gets the cached material (ie. the latest rendered one)
  119871. * @returns the cached material
  119872. */
  119873. getCachedMaterial(): Nullable<Material>;
  119874. /**
  119875. * Gets the cached effect (ie. the latest rendered one)
  119876. * @returns the cached effect
  119877. */
  119878. getCachedEffect(): Nullable<Effect>;
  119879. /**
  119880. * Gets the cached visibility state (ie. the latest rendered one)
  119881. * @returns the cached visibility state
  119882. */
  119883. getCachedVisibility(): Nullable<number>;
  119884. /**
  119885. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  119886. * @param material defines the current material
  119887. * @param effect defines the current effect
  119888. * @param visibility defines the current visibility state
  119889. * @returns true if one parameter is not cached
  119890. */
  119891. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  119892. /**
  119893. * Gets the engine associated with the scene
  119894. * @returns an Engine
  119895. */
  119896. getEngine(): Engine;
  119897. /**
  119898. * Gets the total number of vertices rendered per frame
  119899. * @returns the total number of vertices rendered per frame
  119900. */
  119901. getTotalVertices(): number;
  119902. /**
  119903. * Gets the performance counter for total vertices
  119904. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119905. */
  119906. get totalVerticesPerfCounter(): PerfCounter;
  119907. /**
  119908. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  119909. * @returns the total number of active indices rendered per frame
  119910. */
  119911. getActiveIndices(): number;
  119912. /**
  119913. * Gets the performance counter for active indices
  119914. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119915. */
  119916. get totalActiveIndicesPerfCounter(): PerfCounter;
  119917. /**
  119918. * Gets the total number of active particles rendered per frame
  119919. * @returns the total number of active particles rendered per frame
  119920. */
  119921. getActiveParticles(): number;
  119922. /**
  119923. * Gets the performance counter for active particles
  119924. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119925. */
  119926. get activeParticlesPerfCounter(): PerfCounter;
  119927. /**
  119928. * Gets the total number of active bones rendered per frame
  119929. * @returns the total number of active bones rendered per frame
  119930. */
  119931. getActiveBones(): number;
  119932. /**
  119933. * Gets the performance counter for active bones
  119934. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119935. */
  119936. get activeBonesPerfCounter(): PerfCounter;
  119937. /**
  119938. * Gets the array of active meshes
  119939. * @returns an array of AbstractMesh
  119940. */
  119941. getActiveMeshes(): SmartArray<AbstractMesh>;
  119942. /**
  119943. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  119944. * @returns a number
  119945. */
  119946. getAnimationRatio(): number;
  119947. /**
  119948. * Gets an unique Id for the current render phase
  119949. * @returns a number
  119950. */
  119951. getRenderId(): number;
  119952. /**
  119953. * Gets an unique Id for the current frame
  119954. * @returns a number
  119955. */
  119956. getFrameId(): number;
  119957. /** Call this function if you want to manually increment the render Id*/
  119958. incrementRenderId(): void;
  119959. private _createUbo;
  119960. /**
  119961. * Use this method to simulate a pointer move on a mesh
  119962. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119963. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119964. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119965. * @returns the current scene
  119966. */
  119967. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119968. /**
  119969. * Use this method to simulate a pointer down on a mesh
  119970. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119971. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119972. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119973. * @returns the current scene
  119974. */
  119975. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119976. /**
  119977. * Use this method to simulate a pointer up on a mesh
  119978. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119979. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119980. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119981. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  119982. * @returns the current scene
  119983. */
  119984. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  119985. /**
  119986. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  119987. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  119988. * @returns true if the pointer was captured
  119989. */
  119990. isPointerCaptured(pointerId?: number): boolean;
  119991. /**
  119992. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  119993. * @param attachUp defines if you want to attach events to pointerup
  119994. * @param attachDown defines if you want to attach events to pointerdown
  119995. * @param attachMove defines if you want to attach events to pointermove
  119996. */
  119997. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  119998. /** Detaches all event handlers*/
  119999. detachControl(): void;
  120000. /**
  120001. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  120002. * Delay loaded resources are not taking in account
  120003. * @return true if all required resources are ready
  120004. */
  120005. isReady(): boolean;
  120006. /** Resets all cached information relative to material (including effect and visibility) */
  120007. resetCachedMaterial(): void;
  120008. /**
  120009. * Registers a function to be called before every frame render
  120010. * @param func defines the function to register
  120011. */
  120012. registerBeforeRender(func: () => void): void;
  120013. /**
  120014. * Unregisters a function called before every frame render
  120015. * @param func defines the function to unregister
  120016. */
  120017. unregisterBeforeRender(func: () => void): void;
  120018. /**
  120019. * Registers a function to be called after every frame render
  120020. * @param func defines the function to register
  120021. */
  120022. registerAfterRender(func: () => void): void;
  120023. /**
  120024. * Unregisters a function called after every frame render
  120025. * @param func defines the function to unregister
  120026. */
  120027. unregisterAfterRender(func: () => void): void;
  120028. private _executeOnceBeforeRender;
  120029. /**
  120030. * The provided function will run before render once and will be disposed afterwards.
  120031. * A timeout delay can be provided so that the function will be executed in N ms.
  120032. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  120033. * @param func The function to be executed.
  120034. * @param timeout optional delay in ms
  120035. */
  120036. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  120037. /** @hidden */
  120038. _addPendingData(data: any): void;
  120039. /** @hidden */
  120040. _removePendingData(data: any): void;
  120041. /**
  120042. * Returns the number of items waiting to be loaded
  120043. * @returns the number of items waiting to be loaded
  120044. */
  120045. getWaitingItemsCount(): number;
  120046. /**
  120047. * Returns a boolean indicating if the scene is still loading data
  120048. */
  120049. get isLoading(): boolean;
  120050. /**
  120051. * Registers a function to be executed when the scene is ready
  120052. * @param {Function} func - the function to be executed
  120053. */
  120054. executeWhenReady(func: () => void): void;
  120055. /**
  120056. * Returns a promise that resolves when the scene is ready
  120057. * @returns A promise that resolves when the scene is ready
  120058. */
  120059. whenReadyAsync(): Promise<void>;
  120060. /** @hidden */
  120061. _checkIsReady(): void;
  120062. /**
  120063. * Gets all animatable attached to the scene
  120064. */
  120065. get animatables(): Animatable[];
  120066. /**
  120067. * Resets the last animation time frame.
  120068. * Useful to override when animations start running when loading a scene for the first time.
  120069. */
  120070. resetLastAnimationTimeFrame(): void;
  120071. /**
  120072. * Gets the current view matrix
  120073. * @returns a Matrix
  120074. */
  120075. getViewMatrix(): Matrix;
  120076. /**
  120077. * Gets the current projection matrix
  120078. * @returns a Matrix
  120079. */
  120080. getProjectionMatrix(): Matrix;
  120081. /**
  120082. * Gets the current transform matrix
  120083. * @returns a Matrix made of View * Projection
  120084. */
  120085. getTransformMatrix(): Matrix;
  120086. /**
  120087. * Sets the current transform matrix
  120088. * @param viewL defines the View matrix to use
  120089. * @param projectionL defines the Projection matrix to use
  120090. * @param viewR defines the right View matrix to use (if provided)
  120091. * @param projectionR defines the right Projection matrix to use (if provided)
  120092. */
  120093. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  120094. /**
  120095. * Gets the uniform buffer used to store scene data
  120096. * @returns a UniformBuffer
  120097. */
  120098. getSceneUniformBuffer(): UniformBuffer;
  120099. /**
  120100. * Gets an unique (relatively to the current scene) Id
  120101. * @returns an unique number for the scene
  120102. */
  120103. getUniqueId(): number;
  120104. /**
  120105. * Add a mesh to the list of scene's meshes
  120106. * @param newMesh defines the mesh to add
  120107. * @param recursive if all child meshes should also be added to the scene
  120108. */
  120109. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  120110. /**
  120111. * Remove a mesh for the list of scene's meshes
  120112. * @param toRemove defines the mesh to remove
  120113. * @param recursive if all child meshes should also be removed from the scene
  120114. * @returns the index where the mesh was in the mesh list
  120115. */
  120116. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  120117. /**
  120118. * Add a transform node to the list of scene's transform nodes
  120119. * @param newTransformNode defines the transform node to add
  120120. */
  120121. addTransformNode(newTransformNode: TransformNode): void;
  120122. /**
  120123. * Remove a transform node for the list of scene's transform nodes
  120124. * @param toRemove defines the transform node to remove
  120125. * @returns the index where the transform node was in the transform node list
  120126. */
  120127. removeTransformNode(toRemove: TransformNode): number;
  120128. /**
  120129. * Remove a skeleton for the list of scene's skeletons
  120130. * @param toRemove defines the skeleton to remove
  120131. * @returns the index where the skeleton was in the skeleton list
  120132. */
  120133. removeSkeleton(toRemove: Skeleton): number;
  120134. /**
  120135. * Remove a morph target for the list of scene's morph targets
  120136. * @param toRemove defines the morph target to remove
  120137. * @returns the index where the morph target was in the morph target list
  120138. */
  120139. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  120140. /**
  120141. * Remove a light for the list of scene's lights
  120142. * @param toRemove defines the light to remove
  120143. * @returns the index where the light was in the light list
  120144. */
  120145. removeLight(toRemove: Light): number;
  120146. /**
  120147. * Remove a camera for the list of scene's cameras
  120148. * @param toRemove defines the camera to remove
  120149. * @returns the index where the camera was in the camera list
  120150. */
  120151. removeCamera(toRemove: Camera): number;
  120152. /**
  120153. * Remove a particle system for the list of scene's particle systems
  120154. * @param toRemove defines the particle system to remove
  120155. * @returns the index where the particle system was in the particle system list
  120156. */
  120157. removeParticleSystem(toRemove: IParticleSystem): number;
  120158. /**
  120159. * Remove a animation for the list of scene's animations
  120160. * @param toRemove defines the animation to remove
  120161. * @returns the index where the animation was in the animation list
  120162. */
  120163. removeAnimation(toRemove: Animation): number;
  120164. /**
  120165. * Will stop the animation of the given target
  120166. * @param target - the target
  120167. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  120168. * @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)
  120169. */
  120170. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  120171. /**
  120172. * Removes the given animation group from this scene.
  120173. * @param toRemove The animation group to remove
  120174. * @returns The index of the removed animation group
  120175. */
  120176. removeAnimationGroup(toRemove: AnimationGroup): number;
  120177. /**
  120178. * Removes the given multi-material from this scene.
  120179. * @param toRemove The multi-material to remove
  120180. * @returns The index of the removed multi-material
  120181. */
  120182. removeMultiMaterial(toRemove: MultiMaterial): number;
  120183. /**
  120184. * Removes the given material from this scene.
  120185. * @param toRemove The material to remove
  120186. * @returns The index of the removed material
  120187. */
  120188. removeMaterial(toRemove: Material): number;
  120189. /**
  120190. * Removes the given action manager from this scene.
  120191. * @param toRemove The action manager to remove
  120192. * @returns The index of the removed action manager
  120193. */
  120194. removeActionManager(toRemove: AbstractActionManager): number;
  120195. /**
  120196. * Removes the given texture from this scene.
  120197. * @param toRemove The texture to remove
  120198. * @returns The index of the removed texture
  120199. */
  120200. removeTexture(toRemove: BaseTexture): number;
  120201. /**
  120202. * Adds the given light to this scene
  120203. * @param newLight The light to add
  120204. */
  120205. addLight(newLight: Light): void;
  120206. /**
  120207. * Sorts the list list based on light priorities
  120208. */
  120209. sortLightsByPriority(): void;
  120210. /**
  120211. * Adds the given camera to this scene
  120212. * @param newCamera The camera to add
  120213. */
  120214. addCamera(newCamera: Camera): void;
  120215. /**
  120216. * Adds the given skeleton to this scene
  120217. * @param newSkeleton The skeleton to add
  120218. */
  120219. addSkeleton(newSkeleton: Skeleton): void;
  120220. /**
  120221. * Adds the given particle system to this scene
  120222. * @param newParticleSystem The particle system to add
  120223. */
  120224. addParticleSystem(newParticleSystem: IParticleSystem): void;
  120225. /**
  120226. * Adds the given animation to this scene
  120227. * @param newAnimation The animation to add
  120228. */
  120229. addAnimation(newAnimation: Animation): void;
  120230. /**
  120231. * Adds the given animation group to this scene.
  120232. * @param newAnimationGroup The animation group to add
  120233. */
  120234. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  120235. /**
  120236. * Adds the given multi-material to this scene
  120237. * @param newMultiMaterial The multi-material to add
  120238. */
  120239. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  120240. /**
  120241. * Adds the given material to this scene
  120242. * @param newMaterial The material to add
  120243. */
  120244. addMaterial(newMaterial: Material): void;
  120245. /**
  120246. * Adds the given morph target to this scene
  120247. * @param newMorphTargetManager The morph target to add
  120248. */
  120249. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  120250. /**
  120251. * Adds the given geometry to this scene
  120252. * @param newGeometry The geometry to add
  120253. */
  120254. addGeometry(newGeometry: Geometry): void;
  120255. /**
  120256. * Adds the given action manager to this scene
  120257. * @param newActionManager The action manager to add
  120258. */
  120259. addActionManager(newActionManager: AbstractActionManager): void;
  120260. /**
  120261. * Adds the given texture to this scene.
  120262. * @param newTexture The texture to add
  120263. */
  120264. addTexture(newTexture: BaseTexture): void;
  120265. /**
  120266. * Switch active camera
  120267. * @param newCamera defines the new active camera
  120268. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  120269. */
  120270. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  120271. /**
  120272. * sets the active camera of the scene using its ID
  120273. * @param id defines the camera's ID
  120274. * @return the new active camera or null if none found.
  120275. */
  120276. setActiveCameraByID(id: string): Nullable<Camera>;
  120277. /**
  120278. * sets the active camera of the scene using its name
  120279. * @param name defines the camera's name
  120280. * @returns the new active camera or null if none found.
  120281. */
  120282. setActiveCameraByName(name: string): Nullable<Camera>;
  120283. /**
  120284. * get an animation group using its name
  120285. * @param name defines the material's name
  120286. * @return the animation group or null if none found.
  120287. */
  120288. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  120289. /**
  120290. * Get a material using its unique id
  120291. * @param uniqueId defines the material's unique id
  120292. * @return the material or null if none found.
  120293. */
  120294. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  120295. /**
  120296. * get a material using its id
  120297. * @param id defines the material's ID
  120298. * @return the material or null if none found.
  120299. */
  120300. getMaterialByID(id: string): Nullable<Material>;
  120301. /**
  120302. * Gets a the last added material using a given id
  120303. * @param id defines the material's ID
  120304. * @return the last material with the given id or null if none found.
  120305. */
  120306. getLastMaterialByID(id: string): Nullable<Material>;
  120307. /**
  120308. * Gets a material using its name
  120309. * @param name defines the material's name
  120310. * @return the material or null if none found.
  120311. */
  120312. getMaterialByName(name: string): Nullable<Material>;
  120313. /**
  120314. * Get a texture using its unique id
  120315. * @param uniqueId defines the texture's unique id
  120316. * @return the texture or null if none found.
  120317. */
  120318. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  120319. /**
  120320. * Gets a camera using its id
  120321. * @param id defines the id to look for
  120322. * @returns the camera or null if not found
  120323. */
  120324. getCameraByID(id: string): Nullable<Camera>;
  120325. /**
  120326. * Gets a camera using its unique id
  120327. * @param uniqueId defines the unique id to look for
  120328. * @returns the camera or null if not found
  120329. */
  120330. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  120331. /**
  120332. * Gets a camera using its name
  120333. * @param name defines the camera's name
  120334. * @return the camera or null if none found.
  120335. */
  120336. getCameraByName(name: string): Nullable<Camera>;
  120337. /**
  120338. * Gets a bone using its id
  120339. * @param id defines the bone's id
  120340. * @return the bone or null if not found
  120341. */
  120342. getBoneByID(id: string): Nullable<Bone>;
  120343. /**
  120344. * Gets a bone using its id
  120345. * @param name defines the bone's name
  120346. * @return the bone or null if not found
  120347. */
  120348. getBoneByName(name: string): Nullable<Bone>;
  120349. /**
  120350. * Gets a light node using its name
  120351. * @param name defines the the light's name
  120352. * @return the light or null if none found.
  120353. */
  120354. getLightByName(name: string): Nullable<Light>;
  120355. /**
  120356. * Gets a light node using its id
  120357. * @param id defines the light's id
  120358. * @return the light or null if none found.
  120359. */
  120360. getLightByID(id: string): Nullable<Light>;
  120361. /**
  120362. * Gets a light node using its scene-generated unique ID
  120363. * @param uniqueId defines the light's unique id
  120364. * @return the light or null if none found.
  120365. */
  120366. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  120367. /**
  120368. * Gets a particle system by id
  120369. * @param id defines the particle system id
  120370. * @return the corresponding system or null if none found
  120371. */
  120372. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  120373. /**
  120374. * Gets a geometry using its ID
  120375. * @param id defines the geometry's id
  120376. * @return the geometry or null if none found.
  120377. */
  120378. getGeometryByID(id: string): Nullable<Geometry>;
  120379. private _getGeometryByUniqueID;
  120380. /**
  120381. * Add a new geometry to this scene
  120382. * @param geometry defines the geometry to be added to the scene.
  120383. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  120384. * @return a boolean defining if the geometry was added or not
  120385. */
  120386. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  120387. /**
  120388. * Removes an existing geometry
  120389. * @param geometry defines the geometry to be removed from the scene
  120390. * @return a boolean defining if the geometry was removed or not
  120391. */
  120392. removeGeometry(geometry: Geometry): boolean;
  120393. /**
  120394. * Gets the list of geometries attached to the scene
  120395. * @returns an array of Geometry
  120396. */
  120397. getGeometries(): Geometry[];
  120398. /**
  120399. * Gets the first added mesh found of a given ID
  120400. * @param id defines the id to search for
  120401. * @return the mesh found or null if not found at all
  120402. */
  120403. getMeshByID(id: string): Nullable<AbstractMesh>;
  120404. /**
  120405. * Gets a list of meshes using their id
  120406. * @param id defines the id to search for
  120407. * @returns a list of meshes
  120408. */
  120409. getMeshesByID(id: string): Array<AbstractMesh>;
  120410. /**
  120411. * Gets the first added transform node found of a given ID
  120412. * @param id defines the id to search for
  120413. * @return the found transform node or null if not found at all.
  120414. */
  120415. getTransformNodeByID(id: string): Nullable<TransformNode>;
  120416. /**
  120417. * Gets a transform node with its auto-generated unique id
  120418. * @param uniqueId efines the unique id to search for
  120419. * @return the found transform node or null if not found at all.
  120420. */
  120421. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  120422. /**
  120423. * Gets a list of transform nodes using their id
  120424. * @param id defines the id to search for
  120425. * @returns a list of transform nodes
  120426. */
  120427. getTransformNodesByID(id: string): Array<TransformNode>;
  120428. /**
  120429. * Gets a mesh with its auto-generated unique id
  120430. * @param uniqueId defines the unique id to search for
  120431. * @return the found mesh or null if not found at all.
  120432. */
  120433. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  120434. /**
  120435. * Gets a the last added mesh using a given id
  120436. * @param id defines the id to search for
  120437. * @return the found mesh or null if not found at all.
  120438. */
  120439. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  120440. /**
  120441. * Gets a the last added node (Mesh, Camera, Light) using a given id
  120442. * @param id defines the id to search for
  120443. * @return the found node or null if not found at all
  120444. */
  120445. getLastEntryByID(id: string): Nullable<Node>;
  120446. /**
  120447. * Gets a node (Mesh, Camera, Light) using a given id
  120448. * @param id defines the id to search for
  120449. * @return the found node or null if not found at all
  120450. */
  120451. getNodeByID(id: string): Nullable<Node>;
  120452. /**
  120453. * Gets a node (Mesh, Camera, Light) using a given name
  120454. * @param name defines the name to search for
  120455. * @return the found node or null if not found at all.
  120456. */
  120457. getNodeByName(name: string): Nullable<Node>;
  120458. /**
  120459. * Gets a mesh using a given name
  120460. * @param name defines the name to search for
  120461. * @return the found mesh or null if not found at all.
  120462. */
  120463. getMeshByName(name: string): Nullable<AbstractMesh>;
  120464. /**
  120465. * Gets a transform node using a given name
  120466. * @param name defines the name to search for
  120467. * @return the found transform node or null if not found at all.
  120468. */
  120469. getTransformNodeByName(name: string): Nullable<TransformNode>;
  120470. /**
  120471. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  120472. * @param id defines the id to search for
  120473. * @return the found skeleton or null if not found at all.
  120474. */
  120475. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  120476. /**
  120477. * Gets a skeleton using a given auto generated unique id
  120478. * @param uniqueId defines the unique id to search for
  120479. * @return the found skeleton or null if not found at all.
  120480. */
  120481. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  120482. /**
  120483. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  120484. * @param id defines the id to search for
  120485. * @return the found skeleton or null if not found at all.
  120486. */
  120487. getSkeletonById(id: string): Nullable<Skeleton>;
  120488. /**
  120489. * Gets a skeleton using a given name
  120490. * @param name defines the name to search for
  120491. * @return the found skeleton or null if not found at all.
  120492. */
  120493. getSkeletonByName(name: string): Nullable<Skeleton>;
  120494. /**
  120495. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  120496. * @param id defines the id to search for
  120497. * @return the found morph target manager or null if not found at all.
  120498. */
  120499. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  120500. /**
  120501. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  120502. * @param id defines the id to search for
  120503. * @return the found morph target or null if not found at all.
  120504. */
  120505. getMorphTargetById(id: string): Nullable<MorphTarget>;
  120506. /**
  120507. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  120508. * @param name defines the name to search for
  120509. * @return the found morph target or null if not found at all.
  120510. */
  120511. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  120512. /**
  120513. * Gets a post process using a given name (if many are found, this function will pick the first one)
  120514. * @param name defines the name to search for
  120515. * @return the found post process or null if not found at all.
  120516. */
  120517. getPostProcessByName(name: string): Nullable<PostProcess>;
  120518. /**
  120519. * Gets a boolean indicating if the given mesh is active
  120520. * @param mesh defines the mesh to look for
  120521. * @returns true if the mesh is in the active list
  120522. */
  120523. isActiveMesh(mesh: AbstractMesh): boolean;
  120524. /**
  120525. * Return a unique id as a string which can serve as an identifier for the scene
  120526. */
  120527. get uid(): string;
  120528. /**
  120529. * Add an externaly attached data from its key.
  120530. * This method call will fail and return false, if such key already exists.
  120531. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  120532. * @param key the unique key that identifies the data
  120533. * @param data the data object to associate to the key for this Engine instance
  120534. * @return true if no such key were already present and the data was added successfully, false otherwise
  120535. */
  120536. addExternalData<T>(key: string, data: T): boolean;
  120537. /**
  120538. * Get an externaly attached data from its key
  120539. * @param key the unique key that identifies the data
  120540. * @return the associated data, if present (can be null), or undefined if not present
  120541. */
  120542. getExternalData<T>(key: string): Nullable<T>;
  120543. /**
  120544. * Get an externaly attached data from its key, create it using a factory if it's not already present
  120545. * @param key the unique key that identifies the data
  120546. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  120547. * @return the associated data, can be null if the factory returned null.
  120548. */
  120549. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  120550. /**
  120551. * Remove an externaly attached data from the Engine instance
  120552. * @param key the unique key that identifies the data
  120553. * @return true if the data was successfully removed, false if it doesn't exist
  120554. */
  120555. removeExternalData(key: string): boolean;
  120556. private _evaluateSubMesh;
  120557. /**
  120558. * Clear the processed materials smart array preventing retention point in material dispose.
  120559. */
  120560. freeProcessedMaterials(): void;
  120561. private _preventFreeActiveMeshesAndRenderingGroups;
  120562. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  120563. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  120564. * when disposing several meshes in a row or a hierarchy of meshes.
  120565. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  120566. */
  120567. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  120568. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  120569. /**
  120570. * Clear the active meshes smart array preventing retention point in mesh dispose.
  120571. */
  120572. freeActiveMeshes(): void;
  120573. /**
  120574. * Clear the info related to rendering groups preventing retention points during dispose.
  120575. */
  120576. freeRenderingGroups(): void;
  120577. /** @hidden */
  120578. _isInIntermediateRendering(): boolean;
  120579. /**
  120580. * Lambda returning the list of potentially active meshes.
  120581. */
  120582. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  120583. /**
  120584. * Lambda returning the list of potentially active sub meshes.
  120585. */
  120586. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  120587. /**
  120588. * Lambda returning the list of potentially intersecting sub meshes.
  120589. */
  120590. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  120591. /**
  120592. * Lambda returning the list of potentially colliding sub meshes.
  120593. */
  120594. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  120595. private _activeMeshesFrozen;
  120596. private _skipEvaluateActiveMeshesCompletely;
  120597. /**
  120598. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  120599. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  120600. * @returns the current scene
  120601. */
  120602. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  120603. /**
  120604. * Use this function to restart evaluating active meshes on every frame
  120605. * @returns the current scene
  120606. */
  120607. unfreezeActiveMeshes(): Scene;
  120608. private _evaluateActiveMeshes;
  120609. private _activeMesh;
  120610. /**
  120611. * Update the transform matrix to update from the current active camera
  120612. * @param force defines a boolean used to force the update even if cache is up to date
  120613. */
  120614. updateTransformMatrix(force?: boolean): void;
  120615. private _bindFrameBuffer;
  120616. /** @hidden */
  120617. _allowPostProcessClearColor: boolean;
  120618. /** @hidden */
  120619. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  120620. private _processSubCameras;
  120621. private _checkIntersections;
  120622. /** @hidden */
  120623. _advancePhysicsEngineStep(step: number): void;
  120624. /**
  120625. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  120626. */
  120627. getDeterministicFrameTime: () => number;
  120628. /** @hidden */
  120629. _animate(): void;
  120630. /** Execute all animations (for a frame) */
  120631. animate(): void;
  120632. /**
  120633. * Render the scene
  120634. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  120635. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  120636. */
  120637. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  120638. /**
  120639. * Freeze all materials
  120640. * A frozen material will not be updatable but should be faster to render
  120641. */
  120642. freezeMaterials(): void;
  120643. /**
  120644. * Unfreeze all materials
  120645. * A frozen material will not be updatable but should be faster to render
  120646. */
  120647. unfreezeMaterials(): void;
  120648. /**
  120649. * Releases all held ressources
  120650. */
  120651. dispose(): void;
  120652. /**
  120653. * Gets if the scene is already disposed
  120654. */
  120655. get isDisposed(): boolean;
  120656. /**
  120657. * Call this function to reduce memory footprint of the scene.
  120658. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  120659. */
  120660. clearCachedVertexData(): void;
  120661. /**
  120662. * This function will remove the local cached buffer data from texture.
  120663. * It will save memory but will prevent the texture from being rebuilt
  120664. */
  120665. cleanCachedTextureBuffer(): void;
  120666. /**
  120667. * Get the world extend vectors with an optional filter
  120668. *
  120669. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  120670. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  120671. */
  120672. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  120673. min: Vector3;
  120674. max: Vector3;
  120675. };
  120676. /**
  120677. * Creates a ray that can be used to pick in the scene
  120678. * @param x defines the x coordinate of the origin (on-screen)
  120679. * @param y defines the y coordinate of the origin (on-screen)
  120680. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120681. * @param camera defines the camera to use for the picking
  120682. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120683. * @returns a Ray
  120684. */
  120685. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  120686. /**
  120687. * Creates a ray that can be used to pick in the scene
  120688. * @param x defines the x coordinate of the origin (on-screen)
  120689. * @param y defines the y coordinate of the origin (on-screen)
  120690. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120691. * @param result defines the ray where to store the picking ray
  120692. * @param camera defines the camera to use for the picking
  120693. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120694. * @returns the current scene
  120695. */
  120696. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  120697. /**
  120698. * Creates a ray that can be used to pick in the scene
  120699. * @param x defines the x coordinate of the origin (on-screen)
  120700. * @param y defines the y coordinate of the origin (on-screen)
  120701. * @param camera defines the camera to use for the picking
  120702. * @returns a Ray
  120703. */
  120704. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  120705. /**
  120706. * Creates a ray that can be used to pick in the scene
  120707. * @param x defines the x coordinate of the origin (on-screen)
  120708. * @param y defines the y coordinate of the origin (on-screen)
  120709. * @param result defines the ray where to store the picking ray
  120710. * @param camera defines the camera to use for the picking
  120711. * @returns the current scene
  120712. */
  120713. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  120714. /** Launch a ray to try to pick a mesh in the scene
  120715. * @param x position on screen
  120716. * @param y position on screen
  120717. * @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
  120718. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120719. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120720. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120721. * @returns a PickingInfo
  120722. */
  120723. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120724. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  120725. * @param x position on screen
  120726. * @param y position on screen
  120727. * @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
  120728. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120729. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120730. * @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)
  120731. */
  120732. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  120733. /** Use the given ray to pick a mesh in the scene
  120734. * @param ray The ray to use to pick meshes
  120735. * @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
  120736. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120737. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120738. * @returns a PickingInfo
  120739. */
  120740. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120741. /**
  120742. * Launch a ray to try to pick a mesh in the scene
  120743. * @param x X position on screen
  120744. * @param y Y position on screen
  120745. * @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
  120746. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120747. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120748. * @returns an array of PickingInfo
  120749. */
  120750. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120751. /**
  120752. * Launch a ray to try to pick a mesh in the scene
  120753. * @param ray Ray to use
  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 trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120756. * @returns an array of PickingInfo
  120757. */
  120758. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120759. /**
  120760. * Force the value of meshUnderPointer
  120761. * @param mesh defines the mesh to use
  120762. * @param pointerId optional pointer id when using more than one pointer
  120763. */
  120764. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  120765. /**
  120766. * Gets the mesh under the pointer
  120767. * @returns a Mesh or null if no mesh is under the pointer
  120768. */
  120769. getPointerOverMesh(): Nullable<AbstractMesh>;
  120770. /** @hidden */
  120771. _rebuildGeometries(): void;
  120772. /** @hidden */
  120773. _rebuildTextures(): void;
  120774. private _getByTags;
  120775. /**
  120776. * Get a list of meshes by tags
  120777. * @param tagsQuery defines the tags query to use
  120778. * @param forEach defines a predicate used to filter results
  120779. * @returns an array of Mesh
  120780. */
  120781. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  120782. /**
  120783. * Get a list of cameras by tags
  120784. * @param tagsQuery defines the tags query to use
  120785. * @param forEach defines a predicate used to filter results
  120786. * @returns an array of Camera
  120787. */
  120788. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  120789. /**
  120790. * Get a list of lights by tags
  120791. * @param tagsQuery defines the tags query to use
  120792. * @param forEach defines a predicate used to filter results
  120793. * @returns an array of Light
  120794. */
  120795. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  120796. /**
  120797. * Get a list of materials by tags
  120798. * @param tagsQuery defines the tags query to use
  120799. * @param forEach defines a predicate used to filter results
  120800. * @returns an array of Material
  120801. */
  120802. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  120803. /**
  120804. * Get a list of transform nodes by tags
  120805. * @param tagsQuery defines the tags query to use
  120806. * @param forEach defines a predicate used to filter results
  120807. * @returns an array of TransformNode
  120808. */
  120809. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  120810. /**
  120811. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  120812. * This allowed control for front to back rendering or reversly depending of the special needs.
  120813. *
  120814. * @param renderingGroupId The rendering group id corresponding to its index
  120815. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  120816. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  120817. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  120818. */
  120819. 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;
  120820. /**
  120821. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  120822. *
  120823. * @param renderingGroupId The rendering group id corresponding to its index
  120824. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  120825. * @param depth Automatically clears depth between groups if true and autoClear is true.
  120826. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  120827. */
  120828. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  120829. /**
  120830. * Gets the current auto clear configuration for one rendering group of the rendering
  120831. * manager.
  120832. * @param index the rendering group index to get the information for
  120833. * @returns The auto clear setup for the requested rendering group
  120834. */
  120835. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  120836. private _blockMaterialDirtyMechanism;
  120837. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  120838. get blockMaterialDirtyMechanism(): boolean;
  120839. set blockMaterialDirtyMechanism(value: boolean);
  120840. /**
  120841. * Will flag all materials as dirty to trigger new shader compilation
  120842. * @param flag defines the flag used to specify which material part must be marked as dirty
  120843. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  120844. */
  120845. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  120846. /** @hidden */
  120847. _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;
  120848. /** @hidden */
  120849. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120850. /** @hidden */
  120851. _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;
  120852. /** @hidden */
  120853. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  120854. /** @hidden */
  120855. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  120856. /** @hidden */
  120857. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120858. }
  120859. }
  120860. declare module BABYLON {
  120861. /**
  120862. * Set of assets to keep when moving a scene into an asset container.
  120863. */
  120864. export class KeepAssets extends AbstractScene {
  120865. }
  120866. /**
  120867. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  120868. */
  120869. export class InstantiatedEntries {
  120870. /**
  120871. * List of new root nodes (eg. nodes with no parent)
  120872. */
  120873. rootNodes: TransformNode[];
  120874. /**
  120875. * List of new skeletons
  120876. */
  120877. skeletons: Skeleton[];
  120878. /**
  120879. * List of new animation groups
  120880. */
  120881. animationGroups: AnimationGroup[];
  120882. }
  120883. /**
  120884. * Container with a set of assets that can be added or removed from a scene.
  120885. */
  120886. export class AssetContainer extends AbstractScene {
  120887. private _wasAddedToScene;
  120888. /**
  120889. * The scene the AssetContainer belongs to.
  120890. */
  120891. scene: Scene;
  120892. /**
  120893. * Instantiates an AssetContainer.
  120894. * @param scene The scene the AssetContainer belongs to.
  120895. */
  120896. constructor(scene: Scene);
  120897. /**
  120898. * Instantiate or clone all meshes and add the new ones to the scene.
  120899. * Skeletons and animation groups will all be cloned
  120900. * @param nameFunction defines an optional function used to get new names for clones
  120901. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  120902. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  120903. */
  120904. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  120905. /**
  120906. * Adds all the assets from the container to the scene.
  120907. */
  120908. addAllToScene(): void;
  120909. /**
  120910. * Removes all the assets in the container from the scene
  120911. */
  120912. removeAllFromScene(): void;
  120913. /**
  120914. * Disposes all the assets in the container
  120915. */
  120916. dispose(): void;
  120917. private _moveAssets;
  120918. /**
  120919. * Removes all the assets contained in the scene and adds them to the container.
  120920. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  120921. */
  120922. moveAllFromScene(keepAssets?: KeepAssets): void;
  120923. /**
  120924. * 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.
  120925. * @returns the root mesh
  120926. */
  120927. createRootMesh(): Mesh;
  120928. /**
  120929. * Merge animations (direct and animation groups) from this asset container into a scene
  120930. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  120931. * @param animatables set of animatables to retarget to a node from the scene
  120932. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  120933. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  120934. */
  120935. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  120936. }
  120937. }
  120938. declare module BABYLON {
  120939. /**
  120940. * Defines how the parser contract is defined.
  120941. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  120942. */
  120943. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  120944. /**
  120945. * Defines how the individual parser contract is defined.
  120946. * These parser can parse an individual asset
  120947. */
  120948. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  120949. /**
  120950. * Base class of the scene acting as a container for the different elements composing a scene.
  120951. * This class is dynamically extended by the different components of the scene increasing
  120952. * flexibility and reducing coupling
  120953. */
  120954. export abstract class AbstractScene {
  120955. /**
  120956. * Stores the list of available parsers in the application.
  120957. */
  120958. private static _BabylonFileParsers;
  120959. /**
  120960. * Stores the list of available individual parsers in the application.
  120961. */
  120962. private static _IndividualBabylonFileParsers;
  120963. /**
  120964. * Adds a parser in the list of available ones
  120965. * @param name Defines the name of the parser
  120966. * @param parser Defines the parser to add
  120967. */
  120968. static AddParser(name: string, parser: BabylonFileParser): void;
  120969. /**
  120970. * Gets a general parser from the list of avaialble ones
  120971. * @param name Defines the name of the parser
  120972. * @returns the requested parser or null
  120973. */
  120974. static GetParser(name: string): Nullable<BabylonFileParser>;
  120975. /**
  120976. * Adds n individual parser in the list of available ones
  120977. * @param name Defines the name of the parser
  120978. * @param parser Defines the parser to add
  120979. */
  120980. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  120981. /**
  120982. * Gets an individual parser from the list of avaialble ones
  120983. * @param name Defines the name of the parser
  120984. * @returns the requested parser or null
  120985. */
  120986. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  120987. /**
  120988. * Parser json data and populate both a scene and its associated container object
  120989. * @param jsonData Defines the data to parse
  120990. * @param scene Defines the scene to parse the data for
  120991. * @param container Defines the container attached to the parsing sequence
  120992. * @param rootUrl Defines the root url of the data
  120993. */
  120994. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  120995. /**
  120996. * Gets the list of root nodes (ie. nodes with no parent)
  120997. */
  120998. rootNodes: Node[];
  120999. /** All of the cameras added to this scene
  121000. * @see https://doc.babylonjs.com/babylon101/cameras
  121001. */
  121002. cameras: Camera[];
  121003. /**
  121004. * All of the lights added to this scene
  121005. * @see https://doc.babylonjs.com/babylon101/lights
  121006. */
  121007. lights: Light[];
  121008. /**
  121009. * All of the (abstract) meshes added to this scene
  121010. */
  121011. meshes: AbstractMesh[];
  121012. /**
  121013. * The list of skeletons added to the scene
  121014. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  121015. */
  121016. skeletons: Skeleton[];
  121017. /**
  121018. * All of the particle systems added to this scene
  121019. * @see https://doc.babylonjs.com/babylon101/particles
  121020. */
  121021. particleSystems: IParticleSystem[];
  121022. /**
  121023. * Gets a list of Animations associated with the scene
  121024. */
  121025. animations: Animation[];
  121026. /**
  121027. * All of the animation groups added to this scene
  121028. * @see https://doc.babylonjs.com/how_to/group
  121029. */
  121030. animationGroups: AnimationGroup[];
  121031. /**
  121032. * All of the multi-materials added to this scene
  121033. * @see https://doc.babylonjs.com/how_to/multi_materials
  121034. */
  121035. multiMaterials: MultiMaterial[];
  121036. /**
  121037. * All of the materials added to this scene
  121038. * In the context of a Scene, it is not supposed to be modified manually.
  121039. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  121040. * Note also that the order of the Material within the array is not significant and might change.
  121041. * @see https://doc.babylonjs.com/babylon101/materials
  121042. */
  121043. materials: Material[];
  121044. /**
  121045. * The list of morph target managers added to the scene
  121046. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  121047. */
  121048. morphTargetManagers: MorphTargetManager[];
  121049. /**
  121050. * The list of geometries used in the scene.
  121051. */
  121052. geometries: Geometry[];
  121053. /**
  121054. * All of the tranform nodes added to this scene
  121055. * In the context of a Scene, it is not supposed to be modified manually.
  121056. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  121057. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  121058. * @see https://doc.babylonjs.com/how_to/transformnode
  121059. */
  121060. transformNodes: TransformNode[];
  121061. /**
  121062. * ActionManagers available on the scene.
  121063. */
  121064. actionManagers: AbstractActionManager[];
  121065. /**
  121066. * Textures to keep.
  121067. */
  121068. textures: BaseTexture[];
  121069. /** @hidden */
  121070. protected _environmentTexture: Nullable<BaseTexture>;
  121071. /**
  121072. * Texture used in all pbr material as the reflection texture.
  121073. * As in the majority of the scene they are the same (exception for multi room and so on),
  121074. * this is easier to reference from here than from all the materials.
  121075. */
  121076. get environmentTexture(): Nullable<BaseTexture>;
  121077. set environmentTexture(value: Nullable<BaseTexture>);
  121078. /**
  121079. * The list of postprocesses added to the scene
  121080. */
  121081. postProcesses: PostProcess[];
  121082. /**
  121083. * @returns all meshes, lights, cameras, transformNodes and bones
  121084. */
  121085. getNodes(): Array<Node>;
  121086. }
  121087. }
  121088. declare module BABYLON {
  121089. /**
  121090. * Interface used to define options for Sound class
  121091. */
  121092. export interface ISoundOptions {
  121093. /**
  121094. * Does the sound autoplay once loaded.
  121095. */
  121096. autoplay?: boolean;
  121097. /**
  121098. * Does the sound loop after it finishes playing once.
  121099. */
  121100. loop?: boolean;
  121101. /**
  121102. * Sound's volume
  121103. */
  121104. volume?: number;
  121105. /**
  121106. * Is it a spatial sound?
  121107. */
  121108. spatialSound?: boolean;
  121109. /**
  121110. * Maximum distance to hear that sound
  121111. */
  121112. maxDistance?: number;
  121113. /**
  121114. * Uses user defined attenuation function
  121115. */
  121116. useCustomAttenuation?: boolean;
  121117. /**
  121118. * Define the roll off factor of spatial sounds.
  121119. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121120. */
  121121. rolloffFactor?: number;
  121122. /**
  121123. * Define the reference distance the sound should be heard perfectly.
  121124. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121125. */
  121126. refDistance?: number;
  121127. /**
  121128. * Define the distance attenuation model the sound will follow.
  121129. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121130. */
  121131. distanceModel?: string;
  121132. /**
  121133. * Defines the playback speed (1 by default)
  121134. */
  121135. playbackRate?: number;
  121136. /**
  121137. * Defines if the sound is from a streaming source
  121138. */
  121139. streaming?: boolean;
  121140. /**
  121141. * Defines an optional length (in seconds) inside the sound file
  121142. */
  121143. length?: number;
  121144. /**
  121145. * Defines an optional offset (in seconds) inside the sound file
  121146. */
  121147. offset?: number;
  121148. /**
  121149. * If true, URLs will not be required to state the audio file codec to use.
  121150. */
  121151. skipCodecCheck?: boolean;
  121152. }
  121153. /**
  121154. * Defines a sound that can be played in the application.
  121155. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  121156. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121157. */
  121158. export class Sound {
  121159. /**
  121160. * The name of the sound in the scene.
  121161. */
  121162. name: string;
  121163. /**
  121164. * Does the sound autoplay once loaded.
  121165. */
  121166. autoplay: boolean;
  121167. /**
  121168. * Does the sound loop after it finishes playing once.
  121169. */
  121170. loop: boolean;
  121171. /**
  121172. * Does the sound use a custom attenuation curve to simulate the falloff
  121173. * happening when the source gets further away from the camera.
  121174. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121175. */
  121176. useCustomAttenuation: boolean;
  121177. /**
  121178. * The sound track id this sound belongs to.
  121179. */
  121180. soundTrackId: number;
  121181. /**
  121182. * Is this sound currently played.
  121183. */
  121184. isPlaying: boolean;
  121185. /**
  121186. * Is this sound currently paused.
  121187. */
  121188. isPaused: boolean;
  121189. /**
  121190. * Does this sound enables spatial sound.
  121191. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121192. */
  121193. spatialSound: boolean;
  121194. /**
  121195. * Define the reference distance the sound should be heard perfectly.
  121196. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121197. */
  121198. refDistance: number;
  121199. /**
  121200. * Define the roll off factor of spatial sounds.
  121201. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121202. */
  121203. rolloffFactor: number;
  121204. /**
  121205. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  121206. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121207. */
  121208. maxDistance: number;
  121209. /**
  121210. * Define the distance attenuation model the sound will follow.
  121211. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121212. */
  121213. distanceModel: string;
  121214. /**
  121215. * @hidden
  121216. * Back Compat
  121217. **/
  121218. onended: () => any;
  121219. /**
  121220. * Gets or sets an object used to store user defined information for the sound.
  121221. */
  121222. metadata: any;
  121223. /**
  121224. * Observable event when the current playing sound finishes.
  121225. */
  121226. onEndedObservable: Observable<Sound>;
  121227. private _panningModel;
  121228. private _playbackRate;
  121229. private _streaming;
  121230. private _startTime;
  121231. private _startOffset;
  121232. private _position;
  121233. /** @hidden */
  121234. _positionInEmitterSpace: boolean;
  121235. private _localDirection;
  121236. private _volume;
  121237. private _isReadyToPlay;
  121238. private _isDirectional;
  121239. private _readyToPlayCallback;
  121240. private _audioBuffer;
  121241. private _soundSource;
  121242. private _streamingSource;
  121243. private _soundPanner;
  121244. private _soundGain;
  121245. private _inputAudioNode;
  121246. private _outputAudioNode;
  121247. private _coneInnerAngle;
  121248. private _coneOuterAngle;
  121249. private _coneOuterGain;
  121250. private _scene;
  121251. private _connectedTransformNode;
  121252. private _customAttenuationFunction;
  121253. private _registerFunc;
  121254. private _isOutputConnected;
  121255. private _htmlAudioElement;
  121256. private _urlType;
  121257. private _length?;
  121258. private _offset?;
  121259. /** @hidden */
  121260. static _SceneComponentInitialization: (scene: Scene) => void;
  121261. /**
  121262. * Create a sound and attach it to a scene
  121263. * @param name Name of your sound
  121264. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  121265. * @param scene defines the scene the sound belongs to
  121266. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  121267. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  121268. */
  121269. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  121270. /**
  121271. * Release the sound and its associated resources
  121272. */
  121273. dispose(): void;
  121274. /**
  121275. * Gets if the sounds is ready to be played or not.
  121276. * @returns true if ready, otherwise false
  121277. */
  121278. isReady(): boolean;
  121279. private _soundLoaded;
  121280. /**
  121281. * Sets the data of the sound from an audiobuffer
  121282. * @param audioBuffer The audioBuffer containing the data
  121283. */
  121284. setAudioBuffer(audioBuffer: AudioBuffer): void;
  121285. /**
  121286. * Updates the current sounds options such as maxdistance, loop...
  121287. * @param options A JSON object containing values named as the object properties
  121288. */
  121289. updateOptions(options: ISoundOptions): void;
  121290. private _createSpatialParameters;
  121291. private _updateSpatialParameters;
  121292. /**
  121293. * Switch the panning model to HRTF:
  121294. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121295. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121296. */
  121297. switchPanningModelToHRTF(): void;
  121298. /**
  121299. * Switch the panning model to Equal Power:
  121300. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121301. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121302. */
  121303. switchPanningModelToEqualPower(): void;
  121304. private _switchPanningModel;
  121305. /**
  121306. * Connect this sound to a sound track audio node like gain...
  121307. * @param soundTrackAudioNode the sound track audio node to connect to
  121308. */
  121309. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  121310. /**
  121311. * Transform this sound into a directional source
  121312. * @param coneInnerAngle Size of the inner cone in degree
  121313. * @param coneOuterAngle Size of the outer cone in degree
  121314. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  121315. */
  121316. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  121317. /**
  121318. * Gets or sets the inner angle for the directional cone.
  121319. */
  121320. get directionalConeInnerAngle(): number;
  121321. /**
  121322. * Gets or sets the inner angle for the directional cone.
  121323. */
  121324. set directionalConeInnerAngle(value: number);
  121325. /**
  121326. * Gets or sets the outer angle for the directional cone.
  121327. */
  121328. get directionalConeOuterAngle(): number;
  121329. /**
  121330. * Gets or sets the outer angle for the directional cone.
  121331. */
  121332. set directionalConeOuterAngle(value: number);
  121333. /**
  121334. * Sets the position of the emitter if spatial sound is enabled
  121335. * @param newPosition Defines the new posisiton
  121336. */
  121337. setPosition(newPosition: Vector3): void;
  121338. /**
  121339. * Sets the local direction of the emitter if spatial sound is enabled
  121340. * @param newLocalDirection Defines the new local direction
  121341. */
  121342. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  121343. private _updateDirection;
  121344. /** @hidden */
  121345. updateDistanceFromListener(): void;
  121346. /**
  121347. * Sets a new custom attenuation function for the sound.
  121348. * @param callback Defines the function used for the attenuation
  121349. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121350. */
  121351. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  121352. /**
  121353. * Play the sound
  121354. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  121355. * @param offset (optional) Start the sound at a specific time in seconds
  121356. * @param length (optional) Sound duration (in seconds)
  121357. */
  121358. play(time?: number, offset?: number, length?: number): void;
  121359. private _onended;
  121360. /**
  121361. * Stop the sound
  121362. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  121363. */
  121364. stop(time?: number): void;
  121365. /**
  121366. * Put the sound in pause
  121367. */
  121368. pause(): void;
  121369. /**
  121370. * Sets a dedicated volume for this sounds
  121371. * @param newVolume Define the new volume of the sound
  121372. * @param time Define time for gradual change to new volume
  121373. */
  121374. setVolume(newVolume: number, time?: number): void;
  121375. /**
  121376. * Set the sound play back rate
  121377. * @param newPlaybackRate Define the playback rate the sound should be played at
  121378. */
  121379. setPlaybackRate(newPlaybackRate: number): void;
  121380. /**
  121381. * Gets the volume of the sound.
  121382. * @returns the volume of the sound
  121383. */
  121384. getVolume(): number;
  121385. /**
  121386. * Attach the sound to a dedicated mesh
  121387. * @param transformNode The transform node to connect the sound with
  121388. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121389. */
  121390. attachToMesh(transformNode: TransformNode): void;
  121391. /**
  121392. * Detach the sound from the previously attached mesh
  121393. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121394. */
  121395. detachFromMesh(): void;
  121396. private _onRegisterAfterWorldMatrixUpdate;
  121397. /**
  121398. * Clone the current sound in the scene.
  121399. * @returns the new sound clone
  121400. */
  121401. clone(): Nullable<Sound>;
  121402. /**
  121403. * Gets the current underlying audio buffer containing the data
  121404. * @returns the audio buffer
  121405. */
  121406. getAudioBuffer(): Nullable<AudioBuffer>;
  121407. /**
  121408. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  121409. * @returns the source node
  121410. */
  121411. getSoundSource(): Nullable<AudioBufferSourceNode>;
  121412. /**
  121413. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  121414. * @returns the gain node
  121415. */
  121416. getSoundGain(): Nullable<GainNode>;
  121417. /**
  121418. * Serializes the Sound in a JSON representation
  121419. * @returns the JSON representation of the sound
  121420. */
  121421. serialize(): any;
  121422. /**
  121423. * Parse a JSON representation of a sound to innstantiate in a given scene
  121424. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  121425. * @param scene Define the scene the new parsed sound should be created in
  121426. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  121427. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  121428. * @returns the newly parsed sound
  121429. */
  121430. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  121431. }
  121432. }
  121433. declare module BABYLON {
  121434. /**
  121435. * This defines an action helpful to play a defined sound on a triggered action.
  121436. */
  121437. export class PlaySoundAction extends Action {
  121438. private _sound;
  121439. /**
  121440. * Instantiate the action
  121441. * @param triggerOptions defines the trigger options
  121442. * @param sound defines the sound to play
  121443. * @param condition defines the trigger related conditions
  121444. */
  121445. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121446. /** @hidden */
  121447. _prepare(): void;
  121448. /**
  121449. * Execute the action and play the sound.
  121450. */
  121451. execute(): void;
  121452. /**
  121453. * Serializes the actions and its related information.
  121454. * @param parent defines the object to serialize in
  121455. * @returns the serialized object
  121456. */
  121457. serialize(parent: any): any;
  121458. }
  121459. /**
  121460. * This defines an action helpful to stop a defined sound on a triggered action.
  121461. */
  121462. export class StopSoundAction extends Action {
  121463. private _sound;
  121464. /**
  121465. * Instantiate the action
  121466. * @param triggerOptions defines the trigger options
  121467. * @param sound defines the sound to stop
  121468. * @param condition defines the trigger related conditions
  121469. */
  121470. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121471. /** @hidden */
  121472. _prepare(): void;
  121473. /**
  121474. * Execute the action and stop the sound.
  121475. */
  121476. execute(): void;
  121477. /**
  121478. * Serializes the actions and its related information.
  121479. * @param parent defines the object to serialize in
  121480. * @returns the serialized object
  121481. */
  121482. serialize(parent: any): any;
  121483. }
  121484. }
  121485. declare module BABYLON {
  121486. /**
  121487. * This defines an action responsible to change the value of a property
  121488. * by interpolating between its current value and the newly set one once triggered.
  121489. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  121490. */
  121491. export class InterpolateValueAction extends Action {
  121492. /**
  121493. * Defines the path of the property where the value should be interpolated
  121494. */
  121495. propertyPath: string;
  121496. /**
  121497. * Defines the target value at the end of the interpolation.
  121498. */
  121499. value: any;
  121500. /**
  121501. * Defines the time it will take for the property to interpolate to the value.
  121502. */
  121503. duration: number;
  121504. /**
  121505. * Defines if the other scene animations should be stopped when the action has been triggered
  121506. */
  121507. stopOtherAnimations?: boolean;
  121508. /**
  121509. * Defines a callback raised once the interpolation animation has been done.
  121510. */
  121511. onInterpolationDone?: () => void;
  121512. /**
  121513. * Observable triggered once the interpolation animation has been done.
  121514. */
  121515. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  121516. private _target;
  121517. private _effectiveTarget;
  121518. private _property;
  121519. /**
  121520. * Instantiate the action
  121521. * @param triggerOptions defines the trigger options
  121522. * @param target defines the object containing the value to interpolate
  121523. * @param propertyPath defines the path to the property in the target object
  121524. * @param value defines the target value at the end of the interpolation
  121525. * @param duration deines the time it will take for the property to interpolate to the value.
  121526. * @param condition defines the trigger related conditions
  121527. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  121528. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  121529. */
  121530. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  121531. /** @hidden */
  121532. _prepare(): void;
  121533. /**
  121534. * Execute the action starts the value interpolation.
  121535. */
  121536. execute(): void;
  121537. /**
  121538. * Serializes the actions and its related information.
  121539. * @param parent defines the object to serialize in
  121540. * @returns the serialized object
  121541. */
  121542. serialize(parent: any): any;
  121543. }
  121544. }
  121545. declare module BABYLON {
  121546. /**
  121547. * Options allowed during the creation of a sound track.
  121548. */
  121549. export interface ISoundTrackOptions {
  121550. /**
  121551. * The volume the sound track should take during creation
  121552. */
  121553. volume?: number;
  121554. /**
  121555. * Define if the sound track is the main sound track of the scene
  121556. */
  121557. mainTrack?: boolean;
  121558. }
  121559. /**
  121560. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  121561. * It will be also used in a future release to apply effects on a specific track.
  121562. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121563. */
  121564. export class SoundTrack {
  121565. /**
  121566. * The unique identifier of the sound track in the scene.
  121567. */
  121568. id: number;
  121569. /**
  121570. * The list of sounds included in the sound track.
  121571. */
  121572. soundCollection: Array<Sound>;
  121573. private _outputAudioNode;
  121574. private _scene;
  121575. private _connectedAnalyser;
  121576. private _options;
  121577. private _isInitialized;
  121578. /**
  121579. * Creates a new sound track.
  121580. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121581. * @param scene Define the scene the sound track belongs to
  121582. * @param options
  121583. */
  121584. constructor(scene: Scene, options?: ISoundTrackOptions);
  121585. private _initializeSoundTrackAudioGraph;
  121586. /**
  121587. * Release the sound track and its associated resources
  121588. */
  121589. dispose(): void;
  121590. /**
  121591. * Adds a sound to this sound track
  121592. * @param sound define the cound to add
  121593. * @ignoreNaming
  121594. */
  121595. AddSound(sound: Sound): void;
  121596. /**
  121597. * Removes a sound to this sound track
  121598. * @param sound define the cound to remove
  121599. * @ignoreNaming
  121600. */
  121601. RemoveSound(sound: Sound): void;
  121602. /**
  121603. * Set a global volume for the full sound track.
  121604. * @param newVolume Define the new volume of the sound track
  121605. */
  121606. setVolume(newVolume: number): void;
  121607. /**
  121608. * Switch the panning model to HRTF:
  121609. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121610. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121611. */
  121612. switchPanningModelToHRTF(): void;
  121613. /**
  121614. * Switch the panning model to Equal Power:
  121615. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121616. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121617. */
  121618. switchPanningModelToEqualPower(): void;
  121619. /**
  121620. * Connect the sound track to an audio analyser allowing some amazing
  121621. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  121622. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  121623. * @param analyser The analyser to connect to the engine
  121624. */
  121625. connectToAnalyser(analyser: Analyser): void;
  121626. }
  121627. }
  121628. declare module BABYLON {
  121629. interface AbstractScene {
  121630. /**
  121631. * The list of sounds used in the scene.
  121632. */
  121633. sounds: Nullable<Array<Sound>>;
  121634. }
  121635. interface Scene {
  121636. /**
  121637. * @hidden
  121638. * Backing field
  121639. */
  121640. _mainSoundTrack: SoundTrack;
  121641. /**
  121642. * The main sound track played by the scene.
  121643. * It cotains your primary collection of sounds.
  121644. */
  121645. mainSoundTrack: SoundTrack;
  121646. /**
  121647. * The list of sound tracks added to the scene
  121648. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121649. */
  121650. soundTracks: Nullable<Array<SoundTrack>>;
  121651. /**
  121652. * Gets a sound using a given name
  121653. * @param name defines the name to search for
  121654. * @return the found sound or null if not found at all.
  121655. */
  121656. getSoundByName(name: string): Nullable<Sound>;
  121657. /**
  121658. * Gets or sets if audio support is enabled
  121659. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121660. */
  121661. audioEnabled: boolean;
  121662. /**
  121663. * Gets or sets if audio will be output to headphones
  121664. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121665. */
  121666. headphone: boolean;
  121667. /**
  121668. * Gets or sets custom audio listener position provider
  121669. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121670. */
  121671. audioListenerPositionProvider: Nullable<() => Vector3>;
  121672. /**
  121673. * Gets or sets a refresh rate when using 3D audio positioning
  121674. */
  121675. audioPositioningRefreshRate: number;
  121676. }
  121677. /**
  121678. * Defines the sound scene component responsible to manage any sounds
  121679. * in a given scene.
  121680. */
  121681. export class AudioSceneComponent implements ISceneSerializableComponent {
  121682. /**
  121683. * The component name helpfull to identify the component in the list of scene components.
  121684. */
  121685. readonly name: string;
  121686. /**
  121687. * The scene the component belongs to.
  121688. */
  121689. scene: Scene;
  121690. private _audioEnabled;
  121691. /**
  121692. * Gets whether audio is enabled or not.
  121693. * Please use related enable/disable method to switch state.
  121694. */
  121695. get audioEnabled(): boolean;
  121696. private _headphone;
  121697. /**
  121698. * Gets whether audio is outputing to headphone or not.
  121699. * Please use the according Switch methods to change output.
  121700. */
  121701. get headphone(): boolean;
  121702. /**
  121703. * Gets or sets a refresh rate when using 3D audio positioning
  121704. */
  121705. audioPositioningRefreshRate: number;
  121706. private _audioListenerPositionProvider;
  121707. /**
  121708. * Gets the current audio listener position provider
  121709. */
  121710. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  121711. /**
  121712. * Sets a custom listener position for all sounds in the scene
  121713. * By default, this is the position of the first active camera
  121714. */
  121715. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  121716. /**
  121717. * Creates a new instance of the component for the given scene
  121718. * @param scene Defines the scene to register the component in
  121719. */
  121720. constructor(scene: Scene);
  121721. /**
  121722. * Registers the component in a given scene
  121723. */
  121724. register(): void;
  121725. /**
  121726. * Rebuilds the elements related to this component in case of
  121727. * context lost for instance.
  121728. */
  121729. rebuild(): void;
  121730. /**
  121731. * Serializes the component data to the specified json object
  121732. * @param serializationObject The object to serialize to
  121733. */
  121734. serialize(serializationObject: any): void;
  121735. /**
  121736. * Adds all the elements from the container to the scene
  121737. * @param container the container holding the elements
  121738. */
  121739. addFromContainer(container: AbstractScene): void;
  121740. /**
  121741. * Removes all the elements in the container from the scene
  121742. * @param container contains the elements to remove
  121743. * @param dispose if the removed element should be disposed (default: false)
  121744. */
  121745. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  121746. /**
  121747. * Disposes the component and the associated ressources.
  121748. */
  121749. dispose(): void;
  121750. /**
  121751. * Disables audio in the associated scene.
  121752. */
  121753. disableAudio(): void;
  121754. /**
  121755. * Enables audio in the associated scene.
  121756. */
  121757. enableAudio(): void;
  121758. /**
  121759. * Switch audio to headphone output.
  121760. */
  121761. switchAudioModeForHeadphones(): void;
  121762. /**
  121763. * Switch audio to normal speakers.
  121764. */
  121765. switchAudioModeForNormalSpeakers(): void;
  121766. private _cachedCameraDirection;
  121767. private _cachedCameraPosition;
  121768. private _lastCheck;
  121769. private _afterRender;
  121770. }
  121771. }
  121772. declare module BABYLON {
  121773. /**
  121774. * Wraps one or more Sound objects and selects one with random weight for playback.
  121775. */
  121776. export class WeightedSound {
  121777. /** When true a Sound will be selected and played when the current playing Sound completes. */
  121778. loop: boolean;
  121779. private _coneInnerAngle;
  121780. private _coneOuterAngle;
  121781. private _volume;
  121782. /** A Sound is currently playing. */
  121783. isPlaying: boolean;
  121784. /** A Sound is currently paused. */
  121785. isPaused: boolean;
  121786. private _sounds;
  121787. private _weights;
  121788. private _currentIndex?;
  121789. /**
  121790. * Creates a new WeightedSound from the list of sounds given.
  121791. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  121792. * @param sounds Array of Sounds that will be selected from.
  121793. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  121794. */
  121795. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  121796. /**
  121797. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  121798. */
  121799. get directionalConeInnerAngle(): number;
  121800. /**
  121801. * The size of cone in degress for a directional sound in which there will be no attenuation.
  121802. */
  121803. set directionalConeInnerAngle(value: number);
  121804. /**
  121805. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121806. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121807. */
  121808. get directionalConeOuterAngle(): number;
  121809. /**
  121810. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121811. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121812. */
  121813. set directionalConeOuterAngle(value: number);
  121814. /**
  121815. * Playback volume.
  121816. */
  121817. get volume(): number;
  121818. /**
  121819. * Playback volume.
  121820. */
  121821. set volume(value: number);
  121822. private _onended;
  121823. /**
  121824. * Suspend playback
  121825. */
  121826. pause(): void;
  121827. /**
  121828. * Stop playback
  121829. */
  121830. stop(): void;
  121831. /**
  121832. * Start playback.
  121833. * @param startOffset Position the clip head at a specific time in seconds.
  121834. */
  121835. play(startOffset?: number): void;
  121836. }
  121837. }
  121838. declare module BABYLON {
  121839. /**
  121840. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  121841. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  121842. */
  121843. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  121844. /**
  121845. * Gets the name of the behavior.
  121846. */
  121847. get name(): string;
  121848. /**
  121849. * The easing function used by animations
  121850. */
  121851. static EasingFunction: BackEase;
  121852. /**
  121853. * The easing mode used by animations
  121854. */
  121855. static EasingMode: number;
  121856. /**
  121857. * The duration of the animation, in milliseconds
  121858. */
  121859. transitionDuration: number;
  121860. /**
  121861. * Length of the distance animated by the transition when lower radius is reached
  121862. */
  121863. lowerRadiusTransitionRange: number;
  121864. /**
  121865. * Length of the distance animated by the transition when upper radius is reached
  121866. */
  121867. upperRadiusTransitionRange: number;
  121868. private _autoTransitionRange;
  121869. /**
  121870. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121871. */
  121872. get autoTransitionRange(): boolean;
  121873. /**
  121874. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121875. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  121876. */
  121877. set autoTransitionRange(value: boolean);
  121878. private _attachedCamera;
  121879. private _onAfterCheckInputsObserver;
  121880. private _onMeshTargetChangedObserver;
  121881. /**
  121882. * Initializes the behavior.
  121883. */
  121884. init(): void;
  121885. /**
  121886. * Attaches the behavior to its arc rotate camera.
  121887. * @param camera Defines the camera to attach the behavior to
  121888. */
  121889. attach(camera: ArcRotateCamera): void;
  121890. /**
  121891. * Detaches the behavior from its current arc rotate camera.
  121892. */
  121893. detach(): void;
  121894. private _radiusIsAnimating;
  121895. private _radiusBounceTransition;
  121896. private _animatables;
  121897. private _cachedWheelPrecision;
  121898. /**
  121899. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  121900. * @param radiusLimit The limit to check against.
  121901. * @return Bool to indicate if at limit.
  121902. */
  121903. private _isRadiusAtLimit;
  121904. /**
  121905. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  121906. * @param radiusDelta The delta by which to animate to. Can be negative.
  121907. */
  121908. private _applyBoundRadiusAnimation;
  121909. /**
  121910. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  121911. */
  121912. protected _clearAnimationLocks(): void;
  121913. /**
  121914. * Stops and removes all animations that have been applied to the camera
  121915. */
  121916. stopAllAnimations(): void;
  121917. }
  121918. }
  121919. declare module BABYLON {
  121920. /**
  121921. * 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.
  121922. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  121923. */
  121924. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  121925. /**
  121926. * Gets the name of the behavior.
  121927. */
  121928. get name(): string;
  121929. private _mode;
  121930. private _radiusScale;
  121931. private _positionScale;
  121932. private _defaultElevation;
  121933. private _elevationReturnTime;
  121934. private _elevationReturnWaitTime;
  121935. private _zoomStopsAnimation;
  121936. private _framingTime;
  121937. /**
  121938. * The easing function used by animations
  121939. */
  121940. static EasingFunction: ExponentialEase;
  121941. /**
  121942. * The easing mode used by animations
  121943. */
  121944. static EasingMode: number;
  121945. /**
  121946. * Sets the current mode used by the behavior
  121947. */
  121948. set mode(mode: number);
  121949. /**
  121950. * Gets current mode used by the behavior.
  121951. */
  121952. get mode(): number;
  121953. /**
  121954. * Sets the scale applied to the radius (1 by default)
  121955. */
  121956. set radiusScale(radius: number);
  121957. /**
  121958. * Gets the scale applied to the radius
  121959. */
  121960. get radiusScale(): number;
  121961. /**
  121962. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121963. */
  121964. set positionScale(scale: number);
  121965. /**
  121966. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121967. */
  121968. get positionScale(): number;
  121969. /**
  121970. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121971. * behaviour is triggered, in radians.
  121972. */
  121973. set defaultElevation(elevation: number);
  121974. /**
  121975. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121976. * behaviour is triggered, in radians.
  121977. */
  121978. get defaultElevation(): number;
  121979. /**
  121980. * Sets the time (in milliseconds) taken to return to the default beta position.
  121981. * Negative value indicates camera should not return to default.
  121982. */
  121983. set elevationReturnTime(speed: number);
  121984. /**
  121985. * Gets the time (in milliseconds) taken to return to the default beta position.
  121986. * Negative value indicates camera should not return to default.
  121987. */
  121988. get elevationReturnTime(): number;
  121989. /**
  121990. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  121991. */
  121992. set elevationReturnWaitTime(time: number);
  121993. /**
  121994. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  121995. */
  121996. get elevationReturnWaitTime(): number;
  121997. /**
  121998. * Sets the flag that indicates if user zooming should stop animation.
  121999. */
  122000. set zoomStopsAnimation(flag: boolean);
  122001. /**
  122002. * Gets the flag that indicates if user zooming should stop animation.
  122003. */
  122004. get zoomStopsAnimation(): boolean;
  122005. /**
  122006. * Sets the transition time when framing the mesh, in milliseconds
  122007. */
  122008. set framingTime(time: number);
  122009. /**
  122010. * Gets the transition time when framing the mesh, in milliseconds
  122011. */
  122012. get framingTime(): number;
  122013. /**
  122014. * Define if the behavior should automatically change the configured
  122015. * camera limits and sensibilities.
  122016. */
  122017. autoCorrectCameraLimitsAndSensibility: boolean;
  122018. private _onPrePointerObservableObserver;
  122019. private _onAfterCheckInputsObserver;
  122020. private _onMeshTargetChangedObserver;
  122021. private _attachedCamera;
  122022. private _isPointerDown;
  122023. private _lastInteractionTime;
  122024. /**
  122025. * Initializes the behavior.
  122026. */
  122027. init(): void;
  122028. /**
  122029. * Attaches the behavior to its arc rotate camera.
  122030. * @param camera Defines the camera to attach the behavior to
  122031. */
  122032. attach(camera: ArcRotateCamera): void;
  122033. /**
  122034. * Detaches the behavior from its current arc rotate camera.
  122035. */
  122036. detach(): void;
  122037. private _animatables;
  122038. private _betaIsAnimating;
  122039. private _betaTransition;
  122040. private _radiusTransition;
  122041. private _vectorTransition;
  122042. /**
  122043. * Targets the given mesh and updates zoom level accordingly.
  122044. * @param mesh The mesh to target.
  122045. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122046. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122047. */
  122048. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122049. /**
  122050. * Targets the given mesh with its children and updates zoom level accordingly.
  122051. * @param mesh The mesh to target.
  122052. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122053. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122054. */
  122055. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122056. /**
  122057. * Targets the given meshes with their children and updates zoom level accordingly.
  122058. * @param meshes The mesh to target.
  122059. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122060. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122061. */
  122062. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122063. /**
  122064. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  122065. * @param minimumWorld Determines the smaller position of the bounding box extend
  122066. * @param maximumWorld Determines the bigger position of the bounding box extend
  122067. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122068. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122069. */
  122070. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122071. /**
  122072. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  122073. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  122074. * frustum width.
  122075. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  122076. * to fully enclose the mesh in the viewing frustum.
  122077. */
  122078. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  122079. /**
  122080. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  122081. * is automatically returned to its default position (expected to be above ground plane).
  122082. */
  122083. private _maintainCameraAboveGround;
  122084. /**
  122085. * Returns the frustum slope based on the canvas ratio and camera FOV
  122086. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  122087. */
  122088. private _getFrustumSlope;
  122089. /**
  122090. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  122091. */
  122092. private _clearAnimationLocks;
  122093. /**
  122094. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122095. */
  122096. private _applyUserInteraction;
  122097. /**
  122098. * Stops and removes all animations that have been applied to the camera
  122099. */
  122100. stopAllAnimations(): void;
  122101. /**
  122102. * Gets a value indicating if the user is moving the camera
  122103. */
  122104. get isUserIsMoving(): boolean;
  122105. /**
  122106. * The camera can move all the way towards the mesh.
  122107. */
  122108. static IgnoreBoundsSizeMode: number;
  122109. /**
  122110. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  122111. */
  122112. static FitFrustumSidesMode: number;
  122113. }
  122114. }
  122115. declare module BABYLON {
  122116. /**
  122117. * Base class for Camera Pointer Inputs.
  122118. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  122119. * for example usage.
  122120. */
  122121. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  122122. /**
  122123. * Defines the camera the input is attached to.
  122124. */
  122125. abstract camera: Camera;
  122126. /**
  122127. * Whether keyboard modifier keys are pressed at time of last mouse event.
  122128. */
  122129. protected _altKey: boolean;
  122130. protected _ctrlKey: boolean;
  122131. protected _metaKey: boolean;
  122132. protected _shiftKey: boolean;
  122133. /**
  122134. * Which mouse buttons were pressed at time of last mouse event.
  122135. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  122136. */
  122137. protected _buttonsPressed: number;
  122138. /**
  122139. * Defines the buttons associated with the input to handle camera move.
  122140. */
  122141. buttons: number[];
  122142. /**
  122143. * Attach the input controls to a specific dom element to get the input from.
  122144. * @param element Defines the element the controls should be listened from
  122145. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122146. */
  122147. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122148. /**
  122149. * Detach the current controls from the specified dom element.
  122150. * @param element Defines the element to stop listening the inputs from
  122151. */
  122152. detachControl(element: Nullable<HTMLElement>): void;
  122153. /**
  122154. * Gets the class name of the current input.
  122155. * @returns the class name
  122156. */
  122157. getClassName(): string;
  122158. /**
  122159. * Get the friendly name associated with the input class.
  122160. * @returns the input friendly name
  122161. */
  122162. getSimpleName(): string;
  122163. /**
  122164. * Called on pointer POINTERDOUBLETAP event.
  122165. * Override this method to provide functionality on POINTERDOUBLETAP event.
  122166. */
  122167. protected onDoubleTap(type: string): void;
  122168. /**
  122169. * Called on pointer POINTERMOVE event if only a single touch is active.
  122170. * Override this method to provide functionality.
  122171. */
  122172. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122173. /**
  122174. * Called on pointer POINTERMOVE event if multiple touches are active.
  122175. * Override this method to provide functionality.
  122176. */
  122177. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122178. /**
  122179. * Called on JS contextmenu event.
  122180. * Override this method to provide functionality.
  122181. */
  122182. protected onContextMenu(evt: PointerEvent): void;
  122183. /**
  122184. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122185. * press.
  122186. * Override this method to provide functionality.
  122187. */
  122188. protected onButtonDown(evt: PointerEvent): void;
  122189. /**
  122190. * Called each time a new POINTERUP event occurs. Ie, for each button
  122191. * release.
  122192. * Override this method to provide functionality.
  122193. */
  122194. protected onButtonUp(evt: PointerEvent): void;
  122195. /**
  122196. * Called when window becomes inactive.
  122197. * Override this method to provide functionality.
  122198. */
  122199. protected onLostFocus(): void;
  122200. private _pointerInput;
  122201. private _observer;
  122202. private _onLostFocus;
  122203. private pointA;
  122204. private pointB;
  122205. }
  122206. }
  122207. declare module BABYLON {
  122208. /**
  122209. * Manage the pointers inputs to control an arc rotate camera.
  122210. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122211. */
  122212. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  122213. /**
  122214. * Defines the camera the input is attached to.
  122215. */
  122216. camera: ArcRotateCamera;
  122217. /**
  122218. * Gets the class name of the current input.
  122219. * @returns the class name
  122220. */
  122221. getClassName(): string;
  122222. /**
  122223. * Defines the buttons associated with the input to handle camera move.
  122224. */
  122225. buttons: number[];
  122226. /**
  122227. * Defines the pointer angular sensibility along the X axis or how fast is
  122228. * the camera rotating.
  122229. */
  122230. angularSensibilityX: number;
  122231. /**
  122232. * Defines the pointer angular sensibility along the Y axis or how fast is
  122233. * the camera rotating.
  122234. */
  122235. angularSensibilityY: number;
  122236. /**
  122237. * Defines the pointer pinch precision or how fast is the camera zooming.
  122238. */
  122239. pinchPrecision: number;
  122240. /**
  122241. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  122242. * from 0.
  122243. * It defines the percentage of current camera.radius to use as delta when
  122244. * pinch zoom is used.
  122245. */
  122246. pinchDeltaPercentage: number;
  122247. /**
  122248. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122249. * that any object in the plane at the camera's target point will scale
  122250. * perfectly with finger motion.
  122251. * Overrides pinchDeltaPercentage and pinchPrecision.
  122252. */
  122253. useNaturalPinchZoom: boolean;
  122254. /**
  122255. * Defines the pointer panning sensibility or how fast is the camera moving.
  122256. */
  122257. panningSensibility: number;
  122258. /**
  122259. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  122260. */
  122261. multiTouchPanning: boolean;
  122262. /**
  122263. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  122264. * zoom (pinch) through multitouch.
  122265. */
  122266. multiTouchPanAndZoom: boolean;
  122267. /**
  122268. * Revers pinch action direction.
  122269. */
  122270. pinchInwards: boolean;
  122271. private _isPanClick;
  122272. private _twoFingerActivityCount;
  122273. private _isPinching;
  122274. /**
  122275. * Called on pointer POINTERMOVE event if only a single touch is active.
  122276. */
  122277. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122278. /**
  122279. * Called on pointer POINTERDOUBLETAP event.
  122280. */
  122281. protected onDoubleTap(type: string): void;
  122282. /**
  122283. * Called on pointer POINTERMOVE event if multiple touches are active.
  122284. */
  122285. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122286. /**
  122287. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122288. * press.
  122289. */
  122290. protected onButtonDown(evt: PointerEvent): void;
  122291. /**
  122292. * Called each time a new POINTERUP event occurs. Ie, for each button
  122293. * release.
  122294. */
  122295. protected onButtonUp(evt: PointerEvent): void;
  122296. /**
  122297. * Called when window becomes inactive.
  122298. */
  122299. protected onLostFocus(): void;
  122300. }
  122301. }
  122302. declare module BABYLON {
  122303. /**
  122304. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  122305. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122306. */
  122307. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  122308. /**
  122309. * Defines the camera the input is attached to.
  122310. */
  122311. camera: ArcRotateCamera;
  122312. /**
  122313. * Defines the list of key codes associated with the up action (increase alpha)
  122314. */
  122315. keysUp: number[];
  122316. /**
  122317. * Defines the list of key codes associated with the down action (decrease alpha)
  122318. */
  122319. keysDown: number[];
  122320. /**
  122321. * Defines the list of key codes associated with the left action (increase beta)
  122322. */
  122323. keysLeft: number[];
  122324. /**
  122325. * Defines the list of key codes associated with the right action (decrease beta)
  122326. */
  122327. keysRight: number[];
  122328. /**
  122329. * Defines the list of key codes associated with the reset action.
  122330. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  122331. */
  122332. keysReset: number[];
  122333. /**
  122334. * Defines the panning sensibility of the inputs.
  122335. * (How fast is the camera panning)
  122336. */
  122337. panningSensibility: number;
  122338. /**
  122339. * Defines the zooming sensibility of the inputs.
  122340. * (How fast is the camera zooming)
  122341. */
  122342. zoomingSensibility: number;
  122343. /**
  122344. * Defines whether maintaining the alt key down switch the movement mode from
  122345. * orientation to zoom.
  122346. */
  122347. useAltToZoom: boolean;
  122348. /**
  122349. * Rotation speed of the camera
  122350. */
  122351. angularSpeed: number;
  122352. private _keys;
  122353. private _ctrlPressed;
  122354. private _altPressed;
  122355. private _onCanvasBlurObserver;
  122356. private _onKeyboardObserver;
  122357. private _engine;
  122358. private _scene;
  122359. /**
  122360. * Attach the input controls to a specific dom element to get the input from.
  122361. * @param element Defines the element the controls should be listened from
  122362. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122363. */
  122364. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122365. /**
  122366. * Detach the current controls from the specified dom element.
  122367. * @param element Defines the element to stop listening the inputs from
  122368. */
  122369. detachControl(element: Nullable<HTMLElement>): void;
  122370. /**
  122371. * Update the current camera state depending on the inputs that have been used this frame.
  122372. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122373. */
  122374. checkInputs(): void;
  122375. /**
  122376. * Gets the class name of the current intput.
  122377. * @returns the class name
  122378. */
  122379. getClassName(): string;
  122380. /**
  122381. * Get the friendly name associated with the input class.
  122382. * @returns the input friendly name
  122383. */
  122384. getSimpleName(): string;
  122385. }
  122386. }
  122387. declare module BABYLON {
  122388. /**
  122389. * Manage the mouse wheel inputs to control an arc rotate camera.
  122390. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122391. */
  122392. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  122393. /**
  122394. * Defines the camera the input is attached to.
  122395. */
  122396. camera: ArcRotateCamera;
  122397. /**
  122398. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122399. */
  122400. wheelPrecision: number;
  122401. /**
  122402. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  122403. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  122404. */
  122405. wheelDeltaPercentage: number;
  122406. private _wheel;
  122407. private _observer;
  122408. private computeDeltaFromMouseWheelLegacyEvent;
  122409. /**
  122410. * Attach the input controls to a specific dom element to get the input from.
  122411. * @param element Defines the element the controls should be listened from
  122412. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122413. */
  122414. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122415. /**
  122416. * Detach the current controls from the specified dom element.
  122417. * @param element Defines the element to stop listening the inputs from
  122418. */
  122419. detachControl(element: Nullable<HTMLElement>): void;
  122420. /**
  122421. * Gets the class name of the current intput.
  122422. * @returns the class name
  122423. */
  122424. getClassName(): string;
  122425. /**
  122426. * Get the friendly name associated with the input class.
  122427. * @returns the input friendly name
  122428. */
  122429. getSimpleName(): string;
  122430. }
  122431. }
  122432. declare module BABYLON {
  122433. /**
  122434. * Default Inputs manager for the ArcRotateCamera.
  122435. * It groups all the default supported inputs for ease of use.
  122436. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122437. */
  122438. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  122439. /**
  122440. * Instantiates a new ArcRotateCameraInputsManager.
  122441. * @param camera Defines the camera the inputs belong to
  122442. */
  122443. constructor(camera: ArcRotateCamera);
  122444. /**
  122445. * Add mouse wheel input support to the input manager.
  122446. * @returns the current input manager
  122447. */
  122448. addMouseWheel(): ArcRotateCameraInputsManager;
  122449. /**
  122450. * Add pointers input support to the input manager.
  122451. * @returns the current input manager
  122452. */
  122453. addPointers(): ArcRotateCameraInputsManager;
  122454. /**
  122455. * Add keyboard input support to the input manager.
  122456. * @returns the current input manager
  122457. */
  122458. addKeyboard(): ArcRotateCameraInputsManager;
  122459. }
  122460. }
  122461. declare module BABYLON {
  122462. /**
  122463. * This represents an orbital type of camera.
  122464. *
  122465. * 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.
  122466. * 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.
  122467. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  122468. */
  122469. export class ArcRotateCamera extends TargetCamera {
  122470. /**
  122471. * Defines the rotation angle of the camera along the longitudinal axis.
  122472. */
  122473. alpha: number;
  122474. /**
  122475. * Defines the rotation angle of the camera along the latitudinal axis.
  122476. */
  122477. beta: number;
  122478. /**
  122479. * Defines the radius of the camera from it s target point.
  122480. */
  122481. radius: number;
  122482. protected _target: Vector3;
  122483. protected _targetHost: Nullable<AbstractMesh>;
  122484. /**
  122485. * Defines the target point of the camera.
  122486. * The camera looks towards it form the radius distance.
  122487. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  122488. */
  122489. get target(): Vector3;
  122490. set target(value: Vector3);
  122491. /**
  122492. * Define the current local position of the camera in the scene
  122493. */
  122494. get position(): Vector3;
  122495. set position(newPosition: Vector3);
  122496. protected _upToYMatrix: Matrix;
  122497. protected _YToUpMatrix: Matrix;
  122498. /**
  122499. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  122500. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  122501. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  122502. */
  122503. set upVector(vec: Vector3);
  122504. get upVector(): Vector3;
  122505. /**
  122506. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  122507. */
  122508. setMatUp(): void;
  122509. /**
  122510. * Current inertia value on the longitudinal axis.
  122511. * The bigger this number the longer it will take for the camera to stop.
  122512. */
  122513. inertialAlphaOffset: number;
  122514. /**
  122515. * Current inertia value on the latitudinal axis.
  122516. * The bigger this number the longer it will take for the camera to stop.
  122517. */
  122518. inertialBetaOffset: number;
  122519. /**
  122520. * Current inertia value on the radius axis.
  122521. * The bigger this number the longer it will take for the camera to stop.
  122522. */
  122523. inertialRadiusOffset: number;
  122524. /**
  122525. * Minimum allowed angle on the longitudinal axis.
  122526. * This can help limiting how the Camera is able to move in the scene.
  122527. */
  122528. lowerAlphaLimit: Nullable<number>;
  122529. /**
  122530. * Maximum allowed angle on the longitudinal axis.
  122531. * This can help limiting how the Camera is able to move in the scene.
  122532. */
  122533. upperAlphaLimit: Nullable<number>;
  122534. /**
  122535. * Minimum allowed angle on the latitudinal axis.
  122536. * This can help limiting how the Camera is able to move in the scene.
  122537. */
  122538. lowerBetaLimit: number;
  122539. /**
  122540. * Maximum allowed angle on the latitudinal axis.
  122541. * This can help limiting how the Camera is able to move in the scene.
  122542. */
  122543. upperBetaLimit: number;
  122544. /**
  122545. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  122546. * This can help limiting how the Camera is able to move in the scene.
  122547. */
  122548. lowerRadiusLimit: Nullable<number>;
  122549. /**
  122550. * Maximum allowed distance of the camera to the target (The camera can not get further).
  122551. * This can help limiting how the Camera is able to move in the scene.
  122552. */
  122553. upperRadiusLimit: Nullable<number>;
  122554. /**
  122555. * Defines the current inertia value used during panning of the camera along the X axis.
  122556. */
  122557. inertialPanningX: number;
  122558. /**
  122559. * Defines the current inertia value used during panning of the camera along the Y axis.
  122560. */
  122561. inertialPanningY: number;
  122562. /**
  122563. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  122564. * Basically if your fingers moves away from more than this distance you will be considered
  122565. * in pinch mode.
  122566. */
  122567. pinchToPanMaxDistance: number;
  122568. /**
  122569. * Defines the maximum distance the camera can pan.
  122570. * This could help keeping the cammera always in your scene.
  122571. */
  122572. panningDistanceLimit: Nullable<number>;
  122573. /**
  122574. * Defines the target of the camera before paning.
  122575. */
  122576. panningOriginTarget: Vector3;
  122577. /**
  122578. * Defines the value of the inertia used during panning.
  122579. * 0 would mean stop inertia and one would mean no decelleration at all.
  122580. */
  122581. panningInertia: number;
  122582. /**
  122583. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  122584. */
  122585. get angularSensibilityX(): number;
  122586. set angularSensibilityX(value: number);
  122587. /**
  122588. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  122589. */
  122590. get angularSensibilityY(): number;
  122591. set angularSensibilityY(value: number);
  122592. /**
  122593. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  122594. */
  122595. get pinchPrecision(): number;
  122596. set pinchPrecision(value: number);
  122597. /**
  122598. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  122599. * It will be used instead of pinchDeltaPrecision if different from 0.
  122600. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122601. */
  122602. get pinchDeltaPercentage(): number;
  122603. set pinchDeltaPercentage(value: number);
  122604. /**
  122605. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  122606. * and pinch delta percentage.
  122607. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122608. * that any object in the plane at the camera's target point will scale
  122609. * perfectly with finger motion.
  122610. */
  122611. get useNaturalPinchZoom(): boolean;
  122612. set useNaturalPinchZoom(value: boolean);
  122613. /**
  122614. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  122615. */
  122616. get panningSensibility(): number;
  122617. set panningSensibility(value: number);
  122618. /**
  122619. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  122620. */
  122621. get keysUp(): number[];
  122622. set keysUp(value: number[]);
  122623. /**
  122624. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  122625. */
  122626. get keysDown(): number[];
  122627. set keysDown(value: number[]);
  122628. /**
  122629. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  122630. */
  122631. get keysLeft(): number[];
  122632. set keysLeft(value: number[]);
  122633. /**
  122634. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  122635. */
  122636. get keysRight(): number[];
  122637. set keysRight(value: number[]);
  122638. /**
  122639. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122640. */
  122641. get wheelPrecision(): number;
  122642. set wheelPrecision(value: number);
  122643. /**
  122644. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  122645. * It will be used instead of pinchDeltaPrecision if different from 0.
  122646. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122647. */
  122648. get wheelDeltaPercentage(): number;
  122649. set wheelDeltaPercentage(value: number);
  122650. /**
  122651. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  122652. */
  122653. zoomOnFactor: number;
  122654. /**
  122655. * Defines a screen offset for the camera position.
  122656. */
  122657. targetScreenOffset: Vector2;
  122658. /**
  122659. * Allows the camera to be completely reversed.
  122660. * If false the camera can not arrive upside down.
  122661. */
  122662. allowUpsideDown: boolean;
  122663. /**
  122664. * Define if double tap/click is used to restore the previously saved state of the camera.
  122665. */
  122666. useInputToRestoreState: boolean;
  122667. /** @hidden */
  122668. _viewMatrix: Matrix;
  122669. /** @hidden */
  122670. _useCtrlForPanning: boolean;
  122671. /** @hidden */
  122672. _panningMouseButton: number;
  122673. /**
  122674. * Defines the input associated to the camera.
  122675. */
  122676. inputs: ArcRotateCameraInputsManager;
  122677. /** @hidden */
  122678. _reset: () => void;
  122679. /**
  122680. * Defines the allowed panning axis.
  122681. */
  122682. panningAxis: Vector3;
  122683. protected _localDirection: Vector3;
  122684. protected _transformedDirection: Vector3;
  122685. private _bouncingBehavior;
  122686. /**
  122687. * Gets the bouncing behavior of the camera if it has been enabled.
  122688. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122689. */
  122690. get bouncingBehavior(): Nullable<BouncingBehavior>;
  122691. /**
  122692. * Defines if the bouncing behavior of the camera is enabled on the camera.
  122693. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122694. */
  122695. get useBouncingBehavior(): boolean;
  122696. set useBouncingBehavior(value: boolean);
  122697. private _framingBehavior;
  122698. /**
  122699. * Gets the framing behavior of the camera if it has been enabled.
  122700. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122701. */
  122702. get framingBehavior(): Nullable<FramingBehavior>;
  122703. /**
  122704. * Defines if the framing behavior of the camera is enabled on the camera.
  122705. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122706. */
  122707. get useFramingBehavior(): boolean;
  122708. set useFramingBehavior(value: boolean);
  122709. private _autoRotationBehavior;
  122710. /**
  122711. * Gets the auto rotation behavior of the camera if it has been enabled.
  122712. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122713. */
  122714. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  122715. /**
  122716. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  122717. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122718. */
  122719. get useAutoRotationBehavior(): boolean;
  122720. set useAutoRotationBehavior(value: boolean);
  122721. /**
  122722. * Observable triggered when the mesh target has been changed on the camera.
  122723. */
  122724. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  122725. /**
  122726. * Event raised when the camera is colliding with a mesh.
  122727. */
  122728. onCollide: (collidedMesh: AbstractMesh) => void;
  122729. /**
  122730. * Defines whether the camera should check collision with the objects oh the scene.
  122731. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  122732. */
  122733. checkCollisions: boolean;
  122734. /**
  122735. * Defines the collision radius of the camera.
  122736. * This simulates a sphere around the camera.
  122737. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  122738. */
  122739. collisionRadius: Vector3;
  122740. protected _collider: Collider;
  122741. protected _previousPosition: Vector3;
  122742. protected _collisionVelocity: Vector3;
  122743. protected _newPosition: Vector3;
  122744. protected _previousAlpha: number;
  122745. protected _previousBeta: number;
  122746. protected _previousRadius: number;
  122747. protected _collisionTriggered: boolean;
  122748. protected _targetBoundingCenter: Nullable<Vector3>;
  122749. private _computationVector;
  122750. /**
  122751. * Instantiates a new ArcRotateCamera in a given scene
  122752. * @param name Defines the name of the camera
  122753. * @param alpha Defines the camera rotation along the logitudinal axis
  122754. * @param beta Defines the camera rotation along the latitudinal axis
  122755. * @param radius Defines the camera distance from its target
  122756. * @param target Defines the camera target
  122757. * @param scene Defines the scene the camera belongs to
  122758. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  122759. */
  122760. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  122761. /** @hidden */
  122762. _initCache(): void;
  122763. /** @hidden */
  122764. _updateCache(ignoreParentClass?: boolean): void;
  122765. protected _getTargetPosition(): Vector3;
  122766. private _storedAlpha;
  122767. private _storedBeta;
  122768. private _storedRadius;
  122769. private _storedTarget;
  122770. private _storedTargetScreenOffset;
  122771. /**
  122772. * Stores the current state of the camera (alpha, beta, radius and target)
  122773. * @returns the camera itself
  122774. */
  122775. storeState(): Camera;
  122776. /**
  122777. * @hidden
  122778. * Restored camera state. You must call storeState() first
  122779. */
  122780. _restoreStateValues(): boolean;
  122781. /** @hidden */
  122782. _isSynchronizedViewMatrix(): boolean;
  122783. /**
  122784. * Attached controls to the current camera.
  122785. * @param element Defines the element the controls should be listened from
  122786. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122787. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  122788. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  122789. */
  122790. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  122791. /**
  122792. * Detach the current controls from the camera.
  122793. * The camera will stop reacting to inputs.
  122794. * @param element Defines the element to stop listening the inputs from
  122795. */
  122796. detachControl(element: HTMLElement): void;
  122797. /** @hidden */
  122798. _checkInputs(): void;
  122799. protected _checkLimits(): void;
  122800. /**
  122801. * Rebuilds angles (alpha, beta) and radius from the give position and target
  122802. */
  122803. rebuildAnglesAndRadius(): void;
  122804. /**
  122805. * Use a position to define the current camera related information like alpha, beta and radius
  122806. * @param position Defines the position to set the camera at
  122807. */
  122808. setPosition(position: Vector3): void;
  122809. /**
  122810. * Defines the target the camera should look at.
  122811. * This will automatically adapt alpha beta and radius to fit within the new target.
  122812. * @param target Defines the new target as a Vector or a mesh
  122813. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  122814. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  122815. */
  122816. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  122817. /** @hidden */
  122818. _getViewMatrix(): Matrix;
  122819. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  122820. /**
  122821. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  122822. * @param meshes Defines the mesh to zoom on
  122823. * @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)
  122824. */
  122825. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  122826. /**
  122827. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  122828. * The target will be changed but the radius
  122829. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  122830. * @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)
  122831. */
  122832. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  122833. min: Vector3;
  122834. max: Vector3;
  122835. distance: number;
  122836. }, doNotUpdateMaxZ?: boolean): void;
  122837. /**
  122838. * @override
  122839. * Override Camera.createRigCamera
  122840. */
  122841. createRigCamera(name: string, cameraIndex: number): Camera;
  122842. /**
  122843. * @hidden
  122844. * @override
  122845. * Override Camera._updateRigCameras
  122846. */
  122847. _updateRigCameras(): void;
  122848. /**
  122849. * Destroy the camera and release the current resources hold by it.
  122850. */
  122851. dispose(): void;
  122852. /**
  122853. * Gets the current object class name.
  122854. * @return the class name
  122855. */
  122856. getClassName(): string;
  122857. }
  122858. }
  122859. declare module BABYLON {
  122860. /**
  122861. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  122862. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122863. */
  122864. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  122865. /**
  122866. * Gets the name of the behavior.
  122867. */
  122868. get name(): string;
  122869. private _zoomStopsAnimation;
  122870. private _idleRotationSpeed;
  122871. private _idleRotationWaitTime;
  122872. private _idleRotationSpinupTime;
  122873. /**
  122874. * Sets the flag that indicates if user zooming should stop animation.
  122875. */
  122876. set zoomStopsAnimation(flag: boolean);
  122877. /**
  122878. * Gets the flag that indicates if user zooming should stop animation.
  122879. */
  122880. get zoomStopsAnimation(): boolean;
  122881. /**
  122882. * Sets the default speed at which the camera rotates around the model.
  122883. */
  122884. set idleRotationSpeed(speed: number);
  122885. /**
  122886. * Gets the default speed at which the camera rotates around the model.
  122887. */
  122888. get idleRotationSpeed(): number;
  122889. /**
  122890. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  122891. */
  122892. set idleRotationWaitTime(time: number);
  122893. /**
  122894. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  122895. */
  122896. get idleRotationWaitTime(): number;
  122897. /**
  122898. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122899. */
  122900. set idleRotationSpinupTime(time: number);
  122901. /**
  122902. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122903. */
  122904. get idleRotationSpinupTime(): number;
  122905. /**
  122906. * Gets a value indicating if the camera is currently rotating because of this behavior
  122907. */
  122908. get rotationInProgress(): boolean;
  122909. private _onPrePointerObservableObserver;
  122910. private _onAfterCheckInputsObserver;
  122911. private _attachedCamera;
  122912. private _isPointerDown;
  122913. private _lastFrameTime;
  122914. private _lastInteractionTime;
  122915. private _cameraRotationSpeed;
  122916. /**
  122917. * Initializes the behavior.
  122918. */
  122919. init(): void;
  122920. /**
  122921. * Attaches the behavior to its arc rotate camera.
  122922. * @param camera Defines the camera to attach the behavior to
  122923. */
  122924. attach(camera: ArcRotateCamera): void;
  122925. /**
  122926. * Detaches the behavior from its current arc rotate camera.
  122927. */
  122928. detach(): void;
  122929. /**
  122930. * Returns true if user is scrolling.
  122931. * @return true if user is scrolling.
  122932. */
  122933. private _userIsZooming;
  122934. private _lastFrameRadius;
  122935. private _shouldAnimationStopForInteraction;
  122936. /**
  122937. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122938. */
  122939. private _applyUserInteraction;
  122940. private _userIsMoving;
  122941. }
  122942. }
  122943. declare module BABYLON {
  122944. /**
  122945. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  122946. */
  122947. export class AttachToBoxBehavior implements Behavior<Mesh> {
  122948. private ui;
  122949. /**
  122950. * The name of the behavior
  122951. */
  122952. name: string;
  122953. /**
  122954. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  122955. */
  122956. distanceAwayFromFace: number;
  122957. /**
  122958. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  122959. */
  122960. distanceAwayFromBottomOfFace: number;
  122961. private _faceVectors;
  122962. private _target;
  122963. private _scene;
  122964. private _onRenderObserver;
  122965. private _tmpMatrix;
  122966. private _tmpVector;
  122967. /**
  122968. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  122969. * @param ui The transform node that should be attched to the mesh
  122970. */
  122971. constructor(ui: TransformNode);
  122972. /**
  122973. * Initializes the behavior
  122974. */
  122975. init(): void;
  122976. private _closestFace;
  122977. private _zeroVector;
  122978. private _lookAtTmpMatrix;
  122979. private _lookAtToRef;
  122980. /**
  122981. * Attaches the AttachToBoxBehavior to the passed in mesh
  122982. * @param target The mesh that the specified node will be attached to
  122983. */
  122984. attach(target: Mesh): void;
  122985. /**
  122986. * Detaches the behavior from the mesh
  122987. */
  122988. detach(): void;
  122989. }
  122990. }
  122991. declare module BABYLON {
  122992. /**
  122993. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  122994. */
  122995. export class FadeInOutBehavior implements Behavior<Mesh> {
  122996. /**
  122997. * Time in milliseconds to delay before fading in (Default: 0)
  122998. */
  122999. delay: number;
  123000. /**
  123001. * Time in milliseconds for the mesh to fade in (Default: 300)
  123002. */
  123003. fadeInTime: number;
  123004. private _millisecondsPerFrame;
  123005. private _hovered;
  123006. private _hoverValue;
  123007. private _ownerNode;
  123008. /**
  123009. * Instatiates the FadeInOutBehavior
  123010. */
  123011. constructor();
  123012. /**
  123013. * The name of the behavior
  123014. */
  123015. get name(): string;
  123016. /**
  123017. * Initializes the behavior
  123018. */
  123019. init(): void;
  123020. /**
  123021. * Attaches the fade behavior on the passed in mesh
  123022. * @param ownerNode The mesh that will be faded in/out once attached
  123023. */
  123024. attach(ownerNode: Mesh): void;
  123025. /**
  123026. * Detaches the behavior from the mesh
  123027. */
  123028. detach(): void;
  123029. /**
  123030. * Triggers the mesh to begin fading in or out
  123031. * @param value if the object should fade in or out (true to fade in)
  123032. */
  123033. fadeIn(value: boolean): void;
  123034. private _update;
  123035. private _setAllVisibility;
  123036. }
  123037. }
  123038. declare module BABYLON {
  123039. /**
  123040. * Class containing a set of static utilities functions for managing Pivots
  123041. * @hidden
  123042. */
  123043. export class PivotTools {
  123044. private static _PivotCached;
  123045. private static _OldPivotPoint;
  123046. private static _PivotTranslation;
  123047. private static _PivotTmpVector;
  123048. /** @hidden */
  123049. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  123050. /** @hidden */
  123051. static _RestorePivotPoint(mesh: AbstractMesh): void;
  123052. }
  123053. }
  123054. declare module BABYLON {
  123055. /**
  123056. * Class containing static functions to help procedurally build meshes
  123057. */
  123058. export class PlaneBuilder {
  123059. /**
  123060. * Creates a plane mesh
  123061. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  123062. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  123063. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  123064. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  123065. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  123066. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  123067. * @param name defines the name of the mesh
  123068. * @param options defines the options used to create the mesh
  123069. * @param scene defines the hosting scene
  123070. * @returns the plane mesh
  123071. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  123072. */
  123073. static CreatePlane(name: string, options: {
  123074. size?: number;
  123075. width?: number;
  123076. height?: number;
  123077. sideOrientation?: number;
  123078. frontUVs?: Vector4;
  123079. backUVs?: Vector4;
  123080. updatable?: boolean;
  123081. sourcePlane?: Plane;
  123082. }, scene?: Nullable<Scene>): Mesh;
  123083. }
  123084. }
  123085. declare module BABYLON {
  123086. /**
  123087. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  123088. */
  123089. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  123090. private static _AnyMouseID;
  123091. /**
  123092. * Abstract mesh the behavior is set on
  123093. */
  123094. attachedNode: AbstractMesh;
  123095. private _dragPlane;
  123096. private _scene;
  123097. private _pointerObserver;
  123098. private _beforeRenderObserver;
  123099. private static _planeScene;
  123100. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  123101. /**
  123102. * 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)
  123103. */
  123104. maxDragAngle: number;
  123105. /**
  123106. * @hidden
  123107. */
  123108. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  123109. /**
  123110. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123111. */
  123112. currentDraggingPointerID: number;
  123113. /**
  123114. * The last position where the pointer hit the drag plane in world space
  123115. */
  123116. lastDragPosition: Vector3;
  123117. /**
  123118. * If the behavior is currently in a dragging state
  123119. */
  123120. dragging: boolean;
  123121. /**
  123122. * 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)
  123123. */
  123124. dragDeltaRatio: number;
  123125. /**
  123126. * If the drag plane orientation should be updated during the dragging (Default: true)
  123127. */
  123128. updateDragPlane: boolean;
  123129. private _debugMode;
  123130. private _moving;
  123131. /**
  123132. * Fires each time the attached mesh is dragged with the pointer
  123133. * * delta between last drag position and current drag position in world space
  123134. * * dragDistance along the drag axis
  123135. * * dragPlaneNormal normal of the current drag plane used during the drag
  123136. * * dragPlanePoint in world space where the drag intersects the drag plane
  123137. */
  123138. onDragObservable: Observable<{
  123139. delta: Vector3;
  123140. dragPlanePoint: Vector3;
  123141. dragPlaneNormal: Vector3;
  123142. dragDistance: number;
  123143. pointerId: number;
  123144. }>;
  123145. /**
  123146. * Fires each time a drag begins (eg. mouse down on mesh)
  123147. */
  123148. onDragStartObservable: Observable<{
  123149. dragPlanePoint: Vector3;
  123150. pointerId: number;
  123151. }>;
  123152. /**
  123153. * Fires each time a drag ends (eg. mouse release after drag)
  123154. */
  123155. onDragEndObservable: Observable<{
  123156. dragPlanePoint: Vector3;
  123157. pointerId: number;
  123158. }>;
  123159. /**
  123160. * If the attached mesh should be moved when dragged
  123161. */
  123162. moveAttached: boolean;
  123163. /**
  123164. * If the drag behavior will react to drag events (Default: true)
  123165. */
  123166. enabled: boolean;
  123167. /**
  123168. * If pointer events should start and release the drag (Default: true)
  123169. */
  123170. startAndReleaseDragOnPointerEvents: boolean;
  123171. /**
  123172. * If camera controls should be detached during the drag
  123173. */
  123174. detachCameraControls: boolean;
  123175. /**
  123176. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  123177. */
  123178. useObjectOrientationForDragging: boolean;
  123179. private _options;
  123180. /**
  123181. * Gets the options used by the behavior
  123182. */
  123183. get options(): {
  123184. dragAxis?: Vector3;
  123185. dragPlaneNormal?: Vector3;
  123186. };
  123187. /**
  123188. * Sets the options used by the behavior
  123189. */
  123190. set options(options: {
  123191. dragAxis?: Vector3;
  123192. dragPlaneNormal?: Vector3;
  123193. });
  123194. /**
  123195. * Creates a pointer drag behavior that can be attached to a mesh
  123196. * @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)
  123197. */
  123198. constructor(options?: {
  123199. dragAxis?: Vector3;
  123200. dragPlaneNormal?: Vector3;
  123201. });
  123202. /**
  123203. * Predicate to determine if it is valid to move the object to a new position when it is moved
  123204. */
  123205. validateDrag: (targetPosition: Vector3) => boolean;
  123206. /**
  123207. * The name of the behavior
  123208. */
  123209. get name(): string;
  123210. /**
  123211. * Initializes the behavior
  123212. */
  123213. init(): void;
  123214. private _tmpVector;
  123215. private _alternatePickedPoint;
  123216. private _worldDragAxis;
  123217. private _targetPosition;
  123218. private _attachedElement;
  123219. /**
  123220. * Attaches the drag behavior the passed in mesh
  123221. * @param ownerNode The mesh that will be dragged around once attached
  123222. * @param predicate Predicate to use for pick filtering
  123223. */
  123224. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  123225. /**
  123226. * Force relase the drag action by code.
  123227. */
  123228. releaseDrag(): void;
  123229. private _startDragRay;
  123230. private _lastPointerRay;
  123231. /**
  123232. * Simulates the start of a pointer drag event on the behavior
  123233. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  123234. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  123235. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  123236. */
  123237. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  123238. private _startDrag;
  123239. private _dragDelta;
  123240. private _moveDrag;
  123241. private _pickWithRayOnDragPlane;
  123242. private _pointA;
  123243. private _pointC;
  123244. private _localAxis;
  123245. private _lookAt;
  123246. private _updateDragPlanePosition;
  123247. /**
  123248. * Detaches the behavior from the mesh
  123249. */
  123250. detach(): void;
  123251. }
  123252. }
  123253. declare module BABYLON {
  123254. /**
  123255. * A behavior that when attached to a mesh will allow the mesh to be scaled
  123256. */
  123257. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  123258. private _dragBehaviorA;
  123259. private _dragBehaviorB;
  123260. private _startDistance;
  123261. private _initialScale;
  123262. private _targetScale;
  123263. private _ownerNode;
  123264. private _sceneRenderObserver;
  123265. /**
  123266. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  123267. */
  123268. constructor();
  123269. /**
  123270. * The name of the behavior
  123271. */
  123272. get name(): string;
  123273. /**
  123274. * Initializes the behavior
  123275. */
  123276. init(): void;
  123277. private _getCurrentDistance;
  123278. /**
  123279. * Attaches the scale behavior the passed in mesh
  123280. * @param ownerNode The mesh that will be scaled around once attached
  123281. */
  123282. attach(ownerNode: Mesh): void;
  123283. /**
  123284. * Detaches the behavior from the mesh
  123285. */
  123286. detach(): void;
  123287. }
  123288. }
  123289. declare module BABYLON {
  123290. /**
  123291. * 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
  123292. */
  123293. export class SixDofDragBehavior implements Behavior<Mesh> {
  123294. private static _virtualScene;
  123295. private _ownerNode;
  123296. private _sceneRenderObserver;
  123297. private _scene;
  123298. private _targetPosition;
  123299. private _virtualOriginMesh;
  123300. private _virtualDragMesh;
  123301. private _pointerObserver;
  123302. private _moving;
  123303. private _startingOrientation;
  123304. private _attachedElement;
  123305. /**
  123306. * 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)
  123307. */
  123308. private zDragFactor;
  123309. /**
  123310. * If the object should rotate to face the drag origin
  123311. */
  123312. rotateDraggedObject: boolean;
  123313. /**
  123314. * If the behavior is currently in a dragging state
  123315. */
  123316. dragging: boolean;
  123317. /**
  123318. * 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)
  123319. */
  123320. dragDeltaRatio: number;
  123321. /**
  123322. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123323. */
  123324. currentDraggingPointerID: number;
  123325. /**
  123326. * If camera controls should be detached during the drag
  123327. */
  123328. detachCameraControls: boolean;
  123329. /**
  123330. * Fires each time a drag starts
  123331. */
  123332. onDragStartObservable: Observable<{}>;
  123333. /**
  123334. * Fires each time a drag ends (eg. mouse release after drag)
  123335. */
  123336. onDragEndObservable: Observable<{}>;
  123337. /**
  123338. * 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
  123339. */
  123340. constructor();
  123341. /**
  123342. * The name of the behavior
  123343. */
  123344. get name(): string;
  123345. /**
  123346. * Initializes the behavior
  123347. */
  123348. init(): void;
  123349. /**
  123350. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  123351. */
  123352. private get _pointerCamera();
  123353. /**
  123354. * Attaches the scale behavior the passed in mesh
  123355. * @param ownerNode The mesh that will be scaled around once attached
  123356. */
  123357. attach(ownerNode: Mesh): void;
  123358. /**
  123359. * Detaches the behavior from the mesh
  123360. */
  123361. detach(): void;
  123362. }
  123363. }
  123364. declare module BABYLON {
  123365. /**
  123366. * Class used to apply inverse kinematics to bones
  123367. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  123368. */
  123369. export class BoneIKController {
  123370. private static _tmpVecs;
  123371. private static _tmpQuat;
  123372. private static _tmpMats;
  123373. /**
  123374. * Gets or sets the target mesh
  123375. */
  123376. targetMesh: AbstractMesh;
  123377. /** Gets or sets the mesh used as pole */
  123378. poleTargetMesh: AbstractMesh;
  123379. /**
  123380. * Gets or sets the bone used as pole
  123381. */
  123382. poleTargetBone: Nullable<Bone>;
  123383. /**
  123384. * Gets or sets the target position
  123385. */
  123386. targetPosition: Vector3;
  123387. /**
  123388. * Gets or sets the pole target position
  123389. */
  123390. poleTargetPosition: Vector3;
  123391. /**
  123392. * Gets or sets the pole target local offset
  123393. */
  123394. poleTargetLocalOffset: Vector3;
  123395. /**
  123396. * Gets or sets the pole angle
  123397. */
  123398. poleAngle: number;
  123399. /**
  123400. * Gets or sets the mesh associated with the controller
  123401. */
  123402. mesh: AbstractMesh;
  123403. /**
  123404. * 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)
  123405. */
  123406. slerpAmount: number;
  123407. private _bone1Quat;
  123408. private _bone1Mat;
  123409. private _bone2Ang;
  123410. private _bone1;
  123411. private _bone2;
  123412. private _bone1Length;
  123413. private _bone2Length;
  123414. private _maxAngle;
  123415. private _maxReach;
  123416. private _rightHandedSystem;
  123417. private _bendAxis;
  123418. private _slerping;
  123419. private _adjustRoll;
  123420. /**
  123421. * Gets or sets maximum allowed angle
  123422. */
  123423. get maxAngle(): number;
  123424. set maxAngle(value: number);
  123425. /**
  123426. * Creates a new BoneIKController
  123427. * @param mesh defines the mesh to control
  123428. * @param bone defines the bone to control
  123429. * @param options defines options to set up the controller
  123430. */
  123431. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  123432. targetMesh?: AbstractMesh;
  123433. poleTargetMesh?: AbstractMesh;
  123434. poleTargetBone?: Bone;
  123435. poleTargetLocalOffset?: Vector3;
  123436. poleAngle?: number;
  123437. bendAxis?: Vector3;
  123438. maxAngle?: number;
  123439. slerpAmount?: number;
  123440. });
  123441. private _setMaxAngle;
  123442. /**
  123443. * Force the controller to update the bones
  123444. */
  123445. update(): void;
  123446. }
  123447. }
  123448. declare module BABYLON {
  123449. /**
  123450. * Class used to make a bone look toward a point in space
  123451. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  123452. */
  123453. export class BoneLookController {
  123454. private static _tmpVecs;
  123455. private static _tmpQuat;
  123456. private static _tmpMats;
  123457. /**
  123458. * The target Vector3 that the bone will look at
  123459. */
  123460. target: Vector3;
  123461. /**
  123462. * The mesh that the bone is attached to
  123463. */
  123464. mesh: AbstractMesh;
  123465. /**
  123466. * The bone that will be looking to the target
  123467. */
  123468. bone: Bone;
  123469. /**
  123470. * The up axis of the coordinate system that is used when the bone is rotated
  123471. */
  123472. upAxis: Vector3;
  123473. /**
  123474. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  123475. */
  123476. upAxisSpace: Space;
  123477. /**
  123478. * Used to make an adjustment to the yaw of the bone
  123479. */
  123480. adjustYaw: number;
  123481. /**
  123482. * Used to make an adjustment to the pitch of the bone
  123483. */
  123484. adjustPitch: number;
  123485. /**
  123486. * Used to make an adjustment to the roll of the bone
  123487. */
  123488. adjustRoll: number;
  123489. /**
  123490. * 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)
  123491. */
  123492. slerpAmount: number;
  123493. private _minYaw;
  123494. private _maxYaw;
  123495. private _minPitch;
  123496. private _maxPitch;
  123497. private _minYawSin;
  123498. private _minYawCos;
  123499. private _maxYawSin;
  123500. private _maxYawCos;
  123501. private _midYawConstraint;
  123502. private _minPitchTan;
  123503. private _maxPitchTan;
  123504. private _boneQuat;
  123505. private _slerping;
  123506. private _transformYawPitch;
  123507. private _transformYawPitchInv;
  123508. private _firstFrameSkipped;
  123509. private _yawRange;
  123510. private _fowardAxis;
  123511. /**
  123512. * Gets or sets the minimum yaw angle that the bone can look to
  123513. */
  123514. get minYaw(): number;
  123515. set minYaw(value: number);
  123516. /**
  123517. * Gets or sets the maximum yaw angle that the bone can look to
  123518. */
  123519. get maxYaw(): number;
  123520. set maxYaw(value: number);
  123521. /**
  123522. * Gets or sets the minimum pitch angle that the bone can look to
  123523. */
  123524. get minPitch(): number;
  123525. set minPitch(value: number);
  123526. /**
  123527. * Gets or sets the maximum pitch angle that the bone can look to
  123528. */
  123529. get maxPitch(): number;
  123530. set maxPitch(value: number);
  123531. /**
  123532. * Create a BoneLookController
  123533. * @param mesh the mesh that the bone belongs to
  123534. * @param bone the bone that will be looking to the target
  123535. * @param target the target Vector3 to look at
  123536. * @param options optional settings:
  123537. * * maxYaw: the maximum angle the bone will yaw to
  123538. * * minYaw: the minimum angle the bone will yaw to
  123539. * * maxPitch: the maximum angle the bone will pitch to
  123540. * * minPitch: the minimum angle the bone will yaw to
  123541. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  123542. * * upAxis: the up axis of the coordinate system
  123543. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  123544. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  123545. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  123546. * * adjustYaw: used to make an adjustment to the yaw of the bone
  123547. * * adjustPitch: used to make an adjustment to the pitch of the bone
  123548. * * adjustRoll: used to make an adjustment to the roll of the bone
  123549. **/
  123550. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  123551. maxYaw?: number;
  123552. minYaw?: number;
  123553. maxPitch?: number;
  123554. minPitch?: number;
  123555. slerpAmount?: number;
  123556. upAxis?: Vector3;
  123557. upAxisSpace?: Space;
  123558. yawAxis?: Vector3;
  123559. pitchAxis?: Vector3;
  123560. adjustYaw?: number;
  123561. adjustPitch?: number;
  123562. adjustRoll?: number;
  123563. });
  123564. /**
  123565. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  123566. */
  123567. update(): void;
  123568. private _getAngleDiff;
  123569. private _getAngleBetween;
  123570. private _isAngleBetween;
  123571. }
  123572. }
  123573. declare module BABYLON {
  123574. /**
  123575. * Manage the gamepad inputs to control an arc rotate camera.
  123576. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123577. */
  123578. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  123579. /**
  123580. * Defines the camera the input is attached to.
  123581. */
  123582. camera: ArcRotateCamera;
  123583. /**
  123584. * Defines the gamepad the input is gathering event from.
  123585. */
  123586. gamepad: Nullable<Gamepad>;
  123587. /**
  123588. * Defines the gamepad rotation sensiblity.
  123589. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  123590. */
  123591. gamepadRotationSensibility: number;
  123592. /**
  123593. * Defines the gamepad move sensiblity.
  123594. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  123595. */
  123596. gamepadMoveSensibility: number;
  123597. private _yAxisScale;
  123598. /**
  123599. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  123600. */
  123601. get invertYAxis(): boolean;
  123602. set invertYAxis(value: boolean);
  123603. private _onGamepadConnectedObserver;
  123604. private _onGamepadDisconnectedObserver;
  123605. /**
  123606. * Attach the input controls to a specific dom element to get the input from.
  123607. * @param element Defines the element the controls should be listened from
  123608. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123609. */
  123610. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123611. /**
  123612. * Detach the current controls from the specified dom element.
  123613. * @param element Defines the element to stop listening the inputs from
  123614. */
  123615. detachControl(element: Nullable<HTMLElement>): void;
  123616. /**
  123617. * Update the current camera state depending on the inputs that have been used this frame.
  123618. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123619. */
  123620. checkInputs(): void;
  123621. /**
  123622. * Gets the class name of the current intput.
  123623. * @returns the class name
  123624. */
  123625. getClassName(): string;
  123626. /**
  123627. * Get the friendly name associated with the input class.
  123628. * @returns the input friendly name
  123629. */
  123630. getSimpleName(): string;
  123631. }
  123632. }
  123633. declare module BABYLON {
  123634. interface ArcRotateCameraInputsManager {
  123635. /**
  123636. * Add orientation input support to the input manager.
  123637. * @returns the current input manager
  123638. */
  123639. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  123640. }
  123641. /**
  123642. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  123643. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123644. */
  123645. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  123646. /**
  123647. * Defines the camera the input is attached to.
  123648. */
  123649. camera: ArcRotateCamera;
  123650. /**
  123651. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  123652. */
  123653. alphaCorrection: number;
  123654. /**
  123655. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  123656. */
  123657. gammaCorrection: number;
  123658. private _alpha;
  123659. private _gamma;
  123660. private _dirty;
  123661. private _deviceOrientationHandler;
  123662. /**
  123663. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  123664. */
  123665. constructor();
  123666. /**
  123667. * Attach the input controls to a specific dom element to get the input from.
  123668. * @param element Defines the element the controls should be listened from
  123669. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123670. */
  123671. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123672. /** @hidden */
  123673. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  123674. /**
  123675. * Update the current camera state depending on the inputs that have been used this frame.
  123676. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123677. */
  123678. checkInputs(): void;
  123679. /**
  123680. * Detach the current controls from the specified dom element.
  123681. * @param element Defines the element to stop listening the inputs from
  123682. */
  123683. detachControl(element: Nullable<HTMLElement>): void;
  123684. /**
  123685. * Gets the class name of the current intput.
  123686. * @returns the class name
  123687. */
  123688. getClassName(): string;
  123689. /**
  123690. * Get the friendly name associated with the input class.
  123691. * @returns the input friendly name
  123692. */
  123693. getSimpleName(): string;
  123694. }
  123695. }
  123696. declare module BABYLON {
  123697. /**
  123698. * Listen to mouse events to control the camera.
  123699. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123700. */
  123701. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  123702. /**
  123703. * Defines the camera the input is attached to.
  123704. */
  123705. camera: FlyCamera;
  123706. /**
  123707. * Defines if touch is enabled. (Default is true.)
  123708. */
  123709. touchEnabled: boolean;
  123710. /**
  123711. * Defines the buttons associated with the input to handle camera rotation.
  123712. */
  123713. buttons: number[];
  123714. /**
  123715. * Assign buttons for Yaw control.
  123716. */
  123717. buttonsYaw: number[];
  123718. /**
  123719. * Assign buttons for Pitch control.
  123720. */
  123721. buttonsPitch: number[];
  123722. /**
  123723. * Assign buttons for Roll control.
  123724. */
  123725. buttonsRoll: number[];
  123726. /**
  123727. * Detect if any button is being pressed while mouse is moved.
  123728. * -1 = Mouse locked.
  123729. * 0 = Left button.
  123730. * 1 = Middle Button.
  123731. * 2 = Right Button.
  123732. */
  123733. activeButton: number;
  123734. /**
  123735. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  123736. * Higher values reduce its sensitivity.
  123737. */
  123738. angularSensibility: number;
  123739. private _mousemoveCallback;
  123740. private _observer;
  123741. private _rollObserver;
  123742. private previousPosition;
  123743. private noPreventDefault;
  123744. private element;
  123745. /**
  123746. * Listen to mouse events to control the camera.
  123747. * @param touchEnabled Define if touch is enabled. (Default is true.)
  123748. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123749. */
  123750. constructor(touchEnabled?: boolean);
  123751. /**
  123752. * Attach the mouse control to the HTML DOM element.
  123753. * @param element Defines the element that listens to the input events.
  123754. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  123755. */
  123756. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123757. /**
  123758. * Detach the current controls from the specified dom element.
  123759. * @param element Defines the element to stop listening the inputs from
  123760. */
  123761. detachControl(element: Nullable<HTMLElement>): void;
  123762. /**
  123763. * Gets the class name of the current input.
  123764. * @returns the class name.
  123765. */
  123766. getClassName(): string;
  123767. /**
  123768. * Get the friendly name associated with the input class.
  123769. * @returns the input's friendly name.
  123770. */
  123771. getSimpleName(): string;
  123772. private _pointerInput;
  123773. private _onMouseMove;
  123774. /**
  123775. * Rotate camera by mouse offset.
  123776. */
  123777. private rotateCamera;
  123778. }
  123779. }
  123780. declare module BABYLON {
  123781. /**
  123782. * Default Inputs manager for the FlyCamera.
  123783. * It groups all the default supported inputs for ease of use.
  123784. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123785. */
  123786. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  123787. /**
  123788. * Instantiates a new FlyCameraInputsManager.
  123789. * @param camera Defines the camera the inputs belong to.
  123790. */
  123791. constructor(camera: FlyCamera);
  123792. /**
  123793. * Add keyboard input support to the input manager.
  123794. * @returns the new FlyCameraKeyboardMoveInput().
  123795. */
  123796. addKeyboard(): FlyCameraInputsManager;
  123797. /**
  123798. * Add mouse input support to the input manager.
  123799. * @param touchEnabled Enable touch screen support.
  123800. * @returns the new FlyCameraMouseInput().
  123801. */
  123802. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  123803. }
  123804. }
  123805. declare module BABYLON {
  123806. /**
  123807. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123808. * such as in a 3D Space Shooter or a Flight Simulator.
  123809. */
  123810. export class FlyCamera extends TargetCamera {
  123811. /**
  123812. * Define the collision ellipsoid of the camera.
  123813. * This is helpful for simulating a camera body, like a player's body.
  123814. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  123815. */
  123816. ellipsoid: Vector3;
  123817. /**
  123818. * Define an offset for the position of the ellipsoid around the camera.
  123819. * This can be helpful if the camera is attached away from the player's body center,
  123820. * such as at its head.
  123821. */
  123822. ellipsoidOffset: Vector3;
  123823. /**
  123824. * Enable or disable collisions of the camera with the rest of the scene objects.
  123825. */
  123826. checkCollisions: boolean;
  123827. /**
  123828. * Enable or disable gravity on the camera.
  123829. */
  123830. applyGravity: boolean;
  123831. /**
  123832. * Define the current direction the camera is moving to.
  123833. */
  123834. cameraDirection: Vector3;
  123835. /**
  123836. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  123837. * This overrides and empties cameraRotation.
  123838. */
  123839. rotationQuaternion: Quaternion;
  123840. /**
  123841. * Track Roll to maintain the wanted Rolling when looking around.
  123842. */
  123843. _trackRoll: number;
  123844. /**
  123845. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  123846. */
  123847. rollCorrect: number;
  123848. /**
  123849. * Mimic a banked turn, Rolling the camera when Yawing.
  123850. * It's recommended to use rollCorrect = 10 for faster banking correction.
  123851. */
  123852. bankedTurn: boolean;
  123853. /**
  123854. * Limit in radians for how much Roll banking will add. (Default: 90°)
  123855. */
  123856. bankedTurnLimit: number;
  123857. /**
  123858. * Value of 0 disables the banked Roll.
  123859. * Value of 1 is equal to the Yaw angle in radians.
  123860. */
  123861. bankedTurnMultiplier: number;
  123862. /**
  123863. * The inputs manager loads all the input sources, such as keyboard and mouse.
  123864. */
  123865. inputs: FlyCameraInputsManager;
  123866. /**
  123867. * Gets the input sensibility for mouse input.
  123868. * Higher values reduce sensitivity.
  123869. */
  123870. get angularSensibility(): number;
  123871. /**
  123872. * Sets the input sensibility for a mouse input.
  123873. * Higher values reduce sensitivity.
  123874. */
  123875. set angularSensibility(value: number);
  123876. /**
  123877. * Get the keys for camera movement forward.
  123878. */
  123879. get keysForward(): number[];
  123880. /**
  123881. * Set the keys for camera movement forward.
  123882. */
  123883. set keysForward(value: number[]);
  123884. /**
  123885. * Get the keys for camera movement backward.
  123886. */
  123887. get keysBackward(): number[];
  123888. set keysBackward(value: number[]);
  123889. /**
  123890. * Get the keys for camera movement up.
  123891. */
  123892. get keysUp(): number[];
  123893. /**
  123894. * Set the keys for camera movement up.
  123895. */
  123896. set keysUp(value: number[]);
  123897. /**
  123898. * Get the keys for camera movement down.
  123899. */
  123900. get keysDown(): number[];
  123901. /**
  123902. * Set the keys for camera movement down.
  123903. */
  123904. set keysDown(value: number[]);
  123905. /**
  123906. * Get the keys for camera movement left.
  123907. */
  123908. get keysLeft(): number[];
  123909. /**
  123910. * Set the keys for camera movement left.
  123911. */
  123912. set keysLeft(value: number[]);
  123913. /**
  123914. * Set the keys for camera movement right.
  123915. */
  123916. get keysRight(): number[];
  123917. /**
  123918. * Set the keys for camera movement right.
  123919. */
  123920. set keysRight(value: number[]);
  123921. /**
  123922. * Event raised when the camera collides with a mesh in the scene.
  123923. */
  123924. onCollide: (collidedMesh: AbstractMesh) => void;
  123925. private _collider;
  123926. private _needMoveForGravity;
  123927. private _oldPosition;
  123928. private _diffPosition;
  123929. private _newPosition;
  123930. /** @hidden */
  123931. _localDirection: Vector3;
  123932. /** @hidden */
  123933. _transformedDirection: Vector3;
  123934. /**
  123935. * Instantiates a FlyCamera.
  123936. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123937. * such as in a 3D Space Shooter or a Flight Simulator.
  123938. * @param name Define the name of the camera in the scene.
  123939. * @param position Define the starting position of the camera in the scene.
  123940. * @param scene Define the scene the camera belongs to.
  123941. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  123942. */
  123943. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  123944. /**
  123945. * Attach a control to the HTML DOM element.
  123946. * @param element Defines the element that listens to the input events.
  123947. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  123948. */
  123949. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123950. /**
  123951. * Detach a control from the HTML DOM element.
  123952. * The camera will stop reacting to that input.
  123953. * @param element Defines the element that listens to the input events.
  123954. */
  123955. detachControl(element: HTMLElement): void;
  123956. private _collisionMask;
  123957. /**
  123958. * Get the mask that the camera ignores in collision events.
  123959. */
  123960. get collisionMask(): number;
  123961. /**
  123962. * Set the mask that the camera ignores in collision events.
  123963. */
  123964. set collisionMask(mask: number);
  123965. /** @hidden */
  123966. _collideWithWorld(displacement: Vector3): void;
  123967. /** @hidden */
  123968. private _onCollisionPositionChange;
  123969. /** @hidden */
  123970. _checkInputs(): void;
  123971. /** @hidden */
  123972. _decideIfNeedsToMove(): boolean;
  123973. /** @hidden */
  123974. _updatePosition(): void;
  123975. /**
  123976. * Restore the Roll to its target value at the rate specified.
  123977. * @param rate - Higher means slower restoring.
  123978. * @hidden
  123979. */
  123980. restoreRoll(rate: number): void;
  123981. /**
  123982. * Destroy the camera and release the current resources held by it.
  123983. */
  123984. dispose(): void;
  123985. /**
  123986. * Get the current object class name.
  123987. * @returns the class name.
  123988. */
  123989. getClassName(): string;
  123990. }
  123991. }
  123992. declare module BABYLON {
  123993. /**
  123994. * Listen to keyboard events to control the camera.
  123995. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123996. */
  123997. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  123998. /**
  123999. * Defines the camera the input is attached to.
  124000. */
  124001. camera: FlyCamera;
  124002. /**
  124003. * The list of keyboard keys used to control the forward move of the camera.
  124004. */
  124005. keysForward: number[];
  124006. /**
  124007. * The list of keyboard keys used to control the backward move of the camera.
  124008. */
  124009. keysBackward: number[];
  124010. /**
  124011. * The list of keyboard keys used to control the forward move of the camera.
  124012. */
  124013. keysUp: number[];
  124014. /**
  124015. * The list of keyboard keys used to control the backward move of the camera.
  124016. */
  124017. keysDown: number[];
  124018. /**
  124019. * The list of keyboard keys used to control the right strafe move of the camera.
  124020. */
  124021. keysRight: number[];
  124022. /**
  124023. * The list of keyboard keys used to control the left strafe move of the camera.
  124024. */
  124025. keysLeft: number[];
  124026. private _keys;
  124027. private _onCanvasBlurObserver;
  124028. private _onKeyboardObserver;
  124029. private _engine;
  124030. private _scene;
  124031. /**
  124032. * Attach the input controls to a specific dom element to get the input from.
  124033. * @param element Defines the element the controls should be listened from
  124034. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124035. */
  124036. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124037. /**
  124038. * Detach the current controls from the specified dom element.
  124039. * @param element Defines the element to stop listening the inputs from
  124040. */
  124041. detachControl(element: Nullable<HTMLElement>): void;
  124042. /**
  124043. * Gets the class name of the current intput.
  124044. * @returns the class name
  124045. */
  124046. getClassName(): string;
  124047. /** @hidden */
  124048. _onLostFocus(e: FocusEvent): void;
  124049. /**
  124050. * Get the friendly name associated with the input class.
  124051. * @returns the input friendly name
  124052. */
  124053. getSimpleName(): string;
  124054. /**
  124055. * Update the current camera state depending on the inputs that have been used this frame.
  124056. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124057. */
  124058. checkInputs(): void;
  124059. }
  124060. }
  124061. declare module BABYLON {
  124062. /**
  124063. * Manage the mouse wheel inputs to control a follow camera.
  124064. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124065. */
  124066. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  124067. /**
  124068. * Defines the camera the input is attached to.
  124069. */
  124070. camera: FollowCamera;
  124071. /**
  124072. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  124073. */
  124074. axisControlRadius: boolean;
  124075. /**
  124076. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  124077. */
  124078. axisControlHeight: boolean;
  124079. /**
  124080. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  124081. */
  124082. axisControlRotation: boolean;
  124083. /**
  124084. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  124085. * relation to mouseWheel events.
  124086. */
  124087. wheelPrecision: number;
  124088. /**
  124089. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  124090. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  124091. */
  124092. wheelDeltaPercentage: number;
  124093. private _wheel;
  124094. private _observer;
  124095. /**
  124096. * Attach the input controls to a specific dom element to get the input from.
  124097. * @param element Defines the element the controls should be listened from
  124098. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124099. */
  124100. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124101. /**
  124102. * Detach the current controls from the specified dom element.
  124103. * @param element Defines the element to stop listening the inputs from
  124104. */
  124105. detachControl(element: Nullable<HTMLElement>): void;
  124106. /**
  124107. * Gets the class name of the current intput.
  124108. * @returns the class name
  124109. */
  124110. getClassName(): string;
  124111. /**
  124112. * Get the friendly name associated with the input class.
  124113. * @returns the input friendly name
  124114. */
  124115. getSimpleName(): string;
  124116. }
  124117. }
  124118. declare module BABYLON {
  124119. /**
  124120. * Manage the pointers inputs to control an follow camera.
  124121. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124122. */
  124123. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  124124. /**
  124125. * Defines the camera the input is attached to.
  124126. */
  124127. camera: FollowCamera;
  124128. /**
  124129. * Gets the class name of the current input.
  124130. * @returns the class name
  124131. */
  124132. getClassName(): string;
  124133. /**
  124134. * Defines the pointer angular sensibility along the X axis or how fast is
  124135. * the camera rotating.
  124136. * A negative number will reverse the axis direction.
  124137. */
  124138. angularSensibilityX: number;
  124139. /**
  124140. * Defines the pointer angular sensibility along the Y axis or how fast is
  124141. * the camera rotating.
  124142. * A negative number will reverse the axis direction.
  124143. */
  124144. angularSensibilityY: number;
  124145. /**
  124146. * Defines the pointer pinch precision or how fast is the camera zooming.
  124147. * A negative number will reverse the axis direction.
  124148. */
  124149. pinchPrecision: number;
  124150. /**
  124151. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  124152. * from 0.
  124153. * It defines the percentage of current camera.radius to use as delta when
  124154. * pinch zoom is used.
  124155. */
  124156. pinchDeltaPercentage: number;
  124157. /**
  124158. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  124159. */
  124160. axisXControlRadius: boolean;
  124161. /**
  124162. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  124163. */
  124164. axisXControlHeight: boolean;
  124165. /**
  124166. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  124167. */
  124168. axisXControlRotation: boolean;
  124169. /**
  124170. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  124171. */
  124172. axisYControlRadius: boolean;
  124173. /**
  124174. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  124175. */
  124176. axisYControlHeight: boolean;
  124177. /**
  124178. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  124179. */
  124180. axisYControlRotation: boolean;
  124181. /**
  124182. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  124183. */
  124184. axisPinchControlRadius: boolean;
  124185. /**
  124186. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  124187. */
  124188. axisPinchControlHeight: boolean;
  124189. /**
  124190. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  124191. */
  124192. axisPinchControlRotation: boolean;
  124193. /**
  124194. * Log error messages if basic misconfiguration has occurred.
  124195. */
  124196. warningEnable: boolean;
  124197. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  124198. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  124199. private _warningCounter;
  124200. private _warning;
  124201. }
  124202. }
  124203. declare module BABYLON {
  124204. /**
  124205. * Default Inputs manager for the FollowCamera.
  124206. * It groups all the default supported inputs for ease of use.
  124207. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124208. */
  124209. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  124210. /**
  124211. * Instantiates a new FollowCameraInputsManager.
  124212. * @param camera Defines the camera the inputs belong to
  124213. */
  124214. constructor(camera: FollowCamera);
  124215. /**
  124216. * Add keyboard input support to the input manager.
  124217. * @returns the current input manager
  124218. */
  124219. addKeyboard(): FollowCameraInputsManager;
  124220. /**
  124221. * Add mouse wheel input support to the input manager.
  124222. * @returns the current input manager
  124223. */
  124224. addMouseWheel(): FollowCameraInputsManager;
  124225. /**
  124226. * Add pointers input support to the input manager.
  124227. * @returns the current input manager
  124228. */
  124229. addPointers(): FollowCameraInputsManager;
  124230. /**
  124231. * Add orientation input support to the input manager.
  124232. * @returns the current input manager
  124233. */
  124234. addVRDeviceOrientation(): FollowCameraInputsManager;
  124235. }
  124236. }
  124237. declare module BABYLON {
  124238. /**
  124239. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  124240. * an arc rotate version arcFollowCamera are available.
  124241. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124242. */
  124243. export class FollowCamera extends TargetCamera {
  124244. /**
  124245. * Distance the follow camera should follow an object at
  124246. */
  124247. radius: number;
  124248. /**
  124249. * Minimum allowed distance of the camera to the axis of rotation
  124250. * (The camera can not get closer).
  124251. * This can help limiting how the Camera is able to move in the scene.
  124252. */
  124253. lowerRadiusLimit: Nullable<number>;
  124254. /**
  124255. * Maximum allowed distance of the camera to the axis of rotation
  124256. * (The camera can not get further).
  124257. * This can help limiting how the Camera is able to move in the scene.
  124258. */
  124259. upperRadiusLimit: Nullable<number>;
  124260. /**
  124261. * Define a rotation offset between the camera and the object it follows
  124262. */
  124263. rotationOffset: number;
  124264. /**
  124265. * Minimum allowed angle to camera position relative to target object.
  124266. * This can help limiting how the Camera is able to move in the scene.
  124267. */
  124268. lowerRotationOffsetLimit: Nullable<number>;
  124269. /**
  124270. * Maximum allowed angle to camera position relative to target object.
  124271. * This can help limiting how the Camera is able to move in the scene.
  124272. */
  124273. upperRotationOffsetLimit: Nullable<number>;
  124274. /**
  124275. * Define a height offset between the camera and the object it follows.
  124276. * It can help following an object from the top (like a car chaing a plane)
  124277. */
  124278. heightOffset: number;
  124279. /**
  124280. * Minimum allowed height of camera position relative to target object.
  124281. * This can help limiting how the Camera is able to move in the scene.
  124282. */
  124283. lowerHeightOffsetLimit: Nullable<number>;
  124284. /**
  124285. * Maximum allowed height of camera position relative to target object.
  124286. * This can help limiting how the Camera is able to move in the scene.
  124287. */
  124288. upperHeightOffsetLimit: Nullable<number>;
  124289. /**
  124290. * Define how fast the camera can accelerate to follow it s target.
  124291. */
  124292. cameraAcceleration: number;
  124293. /**
  124294. * Define the speed limit of the camera following an object.
  124295. */
  124296. maxCameraSpeed: number;
  124297. /**
  124298. * Define the target of the camera.
  124299. */
  124300. lockedTarget: Nullable<AbstractMesh>;
  124301. /**
  124302. * Defines the input associated with the camera.
  124303. */
  124304. inputs: FollowCameraInputsManager;
  124305. /**
  124306. * Instantiates the follow camera.
  124307. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124308. * @param name Define the name of the camera in the scene
  124309. * @param position Define the position of the camera
  124310. * @param scene Define the scene the camera belong to
  124311. * @param lockedTarget Define the target of the camera
  124312. */
  124313. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  124314. private _follow;
  124315. /**
  124316. * Attached controls to the current camera.
  124317. * @param element Defines the element the controls should be listened from
  124318. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124319. */
  124320. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124321. /**
  124322. * Detach the current controls from the camera.
  124323. * The camera will stop reacting to inputs.
  124324. * @param element Defines the element to stop listening the inputs from
  124325. */
  124326. detachControl(element: HTMLElement): void;
  124327. /** @hidden */
  124328. _checkInputs(): void;
  124329. private _checkLimits;
  124330. /**
  124331. * Gets the camera class name.
  124332. * @returns the class name
  124333. */
  124334. getClassName(): string;
  124335. }
  124336. /**
  124337. * Arc Rotate version of the follow camera.
  124338. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  124339. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124340. */
  124341. export class ArcFollowCamera extends TargetCamera {
  124342. /** The longitudinal angle of the camera */
  124343. alpha: number;
  124344. /** The latitudinal angle of the camera */
  124345. beta: number;
  124346. /** The radius of the camera from its target */
  124347. radius: number;
  124348. private _cartesianCoordinates;
  124349. /** Define the camera target (the mesh it should follow) */
  124350. private _meshTarget;
  124351. /**
  124352. * Instantiates a new ArcFollowCamera
  124353. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124354. * @param name Define the name of the camera
  124355. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  124356. * @param beta Define the rotation angle of the camera around the elevation axis
  124357. * @param radius Define the radius of the camera from its target point
  124358. * @param target Define the target of the camera
  124359. * @param scene Define the scene the camera belongs to
  124360. */
  124361. constructor(name: string,
  124362. /** The longitudinal angle of the camera */
  124363. alpha: number,
  124364. /** The latitudinal angle of the camera */
  124365. beta: number,
  124366. /** The radius of the camera from its target */
  124367. radius: number,
  124368. /** Define the camera target (the mesh it should follow) */
  124369. target: Nullable<AbstractMesh>, scene: Scene);
  124370. private _follow;
  124371. /** @hidden */
  124372. _checkInputs(): void;
  124373. /**
  124374. * Returns the class name of the object.
  124375. * It is mostly used internally for serialization purposes.
  124376. */
  124377. getClassName(): string;
  124378. }
  124379. }
  124380. declare module BABYLON {
  124381. /**
  124382. * Manage the keyboard inputs to control the movement of a follow camera.
  124383. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124384. */
  124385. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  124386. /**
  124387. * Defines the camera the input is attached to.
  124388. */
  124389. camera: FollowCamera;
  124390. /**
  124391. * Defines the list of key codes associated with the up action (increase heightOffset)
  124392. */
  124393. keysHeightOffsetIncr: number[];
  124394. /**
  124395. * Defines the list of key codes associated with the down action (decrease heightOffset)
  124396. */
  124397. keysHeightOffsetDecr: number[];
  124398. /**
  124399. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  124400. */
  124401. keysHeightOffsetModifierAlt: boolean;
  124402. /**
  124403. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  124404. */
  124405. keysHeightOffsetModifierCtrl: boolean;
  124406. /**
  124407. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  124408. */
  124409. keysHeightOffsetModifierShift: boolean;
  124410. /**
  124411. * Defines the list of key codes associated with the left action (increase rotationOffset)
  124412. */
  124413. keysRotationOffsetIncr: number[];
  124414. /**
  124415. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  124416. */
  124417. keysRotationOffsetDecr: number[];
  124418. /**
  124419. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  124420. */
  124421. keysRotationOffsetModifierAlt: boolean;
  124422. /**
  124423. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  124424. */
  124425. keysRotationOffsetModifierCtrl: boolean;
  124426. /**
  124427. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  124428. */
  124429. keysRotationOffsetModifierShift: boolean;
  124430. /**
  124431. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  124432. */
  124433. keysRadiusIncr: number[];
  124434. /**
  124435. * Defines the list of key codes associated with the zoom-out action (increase radius)
  124436. */
  124437. keysRadiusDecr: number[];
  124438. /**
  124439. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  124440. */
  124441. keysRadiusModifierAlt: boolean;
  124442. /**
  124443. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  124444. */
  124445. keysRadiusModifierCtrl: boolean;
  124446. /**
  124447. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  124448. */
  124449. keysRadiusModifierShift: boolean;
  124450. /**
  124451. * Defines the rate of change of heightOffset.
  124452. */
  124453. heightSensibility: number;
  124454. /**
  124455. * Defines the rate of change of rotationOffset.
  124456. */
  124457. rotationSensibility: number;
  124458. /**
  124459. * Defines the rate of change of radius.
  124460. */
  124461. radiusSensibility: number;
  124462. private _keys;
  124463. private _ctrlPressed;
  124464. private _altPressed;
  124465. private _shiftPressed;
  124466. private _onCanvasBlurObserver;
  124467. private _onKeyboardObserver;
  124468. private _engine;
  124469. private _scene;
  124470. /**
  124471. * Attach the input controls to a specific dom element to get the input from.
  124472. * @param element Defines the element the controls should be listened from
  124473. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124474. */
  124475. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124476. /**
  124477. * Detach the current controls from the specified dom element.
  124478. * @param element Defines the element to stop listening the inputs from
  124479. */
  124480. detachControl(element: Nullable<HTMLElement>): void;
  124481. /**
  124482. * Update the current camera state depending on the inputs that have been used this frame.
  124483. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124484. */
  124485. checkInputs(): void;
  124486. /**
  124487. * Gets the class name of the current input.
  124488. * @returns the class name
  124489. */
  124490. getClassName(): string;
  124491. /**
  124492. * Get the friendly name associated with the input class.
  124493. * @returns the input friendly name
  124494. */
  124495. getSimpleName(): string;
  124496. /**
  124497. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124498. * allow modification of the heightOffset value.
  124499. */
  124500. private _modifierHeightOffset;
  124501. /**
  124502. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124503. * allow modification of the rotationOffset value.
  124504. */
  124505. private _modifierRotationOffset;
  124506. /**
  124507. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124508. * allow modification of the radius value.
  124509. */
  124510. private _modifierRadius;
  124511. }
  124512. }
  124513. declare module BABYLON {
  124514. interface FreeCameraInputsManager {
  124515. /**
  124516. * @hidden
  124517. */
  124518. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  124519. /**
  124520. * Add orientation input support to the input manager.
  124521. * @returns the current input manager
  124522. */
  124523. addDeviceOrientation(): FreeCameraInputsManager;
  124524. }
  124525. /**
  124526. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  124527. * Screen rotation is taken into account.
  124528. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124529. */
  124530. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  124531. private _camera;
  124532. private _screenOrientationAngle;
  124533. private _constantTranform;
  124534. private _screenQuaternion;
  124535. private _alpha;
  124536. private _beta;
  124537. private _gamma;
  124538. /**
  124539. * Can be used to detect if a device orientation sensor is available on a device
  124540. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  124541. * @returns a promise that will resolve on orientation change
  124542. */
  124543. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  124544. /**
  124545. * @hidden
  124546. */
  124547. _onDeviceOrientationChangedObservable: Observable<void>;
  124548. /**
  124549. * Instantiates a new input
  124550. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124551. */
  124552. constructor();
  124553. /**
  124554. * Define the camera controlled by the input.
  124555. */
  124556. get camera(): FreeCamera;
  124557. set camera(camera: FreeCamera);
  124558. /**
  124559. * Attach the input controls to a specific dom element to get the input from.
  124560. * @param element Defines the element the controls should be listened from
  124561. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124562. */
  124563. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124564. private _orientationChanged;
  124565. private _deviceOrientation;
  124566. /**
  124567. * Detach the current controls from the specified dom element.
  124568. * @param element Defines the element to stop listening the inputs from
  124569. */
  124570. detachControl(element: Nullable<HTMLElement>): void;
  124571. /**
  124572. * Update the current camera state depending on the inputs that have been used this frame.
  124573. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124574. */
  124575. checkInputs(): void;
  124576. /**
  124577. * Gets the class name of the current intput.
  124578. * @returns the class name
  124579. */
  124580. getClassName(): string;
  124581. /**
  124582. * Get the friendly name associated with the input class.
  124583. * @returns the input friendly name
  124584. */
  124585. getSimpleName(): string;
  124586. }
  124587. }
  124588. declare module BABYLON {
  124589. /**
  124590. * Manage the gamepad inputs to control a free camera.
  124591. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124592. */
  124593. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  124594. /**
  124595. * Define the camera the input is attached to.
  124596. */
  124597. camera: FreeCamera;
  124598. /**
  124599. * Define the Gamepad controlling the input
  124600. */
  124601. gamepad: Nullable<Gamepad>;
  124602. /**
  124603. * Defines the gamepad rotation sensiblity.
  124604. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  124605. */
  124606. gamepadAngularSensibility: number;
  124607. /**
  124608. * Defines the gamepad move sensiblity.
  124609. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  124610. */
  124611. gamepadMoveSensibility: number;
  124612. private _yAxisScale;
  124613. /**
  124614. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  124615. */
  124616. get invertYAxis(): boolean;
  124617. set invertYAxis(value: boolean);
  124618. private _onGamepadConnectedObserver;
  124619. private _onGamepadDisconnectedObserver;
  124620. private _cameraTransform;
  124621. private _deltaTransform;
  124622. private _vector3;
  124623. private _vector2;
  124624. /**
  124625. * Attach the input controls to a specific dom element to get the input from.
  124626. * @param element Defines the element the controls should be listened from
  124627. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124628. */
  124629. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124630. /**
  124631. * Detach the current controls from the specified dom element.
  124632. * @param element Defines the element to stop listening the inputs from
  124633. */
  124634. detachControl(element: Nullable<HTMLElement>): void;
  124635. /**
  124636. * Update the current camera state depending on the inputs that have been used this frame.
  124637. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124638. */
  124639. checkInputs(): void;
  124640. /**
  124641. * Gets the class name of the current intput.
  124642. * @returns the class name
  124643. */
  124644. getClassName(): string;
  124645. /**
  124646. * Get the friendly name associated with the input class.
  124647. * @returns the input friendly name
  124648. */
  124649. getSimpleName(): string;
  124650. }
  124651. }
  124652. declare module BABYLON {
  124653. /**
  124654. * Defines the potential axis of a Joystick
  124655. */
  124656. export enum JoystickAxis {
  124657. /** X axis */
  124658. X = 0,
  124659. /** Y axis */
  124660. Y = 1,
  124661. /** Z axis */
  124662. Z = 2
  124663. }
  124664. /**
  124665. * Represents the different customization options available
  124666. * for VirtualJoystick
  124667. */
  124668. interface VirtualJoystickCustomizations {
  124669. /**
  124670. * Size of the joystick's puck
  124671. */
  124672. puckSize: number;
  124673. /**
  124674. * Size of the joystick's container
  124675. */
  124676. containerSize: number;
  124677. /**
  124678. * Color of the joystick && puck
  124679. */
  124680. color: string;
  124681. /**
  124682. * Image URL for the joystick's puck
  124683. */
  124684. puckImage?: string;
  124685. /**
  124686. * Image URL for the joystick's container
  124687. */
  124688. containerImage?: string;
  124689. /**
  124690. * Defines the unmoving position of the joystick container
  124691. */
  124692. position?: {
  124693. x: number;
  124694. y: number;
  124695. };
  124696. /**
  124697. * Defines whether or not the joystick container is always visible
  124698. */
  124699. alwaysVisible: boolean;
  124700. /**
  124701. * Defines whether or not to limit the movement of the puck to the joystick's container
  124702. */
  124703. limitToContainer: boolean;
  124704. }
  124705. /**
  124706. * Class used to define virtual joystick (used in touch mode)
  124707. */
  124708. export class VirtualJoystick {
  124709. /**
  124710. * Gets or sets a boolean indicating that left and right values must be inverted
  124711. */
  124712. reverseLeftRight: boolean;
  124713. /**
  124714. * Gets or sets a boolean indicating that up and down values must be inverted
  124715. */
  124716. reverseUpDown: boolean;
  124717. /**
  124718. * Gets the offset value for the position (ie. the change of the position value)
  124719. */
  124720. deltaPosition: Vector3;
  124721. /**
  124722. * Gets a boolean indicating if the virtual joystick was pressed
  124723. */
  124724. pressed: boolean;
  124725. /**
  124726. * Canvas the virtual joystick will render onto, default z-index of this is 5
  124727. */
  124728. static Canvas: Nullable<HTMLCanvasElement>;
  124729. /**
  124730. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  124731. */
  124732. limitToContainer: boolean;
  124733. private static _globalJoystickIndex;
  124734. private static _alwaysVisibleSticks;
  124735. private static vjCanvasContext;
  124736. private static vjCanvasWidth;
  124737. private static vjCanvasHeight;
  124738. private static halfWidth;
  124739. private static _GetDefaultOptions;
  124740. private _action;
  124741. private _axisTargetedByLeftAndRight;
  124742. private _axisTargetedByUpAndDown;
  124743. private _joystickSensibility;
  124744. private _inversedSensibility;
  124745. private _joystickPointerID;
  124746. private _joystickColor;
  124747. private _joystickPointerPos;
  124748. private _joystickPreviousPointerPos;
  124749. private _joystickPointerStartPos;
  124750. private _deltaJoystickVector;
  124751. private _leftJoystick;
  124752. private _touches;
  124753. private _joystickPosition;
  124754. private _alwaysVisible;
  124755. private _puckImage;
  124756. private _containerImage;
  124757. private _joystickPuckSize;
  124758. private _joystickContainerSize;
  124759. private _clearPuckSize;
  124760. private _clearContainerSize;
  124761. private _clearPuckSizeOffset;
  124762. private _clearContainerSizeOffset;
  124763. private _onPointerDownHandlerRef;
  124764. private _onPointerMoveHandlerRef;
  124765. private _onPointerUpHandlerRef;
  124766. private _onResize;
  124767. /**
  124768. * Creates a new virtual joystick
  124769. * @param leftJoystick defines that the joystick is for left hand (false by default)
  124770. * @param customizations Defines the options we want to customize the VirtualJoystick
  124771. */
  124772. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  124773. /**
  124774. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  124775. * @param newJoystickSensibility defines the new sensibility
  124776. */
  124777. setJoystickSensibility(newJoystickSensibility: number): void;
  124778. private _onPointerDown;
  124779. private _onPointerMove;
  124780. private _onPointerUp;
  124781. /**
  124782. * Change the color of the virtual joystick
  124783. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  124784. */
  124785. setJoystickColor(newColor: string): void;
  124786. /**
  124787. * Size of the joystick's container
  124788. */
  124789. set containerSize(newSize: number);
  124790. get containerSize(): number;
  124791. /**
  124792. * Size of the joystick's puck
  124793. */
  124794. set puckSize(newSize: number);
  124795. get puckSize(): number;
  124796. /**
  124797. * Clears the set position of the joystick
  124798. */
  124799. clearPosition(): void;
  124800. /**
  124801. * Defines whether or not the joystick container is always visible
  124802. */
  124803. set alwaysVisible(value: boolean);
  124804. get alwaysVisible(): boolean;
  124805. /**
  124806. * Sets the constant position of the Joystick container
  124807. * @param x X axis coordinate
  124808. * @param y Y axis coordinate
  124809. */
  124810. setPosition(x: number, y: number): void;
  124811. /**
  124812. * Defines a callback to call when the joystick is touched
  124813. * @param action defines the callback
  124814. */
  124815. setActionOnTouch(action: () => any): void;
  124816. /**
  124817. * Defines which axis you'd like to control for left & right
  124818. * @param axis defines the axis to use
  124819. */
  124820. setAxisForLeftRight(axis: JoystickAxis): void;
  124821. /**
  124822. * Defines which axis you'd like to control for up & down
  124823. * @param axis defines the axis to use
  124824. */
  124825. setAxisForUpDown(axis: JoystickAxis): void;
  124826. /**
  124827. * Clears the canvas from the previous puck / container draw
  124828. */
  124829. private _clearPreviousDraw;
  124830. /**
  124831. * Loads `urlPath` to be used for the container's image
  124832. * @param urlPath defines the urlPath of an image to use
  124833. */
  124834. setContainerImage(urlPath: string): void;
  124835. /**
  124836. * Loads `urlPath` to be used for the puck's image
  124837. * @param urlPath defines the urlPath of an image to use
  124838. */
  124839. setPuckImage(urlPath: string): void;
  124840. /**
  124841. * Draws the Virtual Joystick's container
  124842. */
  124843. private _drawContainer;
  124844. /**
  124845. * Draws the Virtual Joystick's puck
  124846. */
  124847. private _drawPuck;
  124848. private _drawVirtualJoystick;
  124849. /**
  124850. * Release internal HTML canvas
  124851. */
  124852. releaseCanvas(): void;
  124853. }
  124854. }
  124855. declare module BABYLON {
  124856. interface FreeCameraInputsManager {
  124857. /**
  124858. * Add virtual joystick input support to the input manager.
  124859. * @returns the current input manager
  124860. */
  124861. addVirtualJoystick(): FreeCameraInputsManager;
  124862. }
  124863. /**
  124864. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  124865. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124866. */
  124867. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  124868. /**
  124869. * Defines the camera the input is attached to.
  124870. */
  124871. camera: FreeCamera;
  124872. private _leftjoystick;
  124873. private _rightjoystick;
  124874. /**
  124875. * Gets the left stick of the virtual joystick.
  124876. * @returns The virtual Joystick
  124877. */
  124878. getLeftJoystick(): VirtualJoystick;
  124879. /**
  124880. * Gets the right stick of the virtual joystick.
  124881. * @returns The virtual Joystick
  124882. */
  124883. getRightJoystick(): VirtualJoystick;
  124884. /**
  124885. * Update the current camera state depending on the inputs that have been used this frame.
  124886. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124887. */
  124888. checkInputs(): void;
  124889. /**
  124890. * Attach the input controls to a specific dom element to get the input from.
  124891. * @param element Defines the element the controls should be listened from
  124892. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124893. */
  124894. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124895. /**
  124896. * Detach the current controls from the specified dom element.
  124897. * @param element Defines the element to stop listening the inputs from
  124898. */
  124899. detachControl(element: Nullable<HTMLElement>): void;
  124900. /**
  124901. * Gets the class name of the current intput.
  124902. * @returns the class name
  124903. */
  124904. getClassName(): string;
  124905. /**
  124906. * Get the friendly name associated with the input class.
  124907. * @returns the input friendly name
  124908. */
  124909. getSimpleName(): string;
  124910. }
  124911. }
  124912. declare module BABYLON {
  124913. /**
  124914. * This represents a FPS type of camera controlled by touch.
  124915. * This is like a universal camera minus the Gamepad controls.
  124916. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124917. */
  124918. export class TouchCamera extends FreeCamera {
  124919. /**
  124920. * Defines the touch sensibility for rotation.
  124921. * The higher the faster.
  124922. */
  124923. get touchAngularSensibility(): number;
  124924. set touchAngularSensibility(value: number);
  124925. /**
  124926. * Defines the touch sensibility for move.
  124927. * The higher the faster.
  124928. */
  124929. get touchMoveSensibility(): number;
  124930. set touchMoveSensibility(value: number);
  124931. /**
  124932. * Instantiates a new touch camera.
  124933. * This represents a FPS type of camera controlled by touch.
  124934. * This is like a universal camera minus the Gamepad controls.
  124935. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124936. * @param name Define the name of the camera in the scene
  124937. * @param position Define the start position of the camera in the scene
  124938. * @param scene Define the scene the camera belongs to
  124939. */
  124940. constructor(name: string, position: Vector3, scene: Scene);
  124941. /**
  124942. * Gets the current object class name.
  124943. * @return the class name
  124944. */
  124945. getClassName(): string;
  124946. /** @hidden */
  124947. _setupInputs(): void;
  124948. }
  124949. }
  124950. declare module BABYLON {
  124951. /**
  124952. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  124953. * being tilted forward or back and left or right.
  124954. */
  124955. export class DeviceOrientationCamera extends FreeCamera {
  124956. private _initialQuaternion;
  124957. private _quaternionCache;
  124958. private _tmpDragQuaternion;
  124959. private _disablePointerInputWhenUsingDeviceOrientation;
  124960. /**
  124961. * Creates a new device orientation camera
  124962. * @param name The name of the camera
  124963. * @param position The start position camera
  124964. * @param scene The scene the camera belongs to
  124965. */
  124966. constructor(name: string, position: Vector3, scene: Scene);
  124967. /**
  124968. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  124969. */
  124970. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  124971. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  124972. private _dragFactor;
  124973. /**
  124974. * Enabled turning on the y axis when the orientation sensor is active
  124975. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  124976. */
  124977. enableHorizontalDragging(dragFactor?: number): void;
  124978. /**
  124979. * Gets the current instance class name ("DeviceOrientationCamera").
  124980. * This helps avoiding instanceof at run time.
  124981. * @returns the class name
  124982. */
  124983. getClassName(): string;
  124984. /**
  124985. * @hidden
  124986. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  124987. */
  124988. _checkInputs(): void;
  124989. /**
  124990. * Reset the camera to its default orientation on the specified axis only.
  124991. * @param axis The axis to reset
  124992. */
  124993. resetToCurrentRotation(axis?: Axis): void;
  124994. }
  124995. }
  124996. declare module BABYLON {
  124997. /**
  124998. * Defines supported buttons for XBox360 compatible gamepads
  124999. */
  125000. export enum Xbox360Button {
  125001. /** A */
  125002. A = 0,
  125003. /** B */
  125004. B = 1,
  125005. /** X */
  125006. X = 2,
  125007. /** Y */
  125008. Y = 3,
  125009. /** Left button */
  125010. LB = 4,
  125011. /** Right button */
  125012. RB = 5,
  125013. /** Back */
  125014. Back = 8,
  125015. /** Start */
  125016. Start = 9,
  125017. /** Left stick */
  125018. LeftStick = 10,
  125019. /** Right stick */
  125020. RightStick = 11
  125021. }
  125022. /** Defines values for XBox360 DPad */
  125023. export enum Xbox360Dpad {
  125024. /** Up */
  125025. Up = 12,
  125026. /** Down */
  125027. Down = 13,
  125028. /** Left */
  125029. Left = 14,
  125030. /** Right */
  125031. Right = 15
  125032. }
  125033. /**
  125034. * Defines a XBox360 gamepad
  125035. */
  125036. export class Xbox360Pad extends Gamepad {
  125037. private _leftTrigger;
  125038. private _rightTrigger;
  125039. private _onlefttriggerchanged;
  125040. private _onrighttriggerchanged;
  125041. private _onbuttondown;
  125042. private _onbuttonup;
  125043. private _ondpaddown;
  125044. private _ondpadup;
  125045. /** Observable raised when a button is pressed */
  125046. onButtonDownObservable: Observable<Xbox360Button>;
  125047. /** Observable raised when a button is released */
  125048. onButtonUpObservable: Observable<Xbox360Button>;
  125049. /** Observable raised when a pad is pressed */
  125050. onPadDownObservable: Observable<Xbox360Dpad>;
  125051. /** Observable raised when a pad is released */
  125052. onPadUpObservable: Observable<Xbox360Dpad>;
  125053. private _buttonA;
  125054. private _buttonB;
  125055. private _buttonX;
  125056. private _buttonY;
  125057. private _buttonBack;
  125058. private _buttonStart;
  125059. private _buttonLB;
  125060. private _buttonRB;
  125061. private _buttonLeftStick;
  125062. private _buttonRightStick;
  125063. private _dPadUp;
  125064. private _dPadDown;
  125065. private _dPadLeft;
  125066. private _dPadRight;
  125067. private _isXboxOnePad;
  125068. /**
  125069. * Creates a new XBox360 gamepad object
  125070. * @param id defines the id of this gamepad
  125071. * @param index defines its index
  125072. * @param gamepad defines the internal HTML gamepad object
  125073. * @param xboxOne defines if it is a XBox One gamepad
  125074. */
  125075. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  125076. /**
  125077. * Defines the callback to call when left trigger is pressed
  125078. * @param callback defines the callback to use
  125079. */
  125080. onlefttriggerchanged(callback: (value: number) => void): void;
  125081. /**
  125082. * Defines the callback to call when right trigger is pressed
  125083. * @param callback defines the callback to use
  125084. */
  125085. onrighttriggerchanged(callback: (value: number) => void): void;
  125086. /**
  125087. * Gets the left trigger value
  125088. */
  125089. get leftTrigger(): number;
  125090. /**
  125091. * Sets the left trigger value
  125092. */
  125093. set leftTrigger(newValue: number);
  125094. /**
  125095. * Gets the right trigger value
  125096. */
  125097. get rightTrigger(): number;
  125098. /**
  125099. * Sets the right trigger value
  125100. */
  125101. set rightTrigger(newValue: number);
  125102. /**
  125103. * Defines the callback to call when a button is pressed
  125104. * @param callback defines the callback to use
  125105. */
  125106. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  125107. /**
  125108. * Defines the callback to call when a button is released
  125109. * @param callback defines the callback to use
  125110. */
  125111. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  125112. /**
  125113. * Defines the callback to call when a pad is pressed
  125114. * @param callback defines the callback to use
  125115. */
  125116. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  125117. /**
  125118. * Defines the callback to call when a pad is released
  125119. * @param callback defines the callback to use
  125120. */
  125121. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  125122. private _setButtonValue;
  125123. private _setDPadValue;
  125124. /**
  125125. * Gets the value of the `A` button
  125126. */
  125127. get buttonA(): number;
  125128. /**
  125129. * Sets the value of the `A` button
  125130. */
  125131. set buttonA(value: number);
  125132. /**
  125133. * Gets the value of the `B` button
  125134. */
  125135. get buttonB(): number;
  125136. /**
  125137. * Sets the value of the `B` button
  125138. */
  125139. set buttonB(value: number);
  125140. /**
  125141. * Gets the value of the `X` button
  125142. */
  125143. get buttonX(): number;
  125144. /**
  125145. * Sets the value of the `X` button
  125146. */
  125147. set buttonX(value: number);
  125148. /**
  125149. * Gets the value of the `Y` button
  125150. */
  125151. get buttonY(): number;
  125152. /**
  125153. * Sets the value of the `Y` button
  125154. */
  125155. set buttonY(value: number);
  125156. /**
  125157. * Gets the value of the `Start` button
  125158. */
  125159. get buttonStart(): number;
  125160. /**
  125161. * Sets the value of the `Start` button
  125162. */
  125163. set buttonStart(value: number);
  125164. /**
  125165. * Gets the value of the `Back` button
  125166. */
  125167. get buttonBack(): number;
  125168. /**
  125169. * Sets the value of the `Back` button
  125170. */
  125171. set buttonBack(value: number);
  125172. /**
  125173. * Gets the value of the `Left` button
  125174. */
  125175. get buttonLB(): number;
  125176. /**
  125177. * Sets the value of the `Left` button
  125178. */
  125179. set buttonLB(value: number);
  125180. /**
  125181. * Gets the value of the `Right` button
  125182. */
  125183. get buttonRB(): number;
  125184. /**
  125185. * Sets the value of the `Right` button
  125186. */
  125187. set buttonRB(value: number);
  125188. /**
  125189. * Gets the value of the Left joystick
  125190. */
  125191. get buttonLeftStick(): number;
  125192. /**
  125193. * Sets the value of the Left joystick
  125194. */
  125195. set buttonLeftStick(value: number);
  125196. /**
  125197. * Gets the value of the Right joystick
  125198. */
  125199. get buttonRightStick(): number;
  125200. /**
  125201. * Sets the value of the Right joystick
  125202. */
  125203. set buttonRightStick(value: number);
  125204. /**
  125205. * Gets the value of D-pad up
  125206. */
  125207. get dPadUp(): number;
  125208. /**
  125209. * Sets the value of D-pad up
  125210. */
  125211. set dPadUp(value: number);
  125212. /**
  125213. * Gets the value of D-pad down
  125214. */
  125215. get dPadDown(): number;
  125216. /**
  125217. * Sets the value of D-pad down
  125218. */
  125219. set dPadDown(value: number);
  125220. /**
  125221. * Gets the value of D-pad left
  125222. */
  125223. get dPadLeft(): number;
  125224. /**
  125225. * Sets the value of D-pad left
  125226. */
  125227. set dPadLeft(value: number);
  125228. /**
  125229. * Gets the value of D-pad right
  125230. */
  125231. get dPadRight(): number;
  125232. /**
  125233. * Sets the value of D-pad right
  125234. */
  125235. set dPadRight(value: number);
  125236. /**
  125237. * Force the gamepad to synchronize with device values
  125238. */
  125239. update(): void;
  125240. /**
  125241. * Disposes the gamepad
  125242. */
  125243. dispose(): void;
  125244. }
  125245. }
  125246. declare module BABYLON {
  125247. /**
  125248. * Defines supported buttons for DualShock compatible gamepads
  125249. */
  125250. export enum DualShockButton {
  125251. /** Cross */
  125252. Cross = 0,
  125253. /** Circle */
  125254. Circle = 1,
  125255. /** Square */
  125256. Square = 2,
  125257. /** Triangle */
  125258. Triangle = 3,
  125259. /** L1 */
  125260. L1 = 4,
  125261. /** R1 */
  125262. R1 = 5,
  125263. /** Share */
  125264. Share = 8,
  125265. /** Options */
  125266. Options = 9,
  125267. /** Left stick */
  125268. LeftStick = 10,
  125269. /** Right stick */
  125270. RightStick = 11
  125271. }
  125272. /** Defines values for DualShock DPad */
  125273. export enum DualShockDpad {
  125274. /** Up */
  125275. Up = 12,
  125276. /** Down */
  125277. Down = 13,
  125278. /** Left */
  125279. Left = 14,
  125280. /** Right */
  125281. Right = 15
  125282. }
  125283. /**
  125284. * Defines a DualShock gamepad
  125285. */
  125286. export class DualShockPad extends Gamepad {
  125287. private _leftTrigger;
  125288. private _rightTrigger;
  125289. private _onlefttriggerchanged;
  125290. private _onrighttriggerchanged;
  125291. private _onbuttondown;
  125292. private _onbuttonup;
  125293. private _ondpaddown;
  125294. private _ondpadup;
  125295. /** Observable raised when a button is pressed */
  125296. onButtonDownObservable: Observable<DualShockButton>;
  125297. /** Observable raised when a button is released */
  125298. onButtonUpObservable: Observable<DualShockButton>;
  125299. /** Observable raised when a pad is pressed */
  125300. onPadDownObservable: Observable<DualShockDpad>;
  125301. /** Observable raised when a pad is released */
  125302. onPadUpObservable: Observable<DualShockDpad>;
  125303. private _buttonCross;
  125304. private _buttonCircle;
  125305. private _buttonSquare;
  125306. private _buttonTriangle;
  125307. private _buttonShare;
  125308. private _buttonOptions;
  125309. private _buttonL1;
  125310. private _buttonR1;
  125311. private _buttonLeftStick;
  125312. private _buttonRightStick;
  125313. private _dPadUp;
  125314. private _dPadDown;
  125315. private _dPadLeft;
  125316. private _dPadRight;
  125317. /**
  125318. * Creates a new DualShock gamepad object
  125319. * @param id defines the id of this gamepad
  125320. * @param index defines its index
  125321. * @param gamepad defines the internal HTML gamepad object
  125322. */
  125323. constructor(id: string, index: number, gamepad: any);
  125324. /**
  125325. * Defines the callback to call when left trigger is pressed
  125326. * @param callback defines the callback to use
  125327. */
  125328. onlefttriggerchanged(callback: (value: number) => void): void;
  125329. /**
  125330. * Defines the callback to call when right trigger is pressed
  125331. * @param callback defines the callback to use
  125332. */
  125333. onrighttriggerchanged(callback: (value: number) => void): void;
  125334. /**
  125335. * Gets the left trigger value
  125336. */
  125337. get leftTrigger(): number;
  125338. /**
  125339. * Sets the left trigger value
  125340. */
  125341. set leftTrigger(newValue: number);
  125342. /**
  125343. * Gets the right trigger value
  125344. */
  125345. get rightTrigger(): number;
  125346. /**
  125347. * Sets the right trigger value
  125348. */
  125349. set rightTrigger(newValue: number);
  125350. /**
  125351. * Defines the callback to call when a button is pressed
  125352. * @param callback defines the callback to use
  125353. */
  125354. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  125355. /**
  125356. * Defines the callback to call when a button is released
  125357. * @param callback defines the callback to use
  125358. */
  125359. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  125360. /**
  125361. * Defines the callback to call when a pad is pressed
  125362. * @param callback defines the callback to use
  125363. */
  125364. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  125365. /**
  125366. * Defines the callback to call when a pad is released
  125367. * @param callback defines the callback to use
  125368. */
  125369. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  125370. private _setButtonValue;
  125371. private _setDPadValue;
  125372. /**
  125373. * Gets the value of the `Cross` button
  125374. */
  125375. get buttonCross(): number;
  125376. /**
  125377. * Sets the value of the `Cross` button
  125378. */
  125379. set buttonCross(value: number);
  125380. /**
  125381. * Gets the value of the `Circle` button
  125382. */
  125383. get buttonCircle(): number;
  125384. /**
  125385. * Sets the value of the `Circle` button
  125386. */
  125387. set buttonCircle(value: number);
  125388. /**
  125389. * Gets the value of the `Square` button
  125390. */
  125391. get buttonSquare(): number;
  125392. /**
  125393. * Sets the value of the `Square` button
  125394. */
  125395. set buttonSquare(value: number);
  125396. /**
  125397. * Gets the value of the `Triangle` button
  125398. */
  125399. get buttonTriangle(): number;
  125400. /**
  125401. * Sets the value of the `Triangle` button
  125402. */
  125403. set buttonTriangle(value: number);
  125404. /**
  125405. * Gets the value of the `Options` button
  125406. */
  125407. get buttonOptions(): number;
  125408. /**
  125409. * Sets the value of the `Options` button
  125410. */
  125411. set buttonOptions(value: number);
  125412. /**
  125413. * Gets the value of the `Share` button
  125414. */
  125415. get buttonShare(): number;
  125416. /**
  125417. * Sets the value of the `Share` button
  125418. */
  125419. set buttonShare(value: number);
  125420. /**
  125421. * Gets the value of the `L1` button
  125422. */
  125423. get buttonL1(): number;
  125424. /**
  125425. * Sets the value of the `L1` button
  125426. */
  125427. set buttonL1(value: number);
  125428. /**
  125429. * Gets the value of the `R1` button
  125430. */
  125431. get buttonR1(): number;
  125432. /**
  125433. * Sets the value of the `R1` button
  125434. */
  125435. set buttonR1(value: number);
  125436. /**
  125437. * Gets the value of the Left joystick
  125438. */
  125439. get buttonLeftStick(): number;
  125440. /**
  125441. * Sets the value of the Left joystick
  125442. */
  125443. set buttonLeftStick(value: number);
  125444. /**
  125445. * Gets the value of the Right joystick
  125446. */
  125447. get buttonRightStick(): number;
  125448. /**
  125449. * Sets the value of the Right joystick
  125450. */
  125451. set buttonRightStick(value: number);
  125452. /**
  125453. * Gets the value of D-pad up
  125454. */
  125455. get dPadUp(): number;
  125456. /**
  125457. * Sets the value of D-pad up
  125458. */
  125459. set dPadUp(value: number);
  125460. /**
  125461. * Gets the value of D-pad down
  125462. */
  125463. get dPadDown(): number;
  125464. /**
  125465. * Sets the value of D-pad down
  125466. */
  125467. set dPadDown(value: number);
  125468. /**
  125469. * Gets the value of D-pad left
  125470. */
  125471. get dPadLeft(): number;
  125472. /**
  125473. * Sets the value of D-pad left
  125474. */
  125475. set dPadLeft(value: number);
  125476. /**
  125477. * Gets the value of D-pad right
  125478. */
  125479. get dPadRight(): number;
  125480. /**
  125481. * Sets the value of D-pad right
  125482. */
  125483. set dPadRight(value: number);
  125484. /**
  125485. * Force the gamepad to synchronize with device values
  125486. */
  125487. update(): void;
  125488. /**
  125489. * Disposes the gamepad
  125490. */
  125491. dispose(): void;
  125492. }
  125493. }
  125494. declare module BABYLON {
  125495. /**
  125496. * Manager for handling gamepads
  125497. */
  125498. export class GamepadManager {
  125499. private _scene?;
  125500. private _babylonGamepads;
  125501. private _oneGamepadConnected;
  125502. /** @hidden */
  125503. _isMonitoring: boolean;
  125504. private _gamepadEventSupported;
  125505. private _gamepadSupport?;
  125506. /**
  125507. * observable to be triggered when the gamepad controller has been connected
  125508. */
  125509. onGamepadConnectedObservable: Observable<Gamepad>;
  125510. /**
  125511. * observable to be triggered when the gamepad controller has been disconnected
  125512. */
  125513. onGamepadDisconnectedObservable: Observable<Gamepad>;
  125514. private _onGamepadConnectedEvent;
  125515. private _onGamepadDisconnectedEvent;
  125516. /**
  125517. * Initializes the gamepad manager
  125518. * @param _scene BabylonJS scene
  125519. */
  125520. constructor(_scene?: Scene | undefined);
  125521. /**
  125522. * The gamepads in the game pad manager
  125523. */
  125524. get gamepads(): Gamepad[];
  125525. /**
  125526. * Get the gamepad controllers based on type
  125527. * @param type The type of gamepad controller
  125528. * @returns Nullable gamepad
  125529. */
  125530. getGamepadByType(type?: number): Nullable<Gamepad>;
  125531. /**
  125532. * Disposes the gamepad manager
  125533. */
  125534. dispose(): void;
  125535. private _addNewGamepad;
  125536. private _startMonitoringGamepads;
  125537. private _stopMonitoringGamepads;
  125538. /** @hidden */
  125539. _checkGamepadsStatus(): void;
  125540. private _updateGamepadObjects;
  125541. }
  125542. }
  125543. declare module BABYLON {
  125544. interface Scene {
  125545. /** @hidden */
  125546. _gamepadManager: Nullable<GamepadManager>;
  125547. /**
  125548. * Gets the gamepad manager associated with the scene
  125549. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  125550. */
  125551. gamepadManager: GamepadManager;
  125552. }
  125553. /**
  125554. * Interface representing a free camera inputs manager
  125555. */
  125556. interface FreeCameraInputsManager {
  125557. /**
  125558. * Adds gamepad input support to the FreeCameraInputsManager.
  125559. * @returns the FreeCameraInputsManager
  125560. */
  125561. addGamepad(): FreeCameraInputsManager;
  125562. }
  125563. /**
  125564. * Interface representing an arc rotate camera inputs manager
  125565. */
  125566. interface ArcRotateCameraInputsManager {
  125567. /**
  125568. * Adds gamepad input support to the ArcRotateCamera InputManager.
  125569. * @returns the camera inputs manager
  125570. */
  125571. addGamepad(): ArcRotateCameraInputsManager;
  125572. }
  125573. /**
  125574. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  125575. */
  125576. export class GamepadSystemSceneComponent implements ISceneComponent {
  125577. /**
  125578. * The component name helpfull to identify the component in the list of scene components.
  125579. */
  125580. readonly name: string;
  125581. /**
  125582. * The scene the component belongs to.
  125583. */
  125584. scene: Scene;
  125585. /**
  125586. * Creates a new instance of the component for the given scene
  125587. * @param scene Defines the scene to register the component in
  125588. */
  125589. constructor(scene: Scene);
  125590. /**
  125591. * Registers the component in a given scene
  125592. */
  125593. register(): void;
  125594. /**
  125595. * Rebuilds the elements related to this component in case of
  125596. * context lost for instance.
  125597. */
  125598. rebuild(): void;
  125599. /**
  125600. * Disposes the component and the associated ressources
  125601. */
  125602. dispose(): void;
  125603. private _beforeCameraUpdate;
  125604. }
  125605. }
  125606. declare module BABYLON {
  125607. /**
  125608. * 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,
  125609. * which still works and will still be found in many Playgrounds.
  125610. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125611. */
  125612. export class UniversalCamera extends TouchCamera {
  125613. /**
  125614. * Defines the gamepad rotation sensiblity.
  125615. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  125616. */
  125617. get gamepadAngularSensibility(): number;
  125618. set gamepadAngularSensibility(value: number);
  125619. /**
  125620. * Defines the gamepad move sensiblity.
  125621. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  125622. */
  125623. get gamepadMoveSensibility(): number;
  125624. set gamepadMoveSensibility(value: number);
  125625. /**
  125626. * 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,
  125627. * which still works and will still be found in many Playgrounds.
  125628. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125629. * @param name Define the name of the camera in the scene
  125630. * @param position Define the start position of the camera in the scene
  125631. * @param scene Define the scene the camera belongs to
  125632. */
  125633. constructor(name: string, position: Vector3, scene: Scene);
  125634. /**
  125635. * Gets the current object class name.
  125636. * @return the class name
  125637. */
  125638. getClassName(): string;
  125639. }
  125640. }
  125641. declare module BABYLON {
  125642. /**
  125643. * This represents a FPS type of camera. This is only here for back compat purpose.
  125644. * Please use the UniversalCamera instead as both are identical.
  125645. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125646. */
  125647. export class GamepadCamera extends UniversalCamera {
  125648. /**
  125649. * Instantiates a new Gamepad Camera
  125650. * This represents a FPS type of camera. This is only here for back compat purpose.
  125651. * Please use the UniversalCamera instead as both are identical.
  125652. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125653. * @param name Define the name of the camera in the scene
  125654. * @param position Define the start position of the camera in the scene
  125655. * @param scene Define the scene the camera belongs to
  125656. */
  125657. constructor(name: string, position: Vector3, scene: Scene);
  125658. /**
  125659. * Gets the current object class name.
  125660. * @return the class name
  125661. */
  125662. getClassName(): string;
  125663. }
  125664. }
  125665. declare module BABYLON {
  125666. /** @hidden */
  125667. export var passPixelShader: {
  125668. name: string;
  125669. shader: string;
  125670. };
  125671. }
  125672. declare module BABYLON {
  125673. /** @hidden */
  125674. export var passCubePixelShader: {
  125675. name: string;
  125676. shader: string;
  125677. };
  125678. }
  125679. declare module BABYLON {
  125680. /**
  125681. * PassPostProcess which produces an output the same as it's input
  125682. */
  125683. export class PassPostProcess extends PostProcess {
  125684. /**
  125685. * Gets a string identifying the name of the class
  125686. * @returns "PassPostProcess" string
  125687. */
  125688. getClassName(): string;
  125689. /**
  125690. * Creates the PassPostProcess
  125691. * @param name The name of the effect.
  125692. * @param options The required width/height ratio to downsize to before computing the render pass.
  125693. * @param camera The camera to apply the render pass to.
  125694. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125695. * @param engine The engine which the post process will be applied. (default: current engine)
  125696. * @param reusable If the post process can be reused on the same frame. (default: false)
  125697. * @param textureType The type of texture to be used when performing the post processing.
  125698. * @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)
  125699. */
  125700. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125701. /** @hidden */
  125702. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  125703. }
  125704. /**
  125705. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  125706. */
  125707. export class PassCubePostProcess extends PostProcess {
  125708. private _face;
  125709. /**
  125710. * Gets or sets the cube face to display.
  125711. * * 0 is +X
  125712. * * 1 is -X
  125713. * * 2 is +Y
  125714. * * 3 is -Y
  125715. * * 4 is +Z
  125716. * * 5 is -Z
  125717. */
  125718. get face(): number;
  125719. set face(value: number);
  125720. /**
  125721. * Gets a string identifying the name of the class
  125722. * @returns "PassCubePostProcess" string
  125723. */
  125724. getClassName(): string;
  125725. /**
  125726. * Creates the PassCubePostProcess
  125727. * @param name The name of the effect.
  125728. * @param options The required width/height ratio to downsize to before computing the render pass.
  125729. * @param camera The camera to apply the render pass to.
  125730. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125731. * @param engine The engine which the post process will be applied. (default: current engine)
  125732. * @param reusable If the post process can be reused on the same frame. (default: false)
  125733. * @param textureType The type of texture to be used when performing the post processing.
  125734. * @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)
  125735. */
  125736. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125737. /** @hidden */
  125738. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  125739. }
  125740. }
  125741. declare module BABYLON {
  125742. /** @hidden */
  125743. export var anaglyphPixelShader: {
  125744. name: string;
  125745. shader: string;
  125746. };
  125747. }
  125748. declare module BABYLON {
  125749. /**
  125750. * Postprocess used to generate anaglyphic rendering
  125751. */
  125752. export class AnaglyphPostProcess extends PostProcess {
  125753. private _passedProcess;
  125754. /**
  125755. * Gets a string identifying the name of the class
  125756. * @returns "AnaglyphPostProcess" string
  125757. */
  125758. getClassName(): string;
  125759. /**
  125760. * Creates a new AnaglyphPostProcess
  125761. * @param name defines postprocess name
  125762. * @param options defines creation options or target ratio scale
  125763. * @param rigCameras defines cameras using this postprocess
  125764. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  125765. * @param engine defines hosting engine
  125766. * @param reusable defines if the postprocess will be reused multiple times per frame
  125767. */
  125768. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  125769. }
  125770. }
  125771. declare module BABYLON {
  125772. /**
  125773. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  125774. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125775. */
  125776. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  125777. /**
  125778. * Creates a new AnaglyphArcRotateCamera
  125779. * @param name defines camera name
  125780. * @param alpha defines alpha angle (in radians)
  125781. * @param beta defines beta angle (in radians)
  125782. * @param radius defines radius
  125783. * @param target defines camera target
  125784. * @param interaxialDistance defines distance between each color axis
  125785. * @param scene defines the hosting scene
  125786. */
  125787. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  125788. /**
  125789. * Gets camera class name
  125790. * @returns AnaglyphArcRotateCamera
  125791. */
  125792. getClassName(): string;
  125793. }
  125794. }
  125795. declare module BABYLON {
  125796. /**
  125797. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  125798. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125799. */
  125800. export class AnaglyphFreeCamera extends FreeCamera {
  125801. /**
  125802. * Creates a new AnaglyphFreeCamera
  125803. * @param name defines camera name
  125804. * @param position defines initial position
  125805. * @param interaxialDistance defines distance between each color axis
  125806. * @param scene defines the hosting scene
  125807. */
  125808. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125809. /**
  125810. * Gets camera class name
  125811. * @returns AnaglyphFreeCamera
  125812. */
  125813. getClassName(): string;
  125814. }
  125815. }
  125816. declare module BABYLON {
  125817. /**
  125818. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  125819. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125820. */
  125821. export class AnaglyphGamepadCamera extends GamepadCamera {
  125822. /**
  125823. * Creates a new AnaglyphGamepadCamera
  125824. * @param name defines camera name
  125825. * @param position defines initial position
  125826. * @param interaxialDistance defines distance between each color axis
  125827. * @param scene defines the hosting scene
  125828. */
  125829. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125830. /**
  125831. * Gets camera class name
  125832. * @returns AnaglyphGamepadCamera
  125833. */
  125834. getClassName(): string;
  125835. }
  125836. }
  125837. declare module BABYLON {
  125838. /**
  125839. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  125840. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125841. */
  125842. export class AnaglyphUniversalCamera extends UniversalCamera {
  125843. /**
  125844. * Creates a new AnaglyphUniversalCamera
  125845. * @param name defines camera name
  125846. * @param position defines initial position
  125847. * @param interaxialDistance defines distance between each color axis
  125848. * @param scene defines the hosting scene
  125849. */
  125850. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125851. /**
  125852. * Gets camera class name
  125853. * @returns AnaglyphUniversalCamera
  125854. */
  125855. getClassName(): string;
  125856. }
  125857. }
  125858. declare module BABYLON {
  125859. /**
  125860. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  125861. * @see https://doc.babylonjs.com/features/cameras
  125862. */
  125863. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  125864. /**
  125865. * Creates a new StereoscopicArcRotateCamera
  125866. * @param name defines camera name
  125867. * @param alpha defines alpha angle (in radians)
  125868. * @param beta defines beta angle (in radians)
  125869. * @param radius defines radius
  125870. * @param target defines camera target
  125871. * @param interaxialDistance defines distance between each color axis
  125872. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125873. * @param scene defines the hosting scene
  125874. */
  125875. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125876. /**
  125877. * Gets camera class name
  125878. * @returns StereoscopicArcRotateCamera
  125879. */
  125880. getClassName(): string;
  125881. }
  125882. }
  125883. declare module BABYLON {
  125884. /**
  125885. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  125886. * @see https://doc.babylonjs.com/features/cameras
  125887. */
  125888. export class StereoscopicFreeCamera extends FreeCamera {
  125889. /**
  125890. * Creates a new StereoscopicFreeCamera
  125891. * @param name defines camera name
  125892. * @param position defines initial position
  125893. * @param interaxialDistance defines distance between each color axis
  125894. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125895. * @param scene defines the hosting scene
  125896. */
  125897. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125898. /**
  125899. * Gets camera class name
  125900. * @returns StereoscopicFreeCamera
  125901. */
  125902. getClassName(): string;
  125903. }
  125904. }
  125905. declare module BABYLON {
  125906. /**
  125907. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  125908. * @see https://doc.babylonjs.com/features/cameras
  125909. */
  125910. export class StereoscopicGamepadCamera extends GamepadCamera {
  125911. /**
  125912. * Creates a new StereoscopicGamepadCamera
  125913. * @param name defines camera name
  125914. * @param position defines initial position
  125915. * @param interaxialDistance defines distance between each color axis
  125916. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125917. * @param scene defines the hosting scene
  125918. */
  125919. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125920. /**
  125921. * Gets camera class name
  125922. * @returns StereoscopicGamepadCamera
  125923. */
  125924. getClassName(): string;
  125925. }
  125926. }
  125927. declare module BABYLON {
  125928. /**
  125929. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  125930. * @see https://doc.babylonjs.com/features/cameras
  125931. */
  125932. export class StereoscopicUniversalCamera extends UniversalCamera {
  125933. /**
  125934. * Creates a new StereoscopicUniversalCamera
  125935. * @param name defines camera name
  125936. * @param position defines initial position
  125937. * @param interaxialDistance defines distance between each color axis
  125938. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125939. * @param scene defines the hosting scene
  125940. */
  125941. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125942. /**
  125943. * Gets camera class name
  125944. * @returns StereoscopicUniversalCamera
  125945. */
  125946. getClassName(): string;
  125947. }
  125948. }
  125949. declare module BABYLON {
  125950. /**
  125951. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  125952. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125953. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125954. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125955. */
  125956. export class VirtualJoysticksCamera extends FreeCamera {
  125957. /**
  125958. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  125959. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125960. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125961. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125962. * @param name Define the name of the camera in the scene
  125963. * @param position Define the start position of the camera in the scene
  125964. * @param scene Define the scene the camera belongs to
  125965. */
  125966. constructor(name: string, position: Vector3, scene: Scene);
  125967. /**
  125968. * Gets the current object class name.
  125969. * @return the class name
  125970. */
  125971. getClassName(): string;
  125972. }
  125973. }
  125974. declare module BABYLON {
  125975. /**
  125976. * This represents all the required metrics to create a VR camera.
  125977. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  125978. */
  125979. export class VRCameraMetrics {
  125980. /**
  125981. * Define the horizontal resolution off the screen.
  125982. */
  125983. hResolution: number;
  125984. /**
  125985. * Define the vertical resolution off the screen.
  125986. */
  125987. vResolution: number;
  125988. /**
  125989. * Define the horizontal screen size.
  125990. */
  125991. hScreenSize: number;
  125992. /**
  125993. * Define the vertical screen size.
  125994. */
  125995. vScreenSize: number;
  125996. /**
  125997. * Define the vertical screen center position.
  125998. */
  125999. vScreenCenter: number;
  126000. /**
  126001. * Define the distance of the eyes to the screen.
  126002. */
  126003. eyeToScreenDistance: number;
  126004. /**
  126005. * Define the distance between both lenses
  126006. */
  126007. lensSeparationDistance: number;
  126008. /**
  126009. * Define the distance between both viewer's eyes.
  126010. */
  126011. interpupillaryDistance: number;
  126012. /**
  126013. * Define the distortion factor of the VR postprocess.
  126014. * Please, touch with care.
  126015. */
  126016. distortionK: number[];
  126017. /**
  126018. * Define the chromatic aberration correction factors for the VR post process.
  126019. */
  126020. chromaAbCorrection: number[];
  126021. /**
  126022. * Define the scale factor of the post process.
  126023. * The smaller the better but the slower.
  126024. */
  126025. postProcessScaleFactor: number;
  126026. /**
  126027. * Define an offset for the lens center.
  126028. */
  126029. lensCenterOffset: number;
  126030. /**
  126031. * Define if the current vr camera should compensate the distortion of the lense or not.
  126032. */
  126033. compensateDistortion: boolean;
  126034. /**
  126035. * Defines if multiview should be enabled when rendering (Default: false)
  126036. */
  126037. multiviewEnabled: boolean;
  126038. /**
  126039. * Gets the rendering aspect ratio based on the provided resolutions.
  126040. */
  126041. get aspectRatio(): number;
  126042. /**
  126043. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  126044. */
  126045. get aspectRatioFov(): number;
  126046. /**
  126047. * @hidden
  126048. */
  126049. get leftHMatrix(): Matrix;
  126050. /**
  126051. * @hidden
  126052. */
  126053. get rightHMatrix(): Matrix;
  126054. /**
  126055. * @hidden
  126056. */
  126057. get leftPreViewMatrix(): Matrix;
  126058. /**
  126059. * @hidden
  126060. */
  126061. get rightPreViewMatrix(): Matrix;
  126062. /**
  126063. * Get the default VRMetrics based on the most generic setup.
  126064. * @returns the default vr metrics
  126065. */
  126066. static GetDefault(): VRCameraMetrics;
  126067. }
  126068. }
  126069. declare module BABYLON {
  126070. /** @hidden */
  126071. export var vrDistortionCorrectionPixelShader: {
  126072. name: string;
  126073. shader: string;
  126074. };
  126075. }
  126076. declare module BABYLON {
  126077. /**
  126078. * VRDistortionCorrectionPostProcess used for mobile VR
  126079. */
  126080. export class VRDistortionCorrectionPostProcess extends PostProcess {
  126081. private _isRightEye;
  126082. private _distortionFactors;
  126083. private _postProcessScaleFactor;
  126084. private _lensCenterOffset;
  126085. private _scaleIn;
  126086. private _scaleFactor;
  126087. private _lensCenter;
  126088. /**
  126089. * Gets a string identifying the name of the class
  126090. * @returns "VRDistortionCorrectionPostProcess" string
  126091. */
  126092. getClassName(): string;
  126093. /**
  126094. * Initializes the VRDistortionCorrectionPostProcess
  126095. * @param name The name of the effect.
  126096. * @param camera The camera to apply the render pass to.
  126097. * @param isRightEye If this is for the right eye distortion
  126098. * @param vrMetrics All the required metrics for the VR camera
  126099. */
  126100. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  126101. }
  126102. }
  126103. declare module BABYLON {
  126104. /**
  126105. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  126106. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126107. */
  126108. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  126109. /**
  126110. * Creates a new VRDeviceOrientationArcRotateCamera
  126111. * @param name defines camera name
  126112. * @param alpha defines the camera rotation along the logitudinal axis
  126113. * @param beta defines the camera rotation along the latitudinal axis
  126114. * @param radius defines the camera distance from its target
  126115. * @param target defines the camera target
  126116. * @param scene defines the scene the camera belongs to
  126117. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126118. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126119. */
  126120. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126121. /**
  126122. * Gets camera class name
  126123. * @returns VRDeviceOrientationArcRotateCamera
  126124. */
  126125. getClassName(): string;
  126126. }
  126127. }
  126128. declare module BABYLON {
  126129. /**
  126130. * Camera used to simulate VR rendering (based on FreeCamera)
  126131. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126132. */
  126133. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  126134. /**
  126135. * Creates a new VRDeviceOrientationFreeCamera
  126136. * @param name defines camera name
  126137. * @param position defines the start position of the camera
  126138. * @param scene defines the scene the camera belongs to
  126139. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126140. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126141. */
  126142. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126143. /**
  126144. * Gets camera class name
  126145. * @returns VRDeviceOrientationFreeCamera
  126146. */
  126147. getClassName(): string;
  126148. }
  126149. }
  126150. declare module BABYLON {
  126151. /**
  126152. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  126153. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126154. */
  126155. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  126156. /**
  126157. * Creates a new VRDeviceOrientationGamepadCamera
  126158. * @param name defines camera name
  126159. * @param position defines the start position of the camera
  126160. * @param scene defines the scene the camera belongs to
  126161. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126162. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126163. */
  126164. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126165. /**
  126166. * Gets camera class name
  126167. * @returns VRDeviceOrientationGamepadCamera
  126168. */
  126169. getClassName(): string;
  126170. }
  126171. }
  126172. declare module BABYLON {
  126173. /**
  126174. * A class extending Texture allowing drawing on a texture
  126175. * @see https://doc.babylonjs.com/how_to/dynamictexture
  126176. */
  126177. export class DynamicTexture extends Texture {
  126178. private _generateMipMaps;
  126179. private _canvas;
  126180. private _context;
  126181. /**
  126182. * Creates a DynamicTexture
  126183. * @param name defines the name of the texture
  126184. * @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
  126185. * @param scene defines the scene where you want the texture
  126186. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  126187. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  126188. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  126189. */
  126190. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  126191. /**
  126192. * Get the current class name of the texture useful for serialization or dynamic coding.
  126193. * @returns "DynamicTexture"
  126194. */
  126195. getClassName(): string;
  126196. /**
  126197. * Gets the current state of canRescale
  126198. */
  126199. get canRescale(): boolean;
  126200. private _recreate;
  126201. /**
  126202. * Scales the texture
  126203. * @param ratio the scale factor to apply to both width and height
  126204. */
  126205. scale(ratio: number): void;
  126206. /**
  126207. * Resizes the texture
  126208. * @param width the new width
  126209. * @param height the new height
  126210. */
  126211. scaleTo(width: number, height: number): void;
  126212. /**
  126213. * Gets the context of the canvas used by the texture
  126214. * @returns the canvas context of the dynamic texture
  126215. */
  126216. getContext(): CanvasRenderingContext2D;
  126217. /**
  126218. * Clears the texture
  126219. */
  126220. clear(): void;
  126221. /**
  126222. * Updates the texture
  126223. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126224. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  126225. */
  126226. update(invertY?: boolean, premulAlpha?: boolean): void;
  126227. /**
  126228. * Draws text onto the texture
  126229. * @param text defines the text to be drawn
  126230. * @param x defines the placement of the text from the left
  126231. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  126232. * @param font defines the font to be used with font-style, font-size, font-name
  126233. * @param color defines the color used for the text
  126234. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  126235. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126236. * @param update defines whether texture is immediately update (default is true)
  126237. */
  126238. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  126239. /**
  126240. * Clones the texture
  126241. * @returns the clone of the texture.
  126242. */
  126243. clone(): DynamicTexture;
  126244. /**
  126245. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  126246. * @returns a serialized dynamic texture object
  126247. */
  126248. serialize(): any;
  126249. private _IsCanvasElement;
  126250. /** @hidden */
  126251. _rebuild(): void;
  126252. }
  126253. }
  126254. declare module BABYLON {
  126255. /**
  126256. * Class containing static functions to help procedurally build meshes
  126257. */
  126258. export class GroundBuilder {
  126259. /**
  126260. * Creates a ground mesh
  126261. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  126262. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  126263. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126264. * @param name defines the name of the mesh
  126265. * @param options defines the options used to create the mesh
  126266. * @param scene defines the hosting scene
  126267. * @returns the ground mesh
  126268. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  126269. */
  126270. static CreateGround(name: string, options: {
  126271. width?: number;
  126272. height?: number;
  126273. subdivisions?: number;
  126274. subdivisionsX?: number;
  126275. subdivisionsY?: number;
  126276. updatable?: boolean;
  126277. }, scene: any): Mesh;
  126278. /**
  126279. * Creates a tiled ground mesh
  126280. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  126281. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  126282. * * 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
  126283. * * 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
  126284. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126285. * @param name defines the name of the mesh
  126286. * @param options defines the options used to create the mesh
  126287. * @param scene defines the hosting scene
  126288. * @returns the tiled ground mesh
  126289. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  126290. */
  126291. static CreateTiledGround(name: string, options: {
  126292. xmin: number;
  126293. zmin: number;
  126294. xmax: number;
  126295. zmax: number;
  126296. subdivisions?: {
  126297. w: number;
  126298. h: number;
  126299. };
  126300. precision?: {
  126301. w: number;
  126302. h: number;
  126303. };
  126304. updatable?: boolean;
  126305. }, scene?: Nullable<Scene>): Mesh;
  126306. /**
  126307. * Creates a ground mesh from a height map
  126308. * * The parameter `url` sets the URL of the height map image resource.
  126309. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  126310. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  126311. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  126312. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  126313. * * 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.
  126314. * * 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).
  126315. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  126316. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126317. * @param name defines the name of the mesh
  126318. * @param url defines the url to the height map
  126319. * @param options defines the options used to create the mesh
  126320. * @param scene defines the hosting scene
  126321. * @returns the ground mesh
  126322. * @see https://doc.babylonjs.com/babylon101/height_map
  126323. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  126324. */
  126325. static CreateGroundFromHeightMap(name: string, url: string, options: {
  126326. width?: number;
  126327. height?: number;
  126328. subdivisions?: number;
  126329. minHeight?: number;
  126330. maxHeight?: number;
  126331. colorFilter?: Color3;
  126332. alphaFilter?: number;
  126333. updatable?: boolean;
  126334. onReady?: (mesh: GroundMesh) => void;
  126335. }, scene?: Nullable<Scene>): GroundMesh;
  126336. }
  126337. }
  126338. declare module BABYLON {
  126339. /**
  126340. * Class containing static functions to help procedurally build meshes
  126341. */
  126342. export class TorusBuilder {
  126343. /**
  126344. * Creates a torus mesh
  126345. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  126346. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  126347. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  126348. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126349. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126350. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126351. * @param name defines the name of the mesh
  126352. * @param options defines the options used to create the mesh
  126353. * @param scene defines the hosting scene
  126354. * @returns the torus mesh
  126355. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  126356. */
  126357. static CreateTorus(name: string, options: {
  126358. diameter?: number;
  126359. thickness?: number;
  126360. tessellation?: number;
  126361. updatable?: boolean;
  126362. sideOrientation?: number;
  126363. frontUVs?: Vector4;
  126364. backUVs?: Vector4;
  126365. }, scene: any): Mesh;
  126366. }
  126367. }
  126368. declare module BABYLON {
  126369. /**
  126370. * Class containing static functions to help procedurally build meshes
  126371. */
  126372. export class CylinderBuilder {
  126373. /**
  126374. * Creates a cylinder or a cone mesh
  126375. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  126376. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  126377. * * 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.
  126378. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  126379. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  126380. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  126381. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  126382. * * 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).
  126383. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  126384. * * 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).
  126385. * * 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
  126386. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  126387. * * 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
  126388. * * 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.
  126389. * * If `enclose` is false, a ring surface is one element.
  126390. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  126391. * * 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
  126392. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126393. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126394. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126395. * @param name defines the name of the mesh
  126396. * @param options defines the options used to create the mesh
  126397. * @param scene defines the hosting scene
  126398. * @returns the cylinder mesh
  126399. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  126400. */
  126401. static CreateCylinder(name: string, options: {
  126402. height?: number;
  126403. diameterTop?: number;
  126404. diameterBottom?: number;
  126405. diameter?: number;
  126406. tessellation?: number;
  126407. subdivisions?: number;
  126408. arc?: number;
  126409. faceColors?: Color4[];
  126410. faceUV?: Vector4[];
  126411. updatable?: boolean;
  126412. hasRings?: boolean;
  126413. enclose?: boolean;
  126414. cap?: number;
  126415. sideOrientation?: number;
  126416. frontUVs?: Vector4;
  126417. backUVs?: Vector4;
  126418. }, scene: any): Mesh;
  126419. }
  126420. }
  126421. declare module BABYLON {
  126422. /**
  126423. * States of the webXR experience
  126424. */
  126425. export enum WebXRState {
  126426. /**
  126427. * Transitioning to being in XR mode
  126428. */
  126429. ENTERING_XR = 0,
  126430. /**
  126431. * Transitioning to non XR mode
  126432. */
  126433. EXITING_XR = 1,
  126434. /**
  126435. * In XR mode and presenting
  126436. */
  126437. IN_XR = 2,
  126438. /**
  126439. * Not entered XR mode
  126440. */
  126441. NOT_IN_XR = 3
  126442. }
  126443. /**
  126444. * Abstraction of the XR render target
  126445. */
  126446. export interface WebXRRenderTarget extends IDisposable {
  126447. /**
  126448. * xrpresent context of the canvas which can be used to display/mirror xr content
  126449. */
  126450. canvasContext: WebGLRenderingContext;
  126451. /**
  126452. * xr layer for the canvas
  126453. */
  126454. xrLayer: Nullable<XRWebGLLayer>;
  126455. /**
  126456. * Initializes the xr layer for the session
  126457. * @param xrSession xr session
  126458. * @returns a promise that will resolve once the XR Layer has been created
  126459. */
  126460. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126461. }
  126462. }
  126463. declare module BABYLON {
  126464. /**
  126465. * COnfiguration object for WebXR output canvas
  126466. */
  126467. export class WebXRManagedOutputCanvasOptions {
  126468. /**
  126469. * An optional canvas in case you wish to create it yourself and provide it here.
  126470. * If not provided, a new canvas will be created
  126471. */
  126472. canvasElement?: HTMLCanvasElement;
  126473. /**
  126474. * Options for this XR Layer output
  126475. */
  126476. canvasOptions?: XRWebGLLayerOptions;
  126477. /**
  126478. * CSS styling for a newly created canvas (if not provided)
  126479. */
  126480. newCanvasCssStyle?: string;
  126481. /**
  126482. * Get the default values of the configuration object
  126483. * @param engine defines the engine to use (can be null)
  126484. * @returns default values of this configuration object
  126485. */
  126486. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  126487. }
  126488. /**
  126489. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  126490. */
  126491. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  126492. private _options;
  126493. private _canvas;
  126494. private _engine;
  126495. private _originalCanvasSize;
  126496. /**
  126497. * Rendering context of the canvas which can be used to display/mirror xr content
  126498. */
  126499. canvasContext: WebGLRenderingContext;
  126500. /**
  126501. * xr layer for the canvas
  126502. */
  126503. xrLayer: Nullable<XRWebGLLayer>;
  126504. /**
  126505. * Obseervers registered here will be triggered when the xr layer was initialized
  126506. */
  126507. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  126508. /**
  126509. * Initializes the canvas to be added/removed upon entering/exiting xr
  126510. * @param _xrSessionManager The XR Session manager
  126511. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  126512. */
  126513. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  126514. /**
  126515. * Disposes of the object
  126516. */
  126517. dispose(): void;
  126518. /**
  126519. * Initializes the xr layer for the session
  126520. * @param xrSession xr session
  126521. * @returns a promise that will resolve once the XR Layer has been created
  126522. */
  126523. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126524. private _addCanvas;
  126525. private _removeCanvas;
  126526. private _setCanvasSize;
  126527. private _setManagedOutputCanvas;
  126528. }
  126529. }
  126530. declare module BABYLON {
  126531. /**
  126532. * Manages an XRSession to work with Babylon's engine
  126533. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  126534. */
  126535. export class WebXRSessionManager implements IDisposable {
  126536. /** The scene which the session should be created for */
  126537. scene: Scene;
  126538. private _referenceSpace;
  126539. private _rttProvider;
  126540. private _sessionEnded;
  126541. private _xrNavigator;
  126542. private baseLayer;
  126543. /**
  126544. * The base reference space from which the session started. good if you want to reset your
  126545. * reference space
  126546. */
  126547. baseReferenceSpace: XRReferenceSpace;
  126548. /**
  126549. * Current XR frame
  126550. */
  126551. currentFrame: Nullable<XRFrame>;
  126552. /** WebXR timestamp updated every frame */
  126553. currentTimestamp: number;
  126554. /**
  126555. * Used just in case of a failure to initialize an immersive session.
  126556. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  126557. */
  126558. defaultHeightCompensation: number;
  126559. /**
  126560. * Fires every time a new xrFrame arrives which can be used to update the camera
  126561. */
  126562. onXRFrameObservable: Observable<XRFrame>;
  126563. /**
  126564. * Fires when the reference space changed
  126565. */
  126566. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  126567. /**
  126568. * Fires when the xr session is ended either by the device or manually done
  126569. */
  126570. onXRSessionEnded: Observable<any>;
  126571. /**
  126572. * Fires when the xr session is ended either by the device or manually done
  126573. */
  126574. onXRSessionInit: Observable<XRSession>;
  126575. /**
  126576. * Underlying xr session
  126577. */
  126578. session: XRSession;
  126579. /**
  126580. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  126581. * or get the offset the player is currently at.
  126582. */
  126583. viewerReferenceSpace: XRReferenceSpace;
  126584. /**
  126585. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  126586. * @param scene The scene which the session should be created for
  126587. */
  126588. constructor(
  126589. /** The scene which the session should be created for */
  126590. scene: Scene);
  126591. /**
  126592. * The current reference space used in this session. This reference space can constantly change!
  126593. * It is mainly used to offset the camera's position.
  126594. */
  126595. get referenceSpace(): XRReferenceSpace;
  126596. /**
  126597. * Set a new reference space and triggers the observable
  126598. */
  126599. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  126600. /**
  126601. * Disposes of the session manager
  126602. */
  126603. dispose(): void;
  126604. /**
  126605. * Stops the xrSession and restores the render loop
  126606. * @returns Promise which resolves after it exits XR
  126607. */
  126608. exitXRAsync(): Promise<void>;
  126609. /**
  126610. * Gets the correct render target texture to be rendered this frame for this eye
  126611. * @param eye the eye for which to get the render target
  126612. * @returns the render target for the specified eye
  126613. */
  126614. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  126615. /**
  126616. * Creates a WebXRRenderTarget object for the XR session
  126617. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  126618. * @param options optional options to provide when creating a new render target
  126619. * @returns a WebXR render target to which the session can render
  126620. */
  126621. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  126622. /**
  126623. * Initializes the manager
  126624. * After initialization enterXR can be called to start an XR session
  126625. * @returns Promise which resolves after it is initialized
  126626. */
  126627. initializeAsync(): Promise<void>;
  126628. /**
  126629. * Initializes an xr session
  126630. * @param xrSessionMode mode to initialize
  126631. * @param xrSessionInit defines optional and required values to pass to the session builder
  126632. * @returns a promise which will resolve once the session has been initialized
  126633. */
  126634. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  126635. /**
  126636. * Checks if a session would be supported for the creation options specified
  126637. * @param sessionMode session mode to check if supported eg. immersive-vr
  126638. * @returns A Promise that resolves to true if supported and false if not
  126639. */
  126640. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126641. /**
  126642. * Resets the reference space to the one started the session
  126643. */
  126644. resetReferenceSpace(): void;
  126645. /**
  126646. * Starts rendering to the xr layer
  126647. */
  126648. runXRRenderLoop(): void;
  126649. /**
  126650. * Sets the reference space on the xr session
  126651. * @param referenceSpaceType space to set
  126652. * @returns a promise that will resolve once the reference space has been set
  126653. */
  126654. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  126655. /**
  126656. * Updates the render state of the session
  126657. * @param state state to set
  126658. * @returns a promise that resolves once the render state has been updated
  126659. */
  126660. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  126661. /**
  126662. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  126663. * @param sessionMode defines the session to test
  126664. * @returns a promise with boolean as final value
  126665. */
  126666. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126667. private _createRenderTargetTexture;
  126668. }
  126669. }
  126670. declare module BABYLON {
  126671. /**
  126672. * WebXR Camera which holds the views for the xrSession
  126673. * @see https://doc.babylonjs.com/how_to/webxr_camera
  126674. */
  126675. export class WebXRCamera extends FreeCamera {
  126676. private _xrSessionManager;
  126677. private _firstFrame;
  126678. private _referenceQuaternion;
  126679. private _referencedPosition;
  126680. private _xrInvPositionCache;
  126681. private _xrInvQuaternionCache;
  126682. /**
  126683. * Observable raised before camera teleportation
  126684. */
  126685. onBeforeCameraTeleport: Observable<Vector3>;
  126686. /**
  126687. * Observable raised after camera teleportation
  126688. */
  126689. onAfterCameraTeleport: Observable<Vector3>;
  126690. /**
  126691. * Should position compensation execute on first frame.
  126692. * This is used when copying the position from a native (non XR) camera
  126693. */
  126694. compensateOnFirstFrame: boolean;
  126695. /**
  126696. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  126697. * @param name the name of the camera
  126698. * @param scene the scene to add the camera to
  126699. * @param _xrSessionManager a constructed xr session manager
  126700. */
  126701. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  126702. /**
  126703. * Return the user's height, unrelated to the current ground.
  126704. * This will be the y position of this camera, when ground level is 0.
  126705. */
  126706. get realWorldHeight(): number;
  126707. /** @hidden */
  126708. _updateForDualEyeDebugging(): void;
  126709. /**
  126710. * Sets this camera's transformation based on a non-vr camera
  126711. * @param otherCamera the non-vr camera to copy the transformation from
  126712. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  126713. */
  126714. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  126715. /**
  126716. * Gets the current instance class name ("WebXRCamera").
  126717. * @returns the class name
  126718. */
  126719. getClassName(): string;
  126720. private _rotate180;
  126721. private _updateFromXRSession;
  126722. private _updateNumberOfRigCameras;
  126723. private _updateReferenceSpace;
  126724. private _updateReferenceSpaceOffset;
  126725. }
  126726. }
  126727. declare module BABYLON {
  126728. /**
  126729. * Defining the interface required for a (webxr) feature
  126730. */
  126731. export interface IWebXRFeature extends IDisposable {
  126732. /**
  126733. * Is this feature attached
  126734. */
  126735. attached: boolean;
  126736. /**
  126737. * Should auto-attach be disabled?
  126738. */
  126739. disableAutoAttach: boolean;
  126740. /**
  126741. * Attach the feature to the session
  126742. * Will usually be called by the features manager
  126743. *
  126744. * @param force should attachment be forced (even when already attached)
  126745. * @returns true if successful.
  126746. */
  126747. attach(force?: boolean): boolean;
  126748. /**
  126749. * Detach the feature from the session
  126750. * Will usually be called by the features manager
  126751. *
  126752. * @returns true if successful.
  126753. */
  126754. detach(): boolean;
  126755. /**
  126756. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  126757. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  126758. *
  126759. * @returns whether or not the feature is compatible in this environment
  126760. */
  126761. isCompatible(): boolean;
  126762. /**
  126763. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  126764. */
  126765. xrNativeFeatureName?: string;
  126766. /**
  126767. * A list of (Babylon WebXR) features this feature depends on
  126768. */
  126769. dependsOn?: string[];
  126770. }
  126771. /**
  126772. * A list of the currently available features without referencing them
  126773. */
  126774. export class WebXRFeatureName {
  126775. /**
  126776. * The name of the anchor system feature
  126777. */
  126778. static readonly ANCHOR_SYSTEM: string;
  126779. /**
  126780. * The name of the background remover feature
  126781. */
  126782. static readonly BACKGROUND_REMOVER: string;
  126783. /**
  126784. * The name of the hit test feature
  126785. */
  126786. static readonly HIT_TEST: string;
  126787. /**
  126788. * physics impostors for xr controllers feature
  126789. */
  126790. static readonly PHYSICS_CONTROLLERS: string;
  126791. /**
  126792. * The name of the plane detection feature
  126793. */
  126794. static readonly PLANE_DETECTION: string;
  126795. /**
  126796. * The name of the pointer selection feature
  126797. */
  126798. static readonly POINTER_SELECTION: string;
  126799. /**
  126800. * The name of the teleportation feature
  126801. */
  126802. static readonly TELEPORTATION: string;
  126803. /**
  126804. * The name of the feature points feature.
  126805. */
  126806. static readonly FEATURE_POINTS: string;
  126807. /**
  126808. * The name of the hand tracking feature.
  126809. */
  126810. static readonly HAND_TRACKING: string;
  126811. }
  126812. /**
  126813. * Defining the constructor of a feature. Used to register the modules.
  126814. */
  126815. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  126816. /**
  126817. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  126818. * It is mainly used in AR sessions.
  126819. *
  126820. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  126821. */
  126822. export class WebXRFeaturesManager implements IDisposable {
  126823. private _xrSessionManager;
  126824. private static readonly _AvailableFeatures;
  126825. private _features;
  126826. /**
  126827. * constructs a new features manages.
  126828. *
  126829. * @param _xrSessionManager an instance of WebXRSessionManager
  126830. */
  126831. constructor(_xrSessionManager: WebXRSessionManager);
  126832. /**
  126833. * Used to register a module. After calling this function a developer can use this feature in the scene.
  126834. * Mainly used internally.
  126835. *
  126836. * @param featureName the name of the feature to register
  126837. * @param constructorFunction the function used to construct the module
  126838. * @param version the (babylon) version of the module
  126839. * @param stable is that a stable version of this module
  126840. */
  126841. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  126842. /**
  126843. * Returns a constructor of a specific feature.
  126844. *
  126845. * @param featureName the name of the feature to construct
  126846. * @param version the version of the feature to load
  126847. * @param xrSessionManager the xrSessionManager. Used to construct the module
  126848. * @param options optional options provided to the module.
  126849. * @returns a function that, when called, will return a new instance of this feature
  126850. */
  126851. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  126852. /**
  126853. * Can be used to return the list of features currently registered
  126854. *
  126855. * @returns an Array of available features
  126856. */
  126857. static GetAvailableFeatures(): string[];
  126858. /**
  126859. * Gets the versions available for a specific feature
  126860. * @param featureName the name of the feature
  126861. * @returns an array with the available versions
  126862. */
  126863. static GetAvailableVersions(featureName: string): string[];
  126864. /**
  126865. * Return the latest unstable version of this feature
  126866. * @param featureName the name of the feature to search
  126867. * @returns the version number. if not found will return -1
  126868. */
  126869. static GetLatestVersionOfFeature(featureName: string): number;
  126870. /**
  126871. * Return the latest stable version of this feature
  126872. * @param featureName the name of the feature to search
  126873. * @returns the version number. if not found will return -1
  126874. */
  126875. static GetStableVersionOfFeature(featureName: string): number;
  126876. /**
  126877. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  126878. * Can be used during a session to start a feature
  126879. * @param featureName the name of feature to attach
  126880. */
  126881. attachFeature(featureName: string): void;
  126882. /**
  126883. * Can be used inside a session or when the session ends to detach a specific feature
  126884. * @param featureName the name of the feature to detach
  126885. */
  126886. detachFeature(featureName: string): void;
  126887. /**
  126888. * Used to disable an already-enabled feature
  126889. * The feature will be disposed and will be recreated once enabled.
  126890. * @param featureName the feature to disable
  126891. * @returns true if disable was successful
  126892. */
  126893. disableFeature(featureName: string | {
  126894. Name: string;
  126895. }): boolean;
  126896. /**
  126897. * dispose this features manager
  126898. */
  126899. dispose(): void;
  126900. /**
  126901. * 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.
  126902. * 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.
  126903. *
  126904. * @param featureName the name of the feature to load or the class of the feature
  126905. * @param version optional version to load. if not provided the latest version will be enabled
  126906. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  126907. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  126908. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  126909. * @returns a new constructed feature or throws an error if feature not found.
  126910. */
  126911. enableFeature(featureName: string | {
  126912. Name: string;
  126913. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  126914. /**
  126915. * get the implementation of an enabled feature.
  126916. * @param featureName the name of the feature to load
  126917. * @returns the feature class, if found
  126918. */
  126919. getEnabledFeature(featureName: string): IWebXRFeature;
  126920. /**
  126921. * Get the list of enabled features
  126922. * @returns an array of enabled features
  126923. */
  126924. getEnabledFeatures(): string[];
  126925. /**
  126926. * This function will exten the session creation configuration object with enabled features.
  126927. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  126928. * according to the defined "required" variable, provided during enableFeature call
  126929. * @param xrSessionInit the xr Session init object to extend
  126930. *
  126931. * @returns an extended XRSessionInit object
  126932. */
  126933. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  126934. }
  126935. }
  126936. declare module BABYLON {
  126937. /**
  126938. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  126939. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  126940. */
  126941. export class WebXRExperienceHelper implements IDisposable {
  126942. private scene;
  126943. private _nonVRCamera;
  126944. private _originalSceneAutoClear;
  126945. private _supported;
  126946. /**
  126947. * Camera used to render xr content
  126948. */
  126949. camera: WebXRCamera;
  126950. /** A features manager for this xr session */
  126951. featuresManager: WebXRFeaturesManager;
  126952. /**
  126953. * Observers registered here will be triggered after the camera's initial transformation is set
  126954. * This can be used to set a different ground level or an extra rotation.
  126955. *
  126956. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  126957. * to the position set after this observable is done executing.
  126958. */
  126959. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  126960. /**
  126961. * Fires when the state of the experience helper has changed
  126962. */
  126963. onStateChangedObservable: Observable<WebXRState>;
  126964. /** Session manager used to keep track of xr session */
  126965. sessionManager: WebXRSessionManager;
  126966. /**
  126967. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  126968. */
  126969. state: WebXRState;
  126970. /**
  126971. * Creates a WebXRExperienceHelper
  126972. * @param scene The scene the helper should be created in
  126973. */
  126974. private constructor();
  126975. /**
  126976. * Creates the experience helper
  126977. * @param scene the scene to attach the experience helper to
  126978. * @returns a promise for the experience helper
  126979. */
  126980. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  126981. /**
  126982. * Disposes of the experience helper
  126983. */
  126984. dispose(): void;
  126985. /**
  126986. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  126987. * @param sessionMode options for the XR session
  126988. * @param referenceSpaceType frame of reference of the XR session
  126989. * @param renderTarget the output canvas that will be used to enter XR mode
  126990. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  126991. * @returns promise that resolves after xr mode has entered
  126992. */
  126993. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  126994. /**
  126995. * Exits XR mode and returns the scene to its original state
  126996. * @returns promise that resolves after xr mode has exited
  126997. */
  126998. exitXRAsync(): Promise<void>;
  126999. private _nonXRToXRCamera;
  127000. private _setState;
  127001. }
  127002. }
  127003. declare module BABYLON {
  127004. /**
  127005. * X-Y values for axes in WebXR
  127006. */
  127007. export interface IWebXRMotionControllerAxesValue {
  127008. /**
  127009. * The value of the x axis
  127010. */
  127011. x: number;
  127012. /**
  127013. * The value of the y-axis
  127014. */
  127015. y: number;
  127016. }
  127017. /**
  127018. * changed / previous values for the values of this component
  127019. */
  127020. export interface IWebXRMotionControllerComponentChangesValues<T> {
  127021. /**
  127022. * current (this frame) value
  127023. */
  127024. current: T;
  127025. /**
  127026. * previous (last change) value
  127027. */
  127028. previous: T;
  127029. }
  127030. /**
  127031. * Represents changes in the component between current frame and last values recorded
  127032. */
  127033. export interface IWebXRMotionControllerComponentChanges {
  127034. /**
  127035. * will be populated with previous and current values if axes changed
  127036. */
  127037. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  127038. /**
  127039. * will be populated with previous and current values if pressed changed
  127040. */
  127041. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127042. /**
  127043. * will be populated with previous and current values if touched changed
  127044. */
  127045. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127046. /**
  127047. * will be populated with previous and current values if value changed
  127048. */
  127049. value?: IWebXRMotionControllerComponentChangesValues<number>;
  127050. }
  127051. /**
  127052. * This class represents a single component (for example button or thumbstick) of a motion controller
  127053. */
  127054. export class WebXRControllerComponent implements IDisposable {
  127055. /**
  127056. * the id of this component
  127057. */
  127058. id: string;
  127059. /**
  127060. * the type of the component
  127061. */
  127062. type: MotionControllerComponentType;
  127063. private _buttonIndex;
  127064. private _axesIndices;
  127065. private _axes;
  127066. private _changes;
  127067. private _currentValue;
  127068. private _hasChanges;
  127069. private _pressed;
  127070. private _touched;
  127071. /**
  127072. * button component type
  127073. */
  127074. static BUTTON_TYPE: MotionControllerComponentType;
  127075. /**
  127076. * squeeze component type
  127077. */
  127078. static SQUEEZE_TYPE: MotionControllerComponentType;
  127079. /**
  127080. * Thumbstick component type
  127081. */
  127082. static THUMBSTICK_TYPE: MotionControllerComponentType;
  127083. /**
  127084. * Touchpad component type
  127085. */
  127086. static TOUCHPAD_TYPE: MotionControllerComponentType;
  127087. /**
  127088. * trigger component type
  127089. */
  127090. static TRIGGER_TYPE: MotionControllerComponentType;
  127091. /**
  127092. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  127093. * the axes data changes
  127094. */
  127095. onAxisValueChangedObservable: Observable<{
  127096. x: number;
  127097. y: number;
  127098. }>;
  127099. /**
  127100. * Observers registered here will be triggered when the state of a button changes
  127101. * State change is either pressed / touched / value
  127102. */
  127103. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  127104. /**
  127105. * Creates a new component for a motion controller.
  127106. * It is created by the motion controller itself
  127107. *
  127108. * @param id the id of this component
  127109. * @param type the type of the component
  127110. * @param _buttonIndex index in the buttons array of the gamepad
  127111. * @param _axesIndices indices of the values in the axes array of the gamepad
  127112. */
  127113. constructor(
  127114. /**
  127115. * the id of this component
  127116. */
  127117. id: string,
  127118. /**
  127119. * the type of the component
  127120. */
  127121. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  127122. /**
  127123. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  127124. */
  127125. get axes(): IWebXRMotionControllerAxesValue;
  127126. /**
  127127. * Get the changes. Elements will be populated only if they changed with their previous and current value
  127128. */
  127129. get changes(): IWebXRMotionControllerComponentChanges;
  127130. /**
  127131. * Return whether or not the component changed the last frame
  127132. */
  127133. get hasChanges(): boolean;
  127134. /**
  127135. * is the button currently pressed
  127136. */
  127137. get pressed(): boolean;
  127138. /**
  127139. * is the button currently touched
  127140. */
  127141. get touched(): boolean;
  127142. /**
  127143. * Get the current value of this component
  127144. */
  127145. get value(): number;
  127146. /**
  127147. * Dispose this component
  127148. */
  127149. dispose(): void;
  127150. /**
  127151. * Are there axes correlating to this component
  127152. * @return true is axes data is available
  127153. */
  127154. isAxes(): boolean;
  127155. /**
  127156. * Is this component a button (hence - pressable)
  127157. * @returns true if can be pressed
  127158. */
  127159. isButton(): boolean;
  127160. /**
  127161. * update this component using the gamepad object it is in. Called on every frame
  127162. * @param nativeController the native gamepad controller object
  127163. */
  127164. update(nativeController: IMinimalMotionControllerObject): void;
  127165. }
  127166. }
  127167. declare module BABYLON {
  127168. /**
  127169. * Interface used to represent data loading progression
  127170. */
  127171. export interface ISceneLoaderProgressEvent {
  127172. /**
  127173. * Defines if data length to load can be evaluated
  127174. */
  127175. readonly lengthComputable: boolean;
  127176. /**
  127177. * Defines the loaded data length
  127178. */
  127179. readonly loaded: number;
  127180. /**
  127181. * Defines the data length to load
  127182. */
  127183. readonly total: number;
  127184. }
  127185. /**
  127186. * Interface used by SceneLoader plugins to define supported file extensions
  127187. */
  127188. export interface ISceneLoaderPluginExtensions {
  127189. /**
  127190. * Defines the list of supported extensions
  127191. */
  127192. [extension: string]: {
  127193. isBinary: boolean;
  127194. };
  127195. }
  127196. /**
  127197. * Interface used by SceneLoader plugin factory
  127198. */
  127199. export interface ISceneLoaderPluginFactory {
  127200. /**
  127201. * Defines the name of the factory
  127202. */
  127203. name: string;
  127204. /**
  127205. * Function called to create a new plugin
  127206. * @return the new plugin
  127207. */
  127208. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  127209. /**
  127210. * The callback that returns true if the data can be directly loaded.
  127211. * @param data string containing the file data
  127212. * @returns if the data can be loaded directly
  127213. */
  127214. canDirectLoad?(data: string): boolean;
  127215. }
  127216. /**
  127217. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  127218. */
  127219. export interface ISceneLoaderPluginBase {
  127220. /**
  127221. * The friendly name of this plugin.
  127222. */
  127223. name: string;
  127224. /**
  127225. * The file extensions supported by this plugin.
  127226. */
  127227. extensions: string | ISceneLoaderPluginExtensions;
  127228. /**
  127229. * The callback called when loading from a url.
  127230. * @param scene scene loading this url
  127231. * @param url url to load
  127232. * @param onSuccess callback called when the file successfully loads
  127233. * @param onProgress callback called while file is loading (if the server supports this mode)
  127234. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  127235. * @param onError callback called when the file fails to load
  127236. * @returns a file request object
  127237. */
  127238. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127239. /**
  127240. * The callback called when loading from a file object.
  127241. * @param scene scene loading this file
  127242. * @param file defines the file to load
  127243. * @param onSuccess defines the callback to call when data is loaded
  127244. * @param onProgress defines the callback to call during loading process
  127245. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  127246. * @param onError defines the callback to call when an error occurs
  127247. * @returns a file request object
  127248. */
  127249. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127250. /**
  127251. * The callback that returns true if the data can be directly loaded.
  127252. * @param data string containing the file data
  127253. * @returns if the data can be loaded directly
  127254. */
  127255. canDirectLoad?(data: string): boolean;
  127256. /**
  127257. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  127258. * @param scene scene loading this data
  127259. * @param data string containing the data
  127260. * @returns data to pass to the plugin
  127261. */
  127262. directLoad?(scene: Scene, data: string): any;
  127263. /**
  127264. * The callback that allows custom handling of the root url based on the response url.
  127265. * @param rootUrl the original root url
  127266. * @param responseURL the response url if available
  127267. * @returns the new root url
  127268. */
  127269. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  127270. }
  127271. /**
  127272. * Interface used to define a SceneLoader plugin
  127273. */
  127274. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  127275. /**
  127276. * Import meshes into a scene.
  127277. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127278. * @param scene The scene to import into
  127279. * @param data The data to import
  127280. * @param rootUrl The root url for scene and resources
  127281. * @param meshes The meshes array to import into
  127282. * @param particleSystems The particle systems array to import into
  127283. * @param skeletons The skeletons array to import into
  127284. * @param onError The callback when import fails
  127285. * @returns True if successful or false otherwise
  127286. */
  127287. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  127288. /**
  127289. * Load into a scene.
  127290. * @param scene The scene to load into
  127291. * @param data The data to import
  127292. * @param rootUrl The root url for scene and resources
  127293. * @param onError The callback when import fails
  127294. * @returns True if successful or false otherwise
  127295. */
  127296. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  127297. /**
  127298. * Load into an asset container.
  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 The loaded asset container
  127304. */
  127305. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  127306. }
  127307. /**
  127308. * Interface used to define an async SceneLoader plugin
  127309. */
  127310. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  127311. /**
  127312. * Import meshes into a scene.
  127313. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127314. * @param scene The scene to import into
  127315. * @param data The data to import
  127316. * @param rootUrl The root url for scene and resources
  127317. * @param onProgress The callback when the load progresses
  127318. * @param fileName Defines the name of the file to load
  127319. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  127320. */
  127321. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  127322. meshes: AbstractMesh[];
  127323. particleSystems: IParticleSystem[];
  127324. skeletons: Skeleton[];
  127325. animationGroups: AnimationGroup[];
  127326. }>;
  127327. /**
  127328. * Load into a scene.
  127329. * @param scene The scene to load into
  127330. * @param data The data to import
  127331. * @param rootUrl The root url for scene and resources
  127332. * @param onProgress The callback when the load progresses
  127333. * @param fileName Defines the name of the file to load
  127334. * @returns Nothing
  127335. */
  127336. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  127337. /**
  127338. * Load into an asset container.
  127339. * @param scene The scene to load into
  127340. * @param data The data to import
  127341. * @param rootUrl The root url for scene and resources
  127342. * @param onProgress The callback when the load progresses
  127343. * @param fileName Defines the name of the file to load
  127344. * @returns The loaded asset container
  127345. */
  127346. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  127347. }
  127348. /**
  127349. * Mode that determines how to handle old animation groups before loading new ones.
  127350. */
  127351. export enum SceneLoaderAnimationGroupLoadingMode {
  127352. /**
  127353. * Reset all old animations to initial state then dispose them.
  127354. */
  127355. Clean = 0,
  127356. /**
  127357. * Stop all old animations.
  127358. */
  127359. Stop = 1,
  127360. /**
  127361. * Restart old animations from first frame.
  127362. */
  127363. Sync = 2,
  127364. /**
  127365. * Old animations remains untouched.
  127366. */
  127367. NoSync = 3
  127368. }
  127369. /**
  127370. * Defines a plugin registered by the SceneLoader
  127371. */
  127372. interface IRegisteredPlugin {
  127373. /**
  127374. * Defines the plugin to use
  127375. */
  127376. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127377. /**
  127378. * Defines if the plugin supports binary data
  127379. */
  127380. isBinary: boolean;
  127381. }
  127382. /**
  127383. * Class used to load scene from various file formats using registered plugins
  127384. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  127385. */
  127386. export class SceneLoader {
  127387. /**
  127388. * No logging while loading
  127389. */
  127390. static readonly NO_LOGGING: number;
  127391. /**
  127392. * Minimal logging while loading
  127393. */
  127394. static readonly MINIMAL_LOGGING: number;
  127395. /**
  127396. * Summary logging while loading
  127397. */
  127398. static readonly SUMMARY_LOGGING: number;
  127399. /**
  127400. * Detailled logging while loading
  127401. */
  127402. static readonly DETAILED_LOGGING: number;
  127403. /**
  127404. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  127405. */
  127406. static get ForceFullSceneLoadingForIncremental(): boolean;
  127407. static set ForceFullSceneLoadingForIncremental(value: boolean);
  127408. /**
  127409. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  127410. */
  127411. static get ShowLoadingScreen(): boolean;
  127412. static set ShowLoadingScreen(value: boolean);
  127413. /**
  127414. * Defines the current logging level (while loading the scene)
  127415. * @ignorenaming
  127416. */
  127417. static get loggingLevel(): number;
  127418. static set loggingLevel(value: number);
  127419. /**
  127420. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  127421. */
  127422. static get CleanBoneMatrixWeights(): boolean;
  127423. static set CleanBoneMatrixWeights(value: boolean);
  127424. /**
  127425. * Event raised when a plugin is used to load a scene
  127426. */
  127427. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  127428. private static _registeredPlugins;
  127429. private static _showingLoadingScreen;
  127430. /**
  127431. * Gets the default plugin (used to load Babylon files)
  127432. * @returns the .babylon plugin
  127433. */
  127434. static GetDefaultPlugin(): IRegisteredPlugin;
  127435. private static _GetPluginForExtension;
  127436. private static _GetPluginForDirectLoad;
  127437. private static _GetPluginForFilename;
  127438. private static _GetDirectLoad;
  127439. private static _LoadData;
  127440. private static _GetFileInfo;
  127441. /**
  127442. * Gets a plugin that can load the given extension
  127443. * @param extension defines the extension to load
  127444. * @returns a plugin or null if none works
  127445. */
  127446. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127447. /**
  127448. * Gets a boolean indicating that the given extension can be loaded
  127449. * @param extension defines the extension to load
  127450. * @returns true if the extension is supported
  127451. */
  127452. static IsPluginForExtensionAvailable(extension: string): boolean;
  127453. /**
  127454. * Adds a new plugin to the list of registered plugins
  127455. * @param plugin defines the plugin to add
  127456. */
  127457. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  127458. /**
  127459. * Import meshes into a scene
  127460. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127461. * @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)
  127462. * @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)
  127463. * @param scene the instance of BABYLON.Scene to append to
  127464. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  127465. * @param onProgress a callback with a progress event for each file being loaded
  127466. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127467. * @param pluginExtension the extension used to determine the plugin
  127468. * @returns The loaded plugin
  127469. */
  127470. 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>;
  127471. /**
  127472. * Import meshes into a scene
  127473. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127474. * @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)
  127475. * @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)
  127476. * @param scene the instance of BABYLON.Scene to append to
  127477. * @param onProgress a callback with a progress event for each file being loaded
  127478. * @param pluginExtension the extension used to determine the plugin
  127479. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  127480. */
  127481. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  127482. meshes: AbstractMesh[];
  127483. particleSystems: IParticleSystem[];
  127484. skeletons: Skeleton[];
  127485. animationGroups: AnimationGroup[];
  127486. }>;
  127487. /**
  127488. * Load a scene
  127489. * @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)
  127490. * @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)
  127491. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127492. * @param onSuccess a callback with the scene when import succeeds
  127493. * @param onProgress a callback with a progress event for each file being loaded
  127494. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127495. * @param pluginExtension the extension used to determine the plugin
  127496. * @returns The loaded plugin
  127497. */
  127498. 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>;
  127499. /**
  127500. * Load a scene
  127501. * @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)
  127502. * @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)
  127503. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127504. * @param onProgress a callback with a progress event for each file being loaded
  127505. * @param pluginExtension the extension used to determine the plugin
  127506. * @returns The loaded scene
  127507. */
  127508. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127509. /**
  127510. * Append a scene
  127511. * @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)
  127512. * @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)
  127513. * @param scene is the instance of BABYLON.Scene to append to
  127514. * @param onSuccess a callback with the scene when import succeeds
  127515. * @param onProgress a callback with a progress event for each file being loaded
  127516. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127517. * @param pluginExtension the extension used to determine the plugin
  127518. * @returns The loaded plugin
  127519. */
  127520. 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>;
  127521. /**
  127522. * Append a scene
  127523. * @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)
  127524. * @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)
  127525. * @param scene is the instance of BABYLON.Scene to append to
  127526. * @param onProgress a callback with a progress event for each file being loaded
  127527. * @param pluginExtension the extension used to determine the plugin
  127528. * @returns The given scene
  127529. */
  127530. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127531. /**
  127532. * Load a scene into an asset container
  127533. * @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)
  127534. * @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)
  127535. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127536. * @param onSuccess a callback with the scene when import succeeds
  127537. * @param onProgress a callback with a progress event for each file being loaded
  127538. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127539. * @param pluginExtension the extension used to determine the plugin
  127540. * @returns The loaded plugin
  127541. */
  127542. 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>;
  127543. /**
  127544. * Load a scene into an asset container
  127545. * @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)
  127546. * @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)
  127547. * @param scene is the instance of Scene to append to
  127548. * @param onProgress a callback with a progress event for each file being loaded
  127549. * @param pluginExtension the extension used to determine the plugin
  127550. * @returns The loaded asset container
  127551. */
  127552. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  127553. /**
  127554. * Import animations from a file into a scene
  127555. * @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)
  127556. * @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)
  127557. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127558. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127559. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127560. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127561. * @param onSuccess a callback with the scene when import succeeds
  127562. * @param onProgress a callback with a progress event for each file being loaded
  127563. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127564. * @param pluginExtension the extension used to determine the plugin
  127565. */
  127566. 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;
  127567. /**
  127568. * Import animations from a file into a scene
  127569. * @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)
  127570. * @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)
  127571. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127572. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127573. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127574. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127575. * @param onSuccess a callback with the scene when import succeeds
  127576. * @param onProgress a callback with a progress event for each file being loaded
  127577. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127578. * @param pluginExtension the extension used to determine the plugin
  127579. * @returns the updated scene with imported animations
  127580. */
  127581. 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>;
  127582. }
  127583. }
  127584. declare module BABYLON {
  127585. /**
  127586. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  127587. */
  127588. export type MotionControllerHandedness = "none" | "left" | "right";
  127589. /**
  127590. * The type of components available in motion controllers.
  127591. * This is not the name of the component.
  127592. */
  127593. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  127594. /**
  127595. * The state of a controller component
  127596. */
  127597. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  127598. /**
  127599. * The schema of motion controller layout.
  127600. * No object will be initialized using this interface
  127601. * This is used just to define the profile.
  127602. */
  127603. export interface IMotionControllerLayout {
  127604. /**
  127605. * Path to load the assets. Usually relative to the base path
  127606. */
  127607. assetPath: string;
  127608. /**
  127609. * Available components (unsorted)
  127610. */
  127611. components: {
  127612. /**
  127613. * A map of component Ids
  127614. */
  127615. [componentId: string]: {
  127616. /**
  127617. * The type of input the component outputs
  127618. */
  127619. type: MotionControllerComponentType;
  127620. /**
  127621. * The indices of this component in the gamepad object
  127622. */
  127623. gamepadIndices: {
  127624. /**
  127625. * Index of button
  127626. */
  127627. button?: number;
  127628. /**
  127629. * If available, index of x-axis
  127630. */
  127631. xAxis?: number;
  127632. /**
  127633. * If available, index of y-axis
  127634. */
  127635. yAxis?: number;
  127636. };
  127637. /**
  127638. * The mesh's root node name
  127639. */
  127640. rootNodeName: string;
  127641. /**
  127642. * Animation definitions for this model
  127643. */
  127644. visualResponses: {
  127645. [stateKey: string]: {
  127646. /**
  127647. * What property will be animated
  127648. */
  127649. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  127650. /**
  127651. * What states influence this visual response
  127652. */
  127653. states: MotionControllerComponentStateType[];
  127654. /**
  127655. * Type of animation - movement or visibility
  127656. */
  127657. valueNodeProperty: "transform" | "visibility";
  127658. /**
  127659. * Base node name to move. Its position will be calculated according to the min and max nodes
  127660. */
  127661. valueNodeName?: string;
  127662. /**
  127663. * Minimum movement node
  127664. */
  127665. minNodeName?: string;
  127666. /**
  127667. * Max movement node
  127668. */
  127669. maxNodeName?: string;
  127670. };
  127671. };
  127672. /**
  127673. * If touch enabled, what is the name of node to display user feedback
  127674. */
  127675. touchPointNodeName?: string;
  127676. };
  127677. };
  127678. /**
  127679. * Is it xr standard mapping or not
  127680. */
  127681. gamepadMapping: "" | "xr-standard";
  127682. /**
  127683. * Base root node of this entire model
  127684. */
  127685. rootNodeName: string;
  127686. /**
  127687. * Defines the main button component id
  127688. */
  127689. selectComponentId: string;
  127690. }
  127691. /**
  127692. * A definition for the layout map in the input profile
  127693. */
  127694. export interface IMotionControllerLayoutMap {
  127695. /**
  127696. * Layouts with handedness type as a key
  127697. */
  127698. [handedness: string]: IMotionControllerLayout;
  127699. }
  127700. /**
  127701. * The XR Input profile schema
  127702. * Profiles can be found here:
  127703. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  127704. */
  127705. export interface IMotionControllerProfile {
  127706. /**
  127707. * fallback profiles for this profileId
  127708. */
  127709. fallbackProfileIds: string[];
  127710. /**
  127711. * The layout map, with handedness as key
  127712. */
  127713. layouts: IMotionControllerLayoutMap;
  127714. /**
  127715. * The id of this profile
  127716. * correlates to the profile(s) in the xrInput.profiles array
  127717. */
  127718. profileId: string;
  127719. }
  127720. /**
  127721. * A helper-interface for the 3 meshes needed for controller button animation
  127722. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  127723. */
  127724. export interface IMotionControllerButtonMeshMap {
  127725. /**
  127726. * the mesh that defines the pressed value mesh position.
  127727. * This is used to find the max-position of this button
  127728. */
  127729. pressedMesh: AbstractMesh;
  127730. /**
  127731. * the mesh that defines the unpressed value mesh position.
  127732. * This is used to find the min (or initial) position of this button
  127733. */
  127734. unpressedMesh: AbstractMesh;
  127735. /**
  127736. * The mesh that will be changed when value changes
  127737. */
  127738. valueMesh: AbstractMesh;
  127739. }
  127740. /**
  127741. * A helper-interface for the 3 meshes needed for controller axis animation.
  127742. * This will be expanded when touchpad animations are fully supported
  127743. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  127744. */
  127745. export interface IMotionControllerMeshMap {
  127746. /**
  127747. * the mesh that defines the maximum value mesh position.
  127748. */
  127749. maxMesh?: AbstractMesh;
  127750. /**
  127751. * the mesh that defines the minimum value mesh position.
  127752. */
  127753. minMesh?: AbstractMesh;
  127754. /**
  127755. * The mesh that will be changed when axis value changes
  127756. */
  127757. valueMesh?: AbstractMesh;
  127758. }
  127759. /**
  127760. * The elements needed for change-detection of the gamepad objects in motion controllers
  127761. */
  127762. export interface IMinimalMotionControllerObject {
  127763. /**
  127764. * Available axes of this controller
  127765. */
  127766. axes: number[];
  127767. /**
  127768. * An array of available buttons
  127769. */
  127770. buttons: Array<{
  127771. /**
  127772. * Value of the button/trigger
  127773. */
  127774. value: number;
  127775. /**
  127776. * If the button/trigger is currently touched
  127777. */
  127778. touched: boolean;
  127779. /**
  127780. * If the button/trigger is currently pressed
  127781. */
  127782. pressed: boolean;
  127783. }>;
  127784. /**
  127785. * EXPERIMENTAL haptic support.
  127786. */
  127787. hapticActuators?: Array<{
  127788. pulse: (value: number, duration: number) => Promise<boolean>;
  127789. }>;
  127790. }
  127791. /**
  127792. * An Abstract Motion controller
  127793. * This class receives an xrInput and a profile layout and uses those to initialize the components
  127794. * Each component has an observable to check for changes in value and state
  127795. */
  127796. export abstract class WebXRAbstractMotionController implements IDisposable {
  127797. protected scene: Scene;
  127798. protected layout: IMotionControllerLayout;
  127799. /**
  127800. * The gamepad object correlating to this controller
  127801. */
  127802. gamepadObject: IMinimalMotionControllerObject;
  127803. /**
  127804. * handedness (left/right/none) of this controller
  127805. */
  127806. handedness: MotionControllerHandedness;
  127807. private _initComponent;
  127808. private _modelReady;
  127809. /**
  127810. * A map of components (WebXRControllerComponent) in this motion controller
  127811. * Components have a ComponentType and can also have both button and axis definitions
  127812. */
  127813. readonly components: {
  127814. [id: string]: WebXRControllerComponent;
  127815. };
  127816. /**
  127817. * Disable the model's animation. Can be set at any time.
  127818. */
  127819. disableAnimation: boolean;
  127820. /**
  127821. * Observers registered here will be triggered when the model of this controller is done loading
  127822. */
  127823. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  127824. /**
  127825. * The profile id of this motion controller
  127826. */
  127827. abstract profileId: string;
  127828. /**
  127829. * The root mesh of the model. It is null if the model was not yet initialized
  127830. */
  127831. rootMesh: Nullable<AbstractMesh>;
  127832. /**
  127833. * constructs a new abstract motion controller
  127834. * @param scene the scene to which the model of the controller will be added
  127835. * @param layout The profile layout to load
  127836. * @param gamepadObject The gamepad object correlating to this controller
  127837. * @param handedness handedness (left/right/none) of this controller
  127838. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  127839. */
  127840. constructor(scene: Scene, layout: IMotionControllerLayout,
  127841. /**
  127842. * The gamepad object correlating to this controller
  127843. */
  127844. gamepadObject: IMinimalMotionControllerObject,
  127845. /**
  127846. * handedness (left/right/none) of this controller
  127847. */
  127848. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  127849. /**
  127850. * Dispose this controller, the model mesh and all its components
  127851. */
  127852. dispose(): void;
  127853. /**
  127854. * Returns all components of specific type
  127855. * @param type the type to search for
  127856. * @return an array of components with this type
  127857. */
  127858. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  127859. /**
  127860. * get a component based an its component id as defined in layout.components
  127861. * @param id the id of the component
  127862. * @returns the component correlates to the id or undefined if not found
  127863. */
  127864. getComponent(id: string): WebXRControllerComponent;
  127865. /**
  127866. * Get the list of components available in this motion controller
  127867. * @returns an array of strings correlating to available components
  127868. */
  127869. getComponentIds(): string[];
  127870. /**
  127871. * Get the first component of specific type
  127872. * @param type type of component to find
  127873. * @return a controller component or null if not found
  127874. */
  127875. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  127876. /**
  127877. * Get the main (Select) component of this controller as defined in the layout
  127878. * @returns the main component of this controller
  127879. */
  127880. getMainComponent(): WebXRControllerComponent;
  127881. /**
  127882. * Loads the model correlating to this controller
  127883. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  127884. * @returns A promise fulfilled with the result of the model loading
  127885. */
  127886. loadModel(): Promise<boolean>;
  127887. /**
  127888. * Update this model using the current XRFrame
  127889. * @param xrFrame the current xr frame to use and update the model
  127890. */
  127891. updateFromXRFrame(xrFrame: XRFrame): void;
  127892. /**
  127893. * Backwards compatibility due to a deeply-integrated typo
  127894. */
  127895. get handness(): XREye;
  127896. /**
  127897. * Pulse (vibrate) this controller
  127898. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  127899. * Consecutive calls to this function will cancel the last pulse call
  127900. *
  127901. * @param value the strength of the pulse in 0.0...1.0 range
  127902. * @param duration Duration of the pulse in milliseconds
  127903. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  127904. * @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
  127905. */
  127906. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  127907. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  127908. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  127909. /**
  127910. * Moves the axis on the controller mesh based on its current state
  127911. * @param axis the index of the axis
  127912. * @param axisValue the value of the axis which determines the meshes new position
  127913. * @hidden
  127914. */
  127915. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  127916. /**
  127917. * Update the model itself with the current frame data
  127918. * @param xrFrame the frame to use for updating the model mesh
  127919. */
  127920. protected updateModel(xrFrame: XRFrame): void;
  127921. /**
  127922. * Get the filename and path for this controller's model
  127923. * @returns a map of filename and path
  127924. */
  127925. protected abstract _getFilenameAndPath(): {
  127926. filename: string;
  127927. path: string;
  127928. };
  127929. /**
  127930. * This function is called before the mesh is loaded. It checks for loading constraints.
  127931. * For example, this function can check if the GLB loader is available
  127932. * If this function returns false, the generic controller will be loaded instead
  127933. * @returns Is the client ready to load the mesh
  127934. */
  127935. protected abstract _getModelLoadingConstraints(): boolean;
  127936. /**
  127937. * This function will be called after the model was successfully loaded and can be used
  127938. * for mesh transformations before it is available for the user
  127939. * @param meshes the loaded meshes
  127940. */
  127941. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  127942. /**
  127943. * Set the root mesh for this controller. Important for the WebXR controller class
  127944. * @param meshes the loaded meshes
  127945. */
  127946. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  127947. /**
  127948. * A function executed each frame that updates the mesh (if needed)
  127949. * @param xrFrame the current xrFrame
  127950. */
  127951. protected abstract _updateModel(xrFrame: XRFrame): void;
  127952. private _getGenericFilenameAndPath;
  127953. private _getGenericParentMesh;
  127954. }
  127955. }
  127956. declare module BABYLON {
  127957. /**
  127958. * A generic trigger-only motion controller for WebXR
  127959. */
  127960. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  127961. /**
  127962. * Static version of the profile id of this controller
  127963. */
  127964. static ProfileId: string;
  127965. profileId: string;
  127966. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  127967. protected _getFilenameAndPath(): {
  127968. filename: string;
  127969. path: string;
  127970. };
  127971. protected _getModelLoadingConstraints(): boolean;
  127972. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  127973. protected _setRootMesh(meshes: AbstractMesh[]): void;
  127974. protected _updateModel(): void;
  127975. }
  127976. }
  127977. declare module BABYLON {
  127978. /**
  127979. * Class containing static functions to help procedurally build meshes
  127980. */
  127981. export class SphereBuilder {
  127982. /**
  127983. * Creates a sphere mesh
  127984. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  127985. * * 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`)
  127986. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  127987. * * 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
  127988. * * 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)
  127989. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  127990. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  127991. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127992. * @param name defines the name of the mesh
  127993. * @param options defines the options used to create the mesh
  127994. * @param scene defines the hosting scene
  127995. * @returns the sphere mesh
  127996. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  127997. */
  127998. static CreateSphere(name: string, options: {
  127999. segments?: number;
  128000. diameter?: number;
  128001. diameterX?: number;
  128002. diameterY?: number;
  128003. diameterZ?: number;
  128004. arc?: number;
  128005. slice?: number;
  128006. sideOrientation?: number;
  128007. frontUVs?: Vector4;
  128008. backUVs?: Vector4;
  128009. updatable?: boolean;
  128010. }, scene?: Nullable<Scene>): Mesh;
  128011. }
  128012. }
  128013. declare module BABYLON {
  128014. /**
  128015. * A profiled motion controller has its profile loaded from an online repository.
  128016. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  128017. */
  128018. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  128019. private _repositoryUrl;
  128020. private _buttonMeshMapping;
  128021. private _touchDots;
  128022. /**
  128023. * The profile ID of this controller. Will be populated when the controller initializes.
  128024. */
  128025. profileId: string;
  128026. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  128027. dispose(): void;
  128028. protected _getFilenameAndPath(): {
  128029. filename: string;
  128030. path: string;
  128031. };
  128032. protected _getModelLoadingConstraints(): boolean;
  128033. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  128034. protected _setRootMesh(meshes: AbstractMesh[]): void;
  128035. protected _updateModel(_xrFrame: XRFrame): void;
  128036. }
  128037. }
  128038. declare module BABYLON {
  128039. /**
  128040. * A construction function type to create a new controller based on an xrInput object
  128041. */
  128042. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  128043. /**
  128044. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  128045. *
  128046. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  128047. * it should be replaced with auto-loaded controllers.
  128048. *
  128049. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  128050. */
  128051. export class WebXRMotionControllerManager {
  128052. private static _AvailableControllers;
  128053. private static _Fallbacks;
  128054. private static _ProfileLoadingPromises;
  128055. private static _ProfilesList;
  128056. /**
  128057. * The base URL of the online controller repository. Can be changed at any time.
  128058. */
  128059. static BaseRepositoryUrl: string;
  128060. /**
  128061. * Which repository gets priority - local or online
  128062. */
  128063. static PrioritizeOnlineRepository: boolean;
  128064. /**
  128065. * Use the online repository, or use only locally-defined controllers
  128066. */
  128067. static UseOnlineRepository: boolean;
  128068. /**
  128069. * Clear the cache used for profile loading and reload when requested again
  128070. */
  128071. static ClearProfilesCache(): void;
  128072. /**
  128073. * Register the default fallbacks.
  128074. * This function is called automatically when this file is imported.
  128075. */
  128076. static DefaultFallbacks(): void;
  128077. /**
  128078. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  128079. * @param profileId the profile to which a fallback needs to be found
  128080. * @return an array with corresponding fallback profiles
  128081. */
  128082. static FindFallbackWithProfileId(profileId: string): string[];
  128083. /**
  128084. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  128085. * The order of search:
  128086. *
  128087. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  128088. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  128089. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  128090. * 4) return the generic trigger controller if none were found
  128091. *
  128092. * @param xrInput the xrInput to which a new controller is initialized
  128093. * @param scene the scene to which the model will be added
  128094. * @param forceProfile force a certain profile for this controller
  128095. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  128096. */
  128097. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  128098. /**
  128099. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  128100. *
  128101. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  128102. *
  128103. * @param type the profile type to register
  128104. * @param constructFunction the function to be called when loading this profile
  128105. */
  128106. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  128107. /**
  128108. * Register a fallback to a specific profile.
  128109. * @param profileId the profileId that will receive the fallbacks
  128110. * @param fallbacks A list of fallback profiles
  128111. */
  128112. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  128113. /**
  128114. * Will update the list of profiles available in the repository
  128115. * @return a promise that resolves to a map of profiles available online
  128116. */
  128117. static UpdateProfilesList(): Promise<{
  128118. [profile: string]: string;
  128119. }>;
  128120. private static _LoadProfileFromRepository;
  128121. private static _LoadProfilesFromAvailableControllers;
  128122. }
  128123. }
  128124. declare module BABYLON {
  128125. /**
  128126. * Configuration options for the WebXR controller creation
  128127. */
  128128. export interface IWebXRControllerOptions {
  128129. /**
  128130. * Should the controller mesh be animated when a user interacts with it
  128131. * The pressed buttons / thumbstick and touchpad animations will be disabled
  128132. */
  128133. disableMotionControllerAnimation?: boolean;
  128134. /**
  128135. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  128136. */
  128137. doNotLoadControllerMesh?: boolean;
  128138. /**
  128139. * Force a specific controller type for this controller.
  128140. * This can be used when creating your own profile or when testing different controllers
  128141. */
  128142. forceControllerProfile?: string;
  128143. /**
  128144. * Defines a rendering group ID for meshes that will be loaded.
  128145. * This is for the default controllers only.
  128146. */
  128147. renderingGroupId?: number;
  128148. }
  128149. /**
  128150. * Represents an XR controller
  128151. */
  128152. export class WebXRInputSource {
  128153. private _scene;
  128154. /** The underlying input source for the controller */
  128155. inputSource: XRInputSource;
  128156. private _options;
  128157. private _tmpVector;
  128158. private _uniqueId;
  128159. private _disposed;
  128160. /**
  128161. * 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
  128162. */
  128163. grip?: AbstractMesh;
  128164. /**
  128165. * If available, this is the gamepad object related to this controller.
  128166. * Using this object it is possible to get click events and trackpad changes of the
  128167. * webxr controller that is currently being used.
  128168. */
  128169. motionController?: WebXRAbstractMotionController;
  128170. /**
  128171. * Event that fires when the controller is removed/disposed.
  128172. * The object provided as event data is this controller, after associated assets were disposed.
  128173. * uniqueId is still available.
  128174. */
  128175. onDisposeObservable: Observable<WebXRInputSource>;
  128176. /**
  128177. * Will be triggered when the mesh associated with the motion controller is done loading.
  128178. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  128179. * A shortened version of controller -> motion controller -> on mesh loaded.
  128180. */
  128181. onMeshLoadedObservable: Observable<AbstractMesh>;
  128182. /**
  128183. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  128184. */
  128185. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  128186. /**
  128187. * Pointer which can be used to select objects or attach a visible laser to
  128188. */
  128189. pointer: AbstractMesh;
  128190. /**
  128191. * Creates the input source object
  128192. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  128193. * @param _scene the scene which the controller should be associated to
  128194. * @param inputSource the underlying input source for the controller
  128195. * @param _options options for this controller creation
  128196. */
  128197. constructor(_scene: Scene,
  128198. /** The underlying input source for the controller */
  128199. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  128200. /**
  128201. * Get this controllers unique id
  128202. */
  128203. get uniqueId(): string;
  128204. /**
  128205. * Disposes of the object
  128206. */
  128207. dispose(): void;
  128208. /**
  128209. * Gets a world space ray coming from the pointer or grip
  128210. * @param result the resulting ray
  128211. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  128212. */
  128213. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  128214. /**
  128215. * Updates the controller pose based on the given XRFrame
  128216. * @param xrFrame xr frame to update the pose with
  128217. * @param referenceSpace reference space to use
  128218. */
  128219. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  128220. }
  128221. }
  128222. declare module BABYLON {
  128223. /**
  128224. * The schema for initialization options of the XR Input class
  128225. */
  128226. export interface IWebXRInputOptions {
  128227. /**
  128228. * If set to true no model will be automatically loaded
  128229. */
  128230. doNotLoadControllerMeshes?: boolean;
  128231. /**
  128232. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  128233. * If not found, the xr input profile data will be used.
  128234. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  128235. */
  128236. forceInputProfile?: string;
  128237. /**
  128238. * Do not send a request to the controller repository to load the profile.
  128239. *
  128240. * Instead, use the controllers available in babylon itself.
  128241. */
  128242. disableOnlineControllerRepository?: boolean;
  128243. /**
  128244. * A custom URL for the controllers repository
  128245. */
  128246. customControllersRepositoryURL?: string;
  128247. /**
  128248. * Should the controller model's components not move according to the user input
  128249. */
  128250. disableControllerAnimation?: boolean;
  128251. /**
  128252. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  128253. */
  128254. controllerOptions?: IWebXRControllerOptions;
  128255. }
  128256. /**
  128257. * XR input used to track XR inputs such as controllers/rays
  128258. */
  128259. export class WebXRInput implements IDisposable {
  128260. /**
  128261. * the xr session manager for this session
  128262. */
  128263. xrSessionManager: WebXRSessionManager;
  128264. /**
  128265. * the WebXR camera for this session. Mainly used for teleportation
  128266. */
  128267. xrCamera: WebXRCamera;
  128268. private readonly options;
  128269. /**
  128270. * XR controllers being tracked
  128271. */
  128272. controllers: Array<WebXRInputSource>;
  128273. private _frameObserver;
  128274. private _sessionEndedObserver;
  128275. private _sessionInitObserver;
  128276. /**
  128277. * Event when a controller has been connected/added
  128278. */
  128279. onControllerAddedObservable: Observable<WebXRInputSource>;
  128280. /**
  128281. * Event when a controller has been removed/disconnected
  128282. */
  128283. onControllerRemovedObservable: Observable<WebXRInputSource>;
  128284. /**
  128285. * Initializes the WebXRInput
  128286. * @param xrSessionManager the xr session manager for this session
  128287. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  128288. * @param options = initialization options for this xr input
  128289. */
  128290. constructor(
  128291. /**
  128292. * the xr session manager for this session
  128293. */
  128294. xrSessionManager: WebXRSessionManager,
  128295. /**
  128296. * the WebXR camera for this session. Mainly used for teleportation
  128297. */
  128298. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  128299. private _onInputSourcesChange;
  128300. private _addAndRemoveControllers;
  128301. /**
  128302. * Disposes of the object
  128303. */
  128304. dispose(): void;
  128305. }
  128306. }
  128307. declare module BABYLON {
  128308. /**
  128309. * This is the base class for all WebXR features.
  128310. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  128311. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  128312. */
  128313. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  128314. protected _xrSessionManager: WebXRSessionManager;
  128315. private _attached;
  128316. private _removeOnDetach;
  128317. /**
  128318. * Should auto-attach be disabled?
  128319. */
  128320. disableAutoAttach: boolean;
  128321. /**
  128322. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  128323. */
  128324. xrNativeFeatureName: string;
  128325. /**
  128326. * Construct a new (abstract) WebXR feature
  128327. * @param _xrSessionManager the xr session manager for this feature
  128328. */
  128329. constructor(_xrSessionManager: WebXRSessionManager);
  128330. /**
  128331. * Is this feature attached
  128332. */
  128333. get attached(): boolean;
  128334. /**
  128335. * attach this feature
  128336. *
  128337. * @param force should attachment be forced (even when already attached)
  128338. * @returns true if successful, false is failed or already attached
  128339. */
  128340. attach(force?: boolean): boolean;
  128341. /**
  128342. * detach this feature.
  128343. *
  128344. * @returns true if successful, false if failed or already detached
  128345. */
  128346. detach(): boolean;
  128347. /**
  128348. * Dispose this feature and all of the resources attached
  128349. */
  128350. dispose(): void;
  128351. /**
  128352. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  128353. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  128354. *
  128355. * @returns whether or not the feature is compatible in this environment
  128356. */
  128357. isCompatible(): boolean;
  128358. /**
  128359. * This is used to register callbacks that will automatically be removed when detach is called.
  128360. * @param observable the observable to which the observer will be attached
  128361. * @param callback the callback to register
  128362. */
  128363. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  128364. /**
  128365. * Code in this function will be executed on each xrFrame received from the browser.
  128366. * This function will not execute after the feature is detached.
  128367. * @param _xrFrame the current frame
  128368. */
  128369. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  128370. }
  128371. }
  128372. declare module BABYLON {
  128373. /**
  128374. * Renders a layer on top of an existing scene
  128375. */
  128376. export class UtilityLayerRenderer implements IDisposable {
  128377. /** the original scene that will be rendered on top of */
  128378. originalScene: Scene;
  128379. private _pointerCaptures;
  128380. private _lastPointerEvents;
  128381. private static _DefaultUtilityLayer;
  128382. private static _DefaultKeepDepthUtilityLayer;
  128383. private _sharedGizmoLight;
  128384. private _renderCamera;
  128385. /**
  128386. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  128387. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  128388. * @returns the camera that is used when rendering the utility layer
  128389. */
  128390. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  128391. /**
  128392. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  128393. * @param cam the camera that should be used when rendering the utility layer
  128394. */
  128395. setRenderCamera(cam: Nullable<Camera>): void;
  128396. /**
  128397. * @hidden
  128398. * Light which used by gizmos to get light shading
  128399. */
  128400. _getSharedGizmoLight(): HemisphericLight;
  128401. /**
  128402. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  128403. */
  128404. pickUtilitySceneFirst: boolean;
  128405. /**
  128406. * 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)
  128407. */
  128408. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  128409. /**
  128410. * 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)
  128411. */
  128412. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  128413. /**
  128414. * The scene that is rendered on top of the original scene
  128415. */
  128416. utilityLayerScene: Scene;
  128417. /**
  128418. * If the utility layer should automatically be rendered on top of existing scene
  128419. */
  128420. shouldRender: boolean;
  128421. /**
  128422. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  128423. */
  128424. onlyCheckPointerDownEvents: boolean;
  128425. /**
  128426. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  128427. */
  128428. processAllEvents: boolean;
  128429. /**
  128430. * Observable raised when the pointer move from the utility layer scene to the main scene
  128431. */
  128432. onPointerOutObservable: Observable<number>;
  128433. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  128434. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  128435. private _afterRenderObserver;
  128436. private _sceneDisposeObserver;
  128437. private _originalPointerObserver;
  128438. /**
  128439. * Instantiates a UtilityLayerRenderer
  128440. * @param originalScene the original scene that will be rendered on top of
  128441. * @param handleEvents boolean indicating if the utility layer should handle events
  128442. */
  128443. constructor(
  128444. /** the original scene that will be rendered on top of */
  128445. originalScene: Scene, handleEvents?: boolean);
  128446. private _notifyObservers;
  128447. /**
  128448. * Renders the utility layers scene on top of the original scene
  128449. */
  128450. render(): void;
  128451. /**
  128452. * Disposes of the renderer
  128453. */
  128454. dispose(): void;
  128455. private _updateCamera;
  128456. }
  128457. }
  128458. declare module BABYLON {
  128459. /**
  128460. * Options interface for the pointer selection module
  128461. */
  128462. export interface IWebXRControllerPointerSelectionOptions {
  128463. /**
  128464. * if provided, this scene will be used to render meshes.
  128465. */
  128466. customUtilityLayerScene?: Scene;
  128467. /**
  128468. * 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)
  128469. * If not disabled, the last picked point will be used to execute a pointer up event
  128470. * If disabled, pointer up event will be triggered right after the pointer down event.
  128471. * Used in screen and gaze target ray mode only
  128472. */
  128473. disablePointerUpOnTouchOut: boolean;
  128474. /**
  128475. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  128476. */
  128477. forceGazeMode: boolean;
  128478. /**
  128479. * 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
  128480. * to start a new countdown to the pointer down event.
  128481. * Defaults to 1.
  128482. */
  128483. gazeModePointerMovedFactor?: number;
  128484. /**
  128485. * Different button type to use instead of the main component
  128486. */
  128487. overrideButtonId?: string;
  128488. /**
  128489. * use this rendering group id for the meshes (optional)
  128490. */
  128491. renderingGroupId?: number;
  128492. /**
  128493. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  128494. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  128495. * 3000 means 3 seconds between pointing at something and selecting it
  128496. */
  128497. timeToSelect?: number;
  128498. /**
  128499. * Should meshes created here be added to a utility layer or the main scene
  128500. */
  128501. useUtilityLayer?: boolean;
  128502. /**
  128503. * Optional WebXR camera to be used for gaze selection
  128504. */
  128505. gazeCamera?: WebXRCamera;
  128506. /**
  128507. * the xr input to use with this pointer selection
  128508. */
  128509. xrInput: WebXRInput;
  128510. }
  128511. /**
  128512. * A module that will enable pointer selection for motion controllers of XR Input Sources
  128513. */
  128514. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  128515. private readonly _options;
  128516. private static _idCounter;
  128517. private _attachController;
  128518. private _controllers;
  128519. private _scene;
  128520. private _tmpVectorForPickCompare;
  128521. /**
  128522. * The module's name
  128523. */
  128524. static readonly Name: string;
  128525. /**
  128526. * The (Babylon) version of this module.
  128527. * This is an integer representing the implementation version.
  128528. * This number does not correspond to the WebXR specs version
  128529. */
  128530. static readonly Version: number;
  128531. /**
  128532. * Disable lighting on the laser pointer (so it will always be visible)
  128533. */
  128534. disablePointerLighting: boolean;
  128535. /**
  128536. * Disable lighting on the selection mesh (so it will always be visible)
  128537. */
  128538. disableSelectionMeshLighting: boolean;
  128539. /**
  128540. * Should the laser pointer be displayed
  128541. */
  128542. displayLaserPointer: boolean;
  128543. /**
  128544. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  128545. */
  128546. displaySelectionMesh: boolean;
  128547. /**
  128548. * This color will be set to the laser pointer when selection is triggered
  128549. */
  128550. laserPointerPickedColor: Color3;
  128551. /**
  128552. * Default color of the laser pointer
  128553. */
  128554. laserPointerDefaultColor: Color3;
  128555. /**
  128556. * default color of the selection ring
  128557. */
  128558. selectionMeshDefaultColor: Color3;
  128559. /**
  128560. * This color will be applied to the selection ring when selection is triggered
  128561. */
  128562. selectionMeshPickedColor: Color3;
  128563. /**
  128564. * Optional filter to be used for ray selection. This predicate shares behavior with
  128565. * scene.pointerMovePredicate which takes priority if it is also assigned.
  128566. */
  128567. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  128568. /**
  128569. * constructs a new background remover module
  128570. * @param _xrSessionManager the session manager for this module
  128571. * @param _options read-only options to be used in this module
  128572. */
  128573. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  128574. /**
  128575. * attach this feature
  128576. * Will usually be called by the features manager
  128577. *
  128578. * @returns true if successful.
  128579. */
  128580. attach(): boolean;
  128581. /**
  128582. * detach this feature.
  128583. * Will usually be called by the features manager
  128584. *
  128585. * @returns true if successful.
  128586. */
  128587. detach(): boolean;
  128588. /**
  128589. * Will get the mesh under a specific pointer.
  128590. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  128591. * @param controllerId the controllerId to check
  128592. * @returns The mesh under pointer or null if no mesh is under the pointer
  128593. */
  128594. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  128595. /**
  128596. * Get the xr controller that correlates to the pointer id in the pointer event
  128597. *
  128598. * @param id the pointer id to search for
  128599. * @returns the controller that correlates to this id or null if not found
  128600. */
  128601. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  128602. protected _onXRFrame(_xrFrame: XRFrame): void;
  128603. private _attachGazeMode;
  128604. private _attachScreenRayMode;
  128605. private _attachTrackedPointerRayMode;
  128606. private _convertNormalToDirectionOfRay;
  128607. private _detachController;
  128608. private _generateNewMeshPair;
  128609. private _pickingMoved;
  128610. private _updatePointerDistance;
  128611. /** @hidden */
  128612. get lasterPointerDefaultColor(): Color3;
  128613. }
  128614. }
  128615. declare module BABYLON {
  128616. /**
  128617. * Button which can be used to enter a different mode of XR
  128618. */
  128619. export class WebXREnterExitUIButton {
  128620. /** button element */
  128621. element: HTMLElement;
  128622. /** XR initialization options for the button */
  128623. sessionMode: XRSessionMode;
  128624. /** Reference space type */
  128625. referenceSpaceType: XRReferenceSpaceType;
  128626. /**
  128627. * Creates a WebXREnterExitUIButton
  128628. * @param element button element
  128629. * @param sessionMode XR initialization session mode
  128630. * @param referenceSpaceType the type of reference space to be used
  128631. */
  128632. constructor(
  128633. /** button element */
  128634. element: HTMLElement,
  128635. /** XR initialization options for the button */
  128636. sessionMode: XRSessionMode,
  128637. /** Reference space type */
  128638. referenceSpaceType: XRReferenceSpaceType);
  128639. /**
  128640. * Extendable function which can be used to update the button's visuals when the state changes
  128641. * @param activeButton the current active button in the UI
  128642. */
  128643. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  128644. }
  128645. /**
  128646. * Options to create the webXR UI
  128647. */
  128648. export class WebXREnterExitUIOptions {
  128649. /**
  128650. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  128651. */
  128652. customButtons?: Array<WebXREnterExitUIButton>;
  128653. /**
  128654. * A reference space type to use when creating the default button.
  128655. * Default is local-floor
  128656. */
  128657. referenceSpaceType?: XRReferenceSpaceType;
  128658. /**
  128659. * Context to enter xr with
  128660. */
  128661. renderTarget?: Nullable<WebXRRenderTarget>;
  128662. /**
  128663. * A session mode to use when creating the default button.
  128664. * Default is immersive-vr
  128665. */
  128666. sessionMode?: XRSessionMode;
  128667. /**
  128668. * A list of optional features to init the session with
  128669. */
  128670. optionalFeatures?: string[];
  128671. /**
  128672. * A list of optional features to init the session with
  128673. */
  128674. requiredFeatures?: string[];
  128675. }
  128676. /**
  128677. * UI to allow the user to enter/exit XR mode
  128678. */
  128679. export class WebXREnterExitUI implements IDisposable {
  128680. private scene;
  128681. /** version of the options passed to this UI */
  128682. options: WebXREnterExitUIOptions;
  128683. private _activeButton;
  128684. private _buttons;
  128685. /**
  128686. * The HTML Div Element to which buttons are added.
  128687. */
  128688. readonly overlay: HTMLDivElement;
  128689. /**
  128690. * Fired every time the active button is changed.
  128691. *
  128692. * When xr is entered via a button that launches xr that button will be the callback parameter
  128693. *
  128694. * When exiting xr the callback parameter will be null)
  128695. */
  128696. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  128697. /**
  128698. *
  128699. * @param scene babylon scene object to use
  128700. * @param options (read-only) version of the options passed to this UI
  128701. */
  128702. private constructor();
  128703. /**
  128704. * Creates UI to allow the user to enter/exit XR mode
  128705. * @param scene the scene to add the ui to
  128706. * @param helper the xr experience helper to enter/exit xr with
  128707. * @param options options to configure the UI
  128708. * @returns the created ui
  128709. */
  128710. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  128711. /**
  128712. * Disposes of the XR UI component
  128713. */
  128714. dispose(): void;
  128715. private _updateButtons;
  128716. }
  128717. }
  128718. declare module BABYLON {
  128719. /**
  128720. * Class containing static functions to help procedurally build meshes
  128721. */
  128722. export class LinesBuilder {
  128723. /**
  128724. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  128725. * * 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
  128726. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  128727. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  128728. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  128729. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  128730. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128731. * * 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
  128732. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  128733. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128734. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  128735. * @param name defines the name of the new line system
  128736. * @param options defines the options used to create the line system
  128737. * @param scene defines the hosting scene
  128738. * @returns a new line system mesh
  128739. */
  128740. static CreateLineSystem(name: string, options: {
  128741. lines: Vector3[][];
  128742. updatable?: boolean;
  128743. instance?: Nullable<LinesMesh>;
  128744. colors?: Nullable<Color4[][]>;
  128745. useVertexAlpha?: boolean;
  128746. }, scene: Nullable<Scene>): LinesMesh;
  128747. /**
  128748. * Creates a line mesh
  128749. * 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
  128750. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128751. * * The parameter `points` is an array successive Vector3
  128752. * * 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
  128753. * * The optional parameter `colors` is an array of successive Color4, one per line point
  128754. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  128755. * * When updating an instance, remember that only point positions can change, not the number of points
  128756. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128757. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  128758. * @param name defines the name of the new line system
  128759. * @param options defines the options used to create the line system
  128760. * @param scene defines the hosting scene
  128761. * @returns a new line mesh
  128762. */
  128763. static CreateLines(name: string, options: {
  128764. points: Vector3[];
  128765. updatable?: boolean;
  128766. instance?: Nullable<LinesMesh>;
  128767. colors?: Color4[];
  128768. useVertexAlpha?: boolean;
  128769. }, scene?: Nullable<Scene>): LinesMesh;
  128770. /**
  128771. * Creates a dashed line mesh
  128772. * * 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
  128773. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128774. * * The parameter `points` is an array successive Vector3
  128775. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  128776. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  128777. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  128778. * * 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
  128779. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128780. * * When updating an instance, remember that only point positions can change, not the number of points
  128781. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128782. * @param name defines the name of the mesh
  128783. * @param options defines the options used to create the mesh
  128784. * @param scene defines the hosting scene
  128785. * @returns the dashed line mesh
  128786. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  128787. */
  128788. static CreateDashedLines(name: string, options: {
  128789. points: Vector3[];
  128790. dashSize?: number;
  128791. gapSize?: number;
  128792. dashNb?: number;
  128793. updatable?: boolean;
  128794. instance?: LinesMesh;
  128795. useVertexAlpha?: boolean;
  128796. }, scene?: Nullable<Scene>): LinesMesh;
  128797. }
  128798. }
  128799. declare module BABYLON {
  128800. /**
  128801. * Construction options for a timer
  128802. */
  128803. export interface ITimerOptions<T> {
  128804. /**
  128805. * Time-to-end
  128806. */
  128807. timeout: number;
  128808. /**
  128809. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  128810. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  128811. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  128812. */
  128813. contextObservable: Observable<T>;
  128814. /**
  128815. * Optional parameters when adding an observer to the observable
  128816. */
  128817. observableParameters?: {
  128818. mask?: number;
  128819. insertFirst?: boolean;
  128820. scope?: any;
  128821. };
  128822. /**
  128823. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  128824. */
  128825. breakCondition?: (data?: ITimerData<T>) => boolean;
  128826. /**
  128827. * Will be triggered when the time condition has met
  128828. */
  128829. onEnded?: (data: ITimerData<any>) => void;
  128830. /**
  128831. * Will be triggered when the break condition has met (prematurely ended)
  128832. */
  128833. onAborted?: (data: ITimerData<any>) => void;
  128834. /**
  128835. * Optional function to execute on each tick (or count)
  128836. */
  128837. onTick?: (data: ITimerData<any>) => void;
  128838. }
  128839. /**
  128840. * An interface defining the data sent by the timer
  128841. */
  128842. export interface ITimerData<T> {
  128843. /**
  128844. * When did it start
  128845. */
  128846. startTime: number;
  128847. /**
  128848. * Time now
  128849. */
  128850. currentTime: number;
  128851. /**
  128852. * Time passed since started
  128853. */
  128854. deltaTime: number;
  128855. /**
  128856. * How much is completed, in [0.0...1.0].
  128857. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  128858. */
  128859. completeRate: number;
  128860. /**
  128861. * What the registered observable sent in the last count
  128862. */
  128863. payload: T;
  128864. }
  128865. /**
  128866. * The current state of the timer
  128867. */
  128868. export enum TimerState {
  128869. /**
  128870. * Timer initialized, not yet started
  128871. */
  128872. INIT = 0,
  128873. /**
  128874. * Timer started and counting
  128875. */
  128876. STARTED = 1,
  128877. /**
  128878. * Timer ended (whether aborted or time reached)
  128879. */
  128880. ENDED = 2
  128881. }
  128882. /**
  128883. * A simple version of the timer. Will take options and start the timer immediately after calling it
  128884. *
  128885. * @param options options with which to initialize this timer
  128886. */
  128887. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  128888. /**
  128889. * An advanced implementation of a timer class
  128890. */
  128891. export class AdvancedTimer<T = any> implements IDisposable {
  128892. /**
  128893. * Will notify each time the timer calculates the remaining time
  128894. */
  128895. onEachCountObservable: Observable<ITimerData<T>>;
  128896. /**
  128897. * Will trigger when the timer was aborted due to the break condition
  128898. */
  128899. onTimerAbortedObservable: Observable<ITimerData<T>>;
  128900. /**
  128901. * Will trigger when the timer ended successfully
  128902. */
  128903. onTimerEndedObservable: Observable<ITimerData<T>>;
  128904. /**
  128905. * Will trigger when the timer state has changed
  128906. */
  128907. onStateChangedObservable: Observable<TimerState>;
  128908. private _observer;
  128909. private _contextObservable;
  128910. private _observableParameters;
  128911. private _startTime;
  128912. private _timer;
  128913. private _state;
  128914. private _breakCondition;
  128915. private _timeToEnd;
  128916. private _breakOnNextTick;
  128917. /**
  128918. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  128919. * @param options construction options for this advanced timer
  128920. */
  128921. constructor(options: ITimerOptions<T>);
  128922. /**
  128923. * set a breaking condition for this timer. Default is to never break during count
  128924. * @param predicate the new break condition. Returns true to break, false otherwise
  128925. */
  128926. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  128927. /**
  128928. * Reset ALL associated observables in this advanced timer
  128929. */
  128930. clearObservables(): void;
  128931. /**
  128932. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  128933. *
  128934. * @param timeToEnd how much time to measure until timer ended
  128935. */
  128936. start(timeToEnd?: number): void;
  128937. /**
  128938. * Will force a stop on the next tick.
  128939. */
  128940. stop(): void;
  128941. /**
  128942. * Dispose this timer, clearing all resources
  128943. */
  128944. dispose(): void;
  128945. private _setState;
  128946. private _tick;
  128947. private _stop;
  128948. }
  128949. }
  128950. declare module BABYLON {
  128951. /**
  128952. * The options container for the teleportation module
  128953. */
  128954. export interface IWebXRTeleportationOptions {
  128955. /**
  128956. * if provided, this scene will be used to render meshes.
  128957. */
  128958. customUtilityLayerScene?: Scene;
  128959. /**
  128960. * Values to configure the default target mesh
  128961. */
  128962. defaultTargetMeshOptions?: {
  128963. /**
  128964. * Fill color of the teleportation area
  128965. */
  128966. teleportationFillColor?: string;
  128967. /**
  128968. * Border color for the teleportation area
  128969. */
  128970. teleportationBorderColor?: string;
  128971. /**
  128972. * Disable the mesh's animation sequence
  128973. */
  128974. disableAnimation?: boolean;
  128975. /**
  128976. * Disable lighting on the material or the ring and arrow
  128977. */
  128978. disableLighting?: boolean;
  128979. /**
  128980. * Override the default material of the torus and arrow
  128981. */
  128982. torusArrowMaterial?: Material;
  128983. };
  128984. /**
  128985. * A list of meshes to use as floor meshes.
  128986. * Meshes can be added and removed after initializing the feature using the
  128987. * addFloorMesh and removeFloorMesh functions
  128988. * If empty, rotation will still work
  128989. */
  128990. floorMeshes?: AbstractMesh[];
  128991. /**
  128992. * use this rendering group id for the meshes (optional)
  128993. */
  128994. renderingGroupId?: number;
  128995. /**
  128996. * Should teleportation move only to snap points
  128997. */
  128998. snapPointsOnly?: boolean;
  128999. /**
  129000. * An array of points to which the teleportation will snap to.
  129001. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  129002. */
  129003. snapPositions?: Vector3[];
  129004. /**
  129005. * How close should the teleportation ray be in order to snap to position.
  129006. * Default to 0.8 units (meters)
  129007. */
  129008. snapToPositionRadius?: number;
  129009. /**
  129010. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  129011. * If you want to support rotation, make sure your mesh has a direction indicator.
  129012. *
  129013. * When left untouched, the default mesh will be initialized.
  129014. */
  129015. teleportationTargetMesh?: AbstractMesh;
  129016. /**
  129017. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  129018. */
  129019. timeToTeleport?: number;
  129020. /**
  129021. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  129022. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  129023. */
  129024. useMainComponentOnly?: boolean;
  129025. /**
  129026. * Should meshes created here be added to a utility layer or the main scene
  129027. */
  129028. useUtilityLayer?: boolean;
  129029. /**
  129030. * Babylon XR Input class for controller
  129031. */
  129032. xrInput: WebXRInput;
  129033. }
  129034. /**
  129035. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  129036. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  129037. * the input of the attached controllers.
  129038. */
  129039. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  129040. private _options;
  129041. private _controllers;
  129042. private _currentTeleportationControllerId;
  129043. private _floorMeshes;
  129044. private _quadraticBezierCurve;
  129045. private _selectionFeature;
  129046. private _snapToPositions;
  129047. private _snappedToPoint;
  129048. private _teleportationRingMaterial?;
  129049. private _tmpRay;
  129050. private _tmpVector;
  129051. /**
  129052. * The module's name
  129053. */
  129054. static readonly Name: string;
  129055. /**
  129056. * The (Babylon) version of this module.
  129057. * This is an integer representing the implementation version.
  129058. * This number does not correspond to the webxr specs version
  129059. */
  129060. static readonly Version: number;
  129061. /**
  129062. * Is movement backwards enabled
  129063. */
  129064. backwardsMovementEnabled: boolean;
  129065. /**
  129066. * Distance to travel when moving backwards
  129067. */
  129068. backwardsTeleportationDistance: number;
  129069. /**
  129070. * The distance from the user to the inspection point in the direction of the controller
  129071. * A higher number will allow the user to move further
  129072. * defaults to 5 (meters, in xr units)
  129073. */
  129074. parabolicCheckRadius: number;
  129075. /**
  129076. * Should the module support parabolic ray on top of direct ray
  129077. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  129078. * Very helpful when moving between floors / different heights
  129079. */
  129080. parabolicRayEnabled: boolean;
  129081. /**
  129082. * How much rotation should be applied when rotating right and left
  129083. */
  129084. rotationAngle: number;
  129085. /**
  129086. * Is rotation enabled when moving forward?
  129087. * Disabling this feature will prevent the user from deciding the direction when teleporting
  129088. */
  129089. rotationEnabled: boolean;
  129090. /**
  129091. * constructs a new anchor system
  129092. * @param _xrSessionManager an instance of WebXRSessionManager
  129093. * @param _options configuration object for this feature
  129094. */
  129095. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  129096. /**
  129097. * Get the snapPointsOnly flag
  129098. */
  129099. get snapPointsOnly(): boolean;
  129100. /**
  129101. * Sets the snapPointsOnly flag
  129102. * @param snapToPoints should teleportation be exclusively to snap points
  129103. */
  129104. set snapPointsOnly(snapToPoints: boolean);
  129105. /**
  129106. * Add a new mesh to the floor meshes array
  129107. * @param mesh the mesh to use as floor mesh
  129108. */
  129109. addFloorMesh(mesh: AbstractMesh): void;
  129110. /**
  129111. * Add a new snap-to point to fix teleportation to this position
  129112. * @param newSnapPoint The new Snap-To point
  129113. */
  129114. addSnapPoint(newSnapPoint: Vector3): void;
  129115. attach(): boolean;
  129116. detach(): boolean;
  129117. dispose(): void;
  129118. /**
  129119. * Remove a mesh from the floor meshes array
  129120. * @param mesh the mesh to remove
  129121. */
  129122. removeFloorMesh(mesh: AbstractMesh): void;
  129123. /**
  129124. * Remove a mesh from the floor meshes array using its name
  129125. * @param name the mesh name to remove
  129126. */
  129127. removeFloorMeshByName(name: string): void;
  129128. /**
  129129. * 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
  129130. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  129131. * @returns was the point found and removed or not
  129132. */
  129133. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  129134. /**
  129135. * This function sets a selection feature that will be disabled when
  129136. * the forward ray is shown and will be reattached when hidden.
  129137. * This is used to remove the selection rays when moving.
  129138. * @param selectionFeature the feature to disable when forward movement is enabled
  129139. */
  129140. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  129141. protected _onXRFrame(_xrFrame: XRFrame): void;
  129142. private _attachController;
  129143. private _createDefaultTargetMesh;
  129144. private _detachController;
  129145. private _findClosestSnapPointWithRadius;
  129146. private _setTargetMeshPosition;
  129147. private _setTargetMeshVisibility;
  129148. private _showParabolicPath;
  129149. private _teleportForward;
  129150. }
  129151. }
  129152. declare module BABYLON {
  129153. /**
  129154. * Options for the default xr helper
  129155. */
  129156. export class WebXRDefaultExperienceOptions {
  129157. /**
  129158. * Enable or disable default UI to enter XR
  129159. */
  129160. disableDefaultUI?: boolean;
  129161. /**
  129162. * Should teleportation not initialize. defaults to false.
  129163. */
  129164. disableTeleportation?: boolean;
  129165. /**
  129166. * Floor meshes that will be used for teleport
  129167. */
  129168. floorMeshes?: Array<AbstractMesh>;
  129169. /**
  129170. * If set to true, the first frame will not be used to reset position
  129171. * The first frame is mainly used when copying transformation from the old camera
  129172. * Mainly used in AR
  129173. */
  129174. ignoreNativeCameraTransformation?: boolean;
  129175. /**
  129176. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  129177. */
  129178. inputOptions?: IWebXRInputOptions;
  129179. /**
  129180. * optional configuration for the output canvas
  129181. */
  129182. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  129183. /**
  129184. * optional UI options. This can be used among other to change session mode and reference space type
  129185. */
  129186. uiOptions?: WebXREnterExitUIOptions;
  129187. /**
  129188. * When loading teleportation and pointer select, use stable versions instead of latest.
  129189. */
  129190. useStablePlugins?: boolean;
  129191. /**
  129192. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  129193. */
  129194. renderingGroupId?: number;
  129195. /**
  129196. * A list of optional features to init the session with
  129197. * If set to true, all features we support will be added
  129198. */
  129199. optionalFeatures?: boolean | string[];
  129200. }
  129201. /**
  129202. * Default experience which provides a similar setup to the previous webVRExperience
  129203. */
  129204. export class WebXRDefaultExperience {
  129205. /**
  129206. * Base experience
  129207. */
  129208. baseExperience: WebXRExperienceHelper;
  129209. /**
  129210. * Enables ui for entering/exiting xr
  129211. */
  129212. enterExitUI: WebXREnterExitUI;
  129213. /**
  129214. * Input experience extension
  129215. */
  129216. input: WebXRInput;
  129217. /**
  129218. * Enables laser pointer and selection
  129219. */
  129220. pointerSelection: WebXRControllerPointerSelection;
  129221. /**
  129222. * Default target xr should render to
  129223. */
  129224. renderTarget: WebXRRenderTarget;
  129225. /**
  129226. * Enables teleportation
  129227. */
  129228. teleportation: WebXRMotionControllerTeleportation;
  129229. private constructor();
  129230. /**
  129231. * Creates the default xr experience
  129232. * @param scene scene
  129233. * @param options options for basic configuration
  129234. * @returns resulting WebXRDefaultExperience
  129235. */
  129236. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  129237. /**
  129238. * DIsposes of the experience helper
  129239. */
  129240. dispose(): void;
  129241. }
  129242. }
  129243. declare module BABYLON {
  129244. /**
  129245. * Options to modify the vr teleportation behavior.
  129246. */
  129247. export interface VRTeleportationOptions {
  129248. /**
  129249. * The name of the mesh which should be used as the teleportation floor. (default: null)
  129250. */
  129251. floorMeshName?: string;
  129252. /**
  129253. * A list of meshes to be used as the teleportation floor. (default: empty)
  129254. */
  129255. floorMeshes?: Mesh[];
  129256. /**
  129257. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  129258. */
  129259. teleportationMode?: number;
  129260. /**
  129261. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  129262. */
  129263. teleportationTime?: number;
  129264. /**
  129265. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  129266. */
  129267. teleportationSpeed?: number;
  129268. /**
  129269. * The easing function used in the animation or null for Linear. (default CircleEase)
  129270. */
  129271. easingFunction?: EasingFunction;
  129272. }
  129273. /**
  129274. * Options to modify the vr experience helper's behavior.
  129275. */
  129276. export interface VRExperienceHelperOptions extends WebVROptions {
  129277. /**
  129278. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  129279. */
  129280. createDeviceOrientationCamera?: boolean;
  129281. /**
  129282. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  129283. */
  129284. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  129285. /**
  129286. * Uses the main button on the controller to toggle the laser casted. (default: true)
  129287. */
  129288. laserToggle?: boolean;
  129289. /**
  129290. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  129291. */
  129292. floorMeshes?: Mesh[];
  129293. /**
  129294. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  129295. */
  129296. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  129297. /**
  129298. * Defines if WebXR should be used instead of WebVR (if available)
  129299. */
  129300. useXR?: boolean;
  129301. }
  129302. /**
  129303. * Event containing information after VR has been entered
  129304. */
  129305. export class OnAfterEnteringVRObservableEvent {
  129306. /**
  129307. * If entering vr was successful
  129308. */
  129309. success: boolean;
  129310. }
  129311. /**
  129312. * Helps to quickly add VR support to an existing scene.
  129313. * See https://doc.babylonjs.com/how_to/webvr_helper
  129314. */
  129315. export class VRExperienceHelper {
  129316. /** Options to modify the vr experience helper's behavior. */
  129317. webVROptions: VRExperienceHelperOptions;
  129318. private _scene;
  129319. private _position;
  129320. private _btnVR;
  129321. private _btnVRDisplayed;
  129322. private _webVRsupported;
  129323. private _webVRready;
  129324. private _webVRrequesting;
  129325. private _webVRpresenting;
  129326. private _hasEnteredVR;
  129327. private _fullscreenVRpresenting;
  129328. private _inputElement;
  129329. private _webVRCamera;
  129330. private _vrDeviceOrientationCamera;
  129331. private _deviceOrientationCamera;
  129332. private _existingCamera;
  129333. private _onKeyDown;
  129334. private _onVrDisplayPresentChange;
  129335. private _onVRDisplayChanged;
  129336. private _onVRRequestPresentStart;
  129337. private _onVRRequestPresentComplete;
  129338. /**
  129339. * 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)
  129340. */
  129341. enableGazeEvenWhenNoPointerLock: boolean;
  129342. /**
  129343. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  129344. */
  129345. exitVROnDoubleTap: boolean;
  129346. /**
  129347. * Observable raised right before entering VR.
  129348. */
  129349. onEnteringVRObservable: Observable<VRExperienceHelper>;
  129350. /**
  129351. * Observable raised when entering VR has completed.
  129352. */
  129353. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  129354. /**
  129355. * Observable raised when exiting VR.
  129356. */
  129357. onExitingVRObservable: Observable<VRExperienceHelper>;
  129358. /**
  129359. * Observable raised when controller mesh is loaded.
  129360. */
  129361. onControllerMeshLoadedObservable: Observable<WebVRController>;
  129362. /** Return this.onEnteringVRObservable
  129363. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  129364. */
  129365. get onEnteringVR(): Observable<VRExperienceHelper>;
  129366. /** Return this.onExitingVRObservable
  129367. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  129368. */
  129369. get onExitingVR(): Observable<VRExperienceHelper>;
  129370. /** Return this.onControllerMeshLoadedObservable
  129371. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  129372. */
  129373. get onControllerMeshLoaded(): Observable<WebVRController>;
  129374. private _rayLength;
  129375. private _useCustomVRButton;
  129376. private _teleportationRequested;
  129377. private _teleportActive;
  129378. private _floorMeshName;
  129379. private _floorMeshesCollection;
  129380. private _teleportationMode;
  129381. private _teleportationTime;
  129382. private _teleportationSpeed;
  129383. private _teleportationEasing;
  129384. private _rotationAllowed;
  129385. private _teleportBackwardsVector;
  129386. private _teleportationTarget;
  129387. private _isDefaultTeleportationTarget;
  129388. private _postProcessMove;
  129389. private _teleportationFillColor;
  129390. private _teleportationBorderColor;
  129391. private _rotationAngle;
  129392. private _haloCenter;
  129393. private _cameraGazer;
  129394. private _padSensibilityUp;
  129395. private _padSensibilityDown;
  129396. private _leftController;
  129397. private _rightController;
  129398. private _gazeColor;
  129399. private _laserColor;
  129400. private _pickedLaserColor;
  129401. private _pickedGazeColor;
  129402. /**
  129403. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  129404. */
  129405. onNewMeshSelected: Observable<AbstractMesh>;
  129406. /**
  129407. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  129408. * This observable will provide the mesh and the controller used to select the mesh
  129409. */
  129410. onMeshSelectedWithController: Observable<{
  129411. mesh: AbstractMesh;
  129412. controller: WebVRController;
  129413. }>;
  129414. /**
  129415. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  129416. */
  129417. onNewMeshPicked: Observable<PickingInfo>;
  129418. private _circleEase;
  129419. /**
  129420. * Observable raised before camera teleportation
  129421. */
  129422. onBeforeCameraTeleport: Observable<Vector3>;
  129423. /**
  129424. * Observable raised after camera teleportation
  129425. */
  129426. onAfterCameraTeleport: Observable<Vector3>;
  129427. /**
  129428. * Observable raised when current selected mesh gets unselected
  129429. */
  129430. onSelectedMeshUnselected: Observable<AbstractMesh>;
  129431. private _raySelectionPredicate;
  129432. /**
  129433. * To be optionaly changed by user to define custom ray selection
  129434. */
  129435. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  129436. /**
  129437. * To be optionaly changed by user to define custom selection logic (after ray selection)
  129438. */
  129439. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  129440. /**
  129441. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  129442. */
  129443. teleportationEnabled: boolean;
  129444. private _defaultHeight;
  129445. private _teleportationInitialized;
  129446. private _interactionsEnabled;
  129447. private _interactionsRequested;
  129448. private _displayGaze;
  129449. private _displayLaserPointer;
  129450. /**
  129451. * The mesh used to display where the user is going to teleport.
  129452. */
  129453. get teleportationTarget(): Mesh;
  129454. /**
  129455. * Sets the mesh to be used to display where the user is going to teleport.
  129456. */
  129457. set teleportationTarget(value: Mesh);
  129458. /**
  129459. * 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
  129460. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  129461. * See https://doc.babylonjs.com/resources/baking_transformations
  129462. */
  129463. get gazeTrackerMesh(): Mesh;
  129464. set gazeTrackerMesh(value: Mesh);
  129465. /**
  129466. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  129467. */
  129468. updateGazeTrackerScale: boolean;
  129469. /**
  129470. * If the gaze trackers color should be updated when selecting meshes
  129471. */
  129472. updateGazeTrackerColor: boolean;
  129473. /**
  129474. * If the controller laser color should be updated when selecting meshes
  129475. */
  129476. updateControllerLaserColor: boolean;
  129477. /**
  129478. * The gaze tracking mesh corresponding to the left controller
  129479. */
  129480. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  129481. /**
  129482. * The gaze tracking mesh corresponding to the right controller
  129483. */
  129484. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  129485. /**
  129486. * If the ray of the gaze should be displayed.
  129487. */
  129488. get displayGaze(): boolean;
  129489. /**
  129490. * Sets if the ray of the gaze should be displayed.
  129491. */
  129492. set displayGaze(value: boolean);
  129493. /**
  129494. * If the ray of the LaserPointer should be displayed.
  129495. */
  129496. get displayLaserPointer(): boolean;
  129497. /**
  129498. * Sets if the ray of the LaserPointer should be displayed.
  129499. */
  129500. set displayLaserPointer(value: boolean);
  129501. /**
  129502. * The deviceOrientationCamera used as the camera when not in VR.
  129503. */
  129504. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  129505. /**
  129506. * Based on the current WebVR support, returns the current VR camera used.
  129507. */
  129508. get currentVRCamera(): Nullable<Camera>;
  129509. /**
  129510. * The webVRCamera which is used when in VR.
  129511. */
  129512. get webVRCamera(): WebVRFreeCamera;
  129513. /**
  129514. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  129515. */
  129516. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  129517. /**
  129518. * The html button that is used to trigger entering into VR.
  129519. */
  129520. get vrButton(): Nullable<HTMLButtonElement>;
  129521. private get _teleportationRequestInitiated();
  129522. /**
  129523. * Defines whether or not Pointer lock should be requested when switching to
  129524. * full screen.
  129525. */
  129526. requestPointerLockOnFullScreen: boolean;
  129527. /**
  129528. * If asking to force XR, this will be populated with the default xr experience
  129529. */
  129530. xr: WebXRDefaultExperience;
  129531. /**
  129532. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  129533. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  129534. */
  129535. xrTestDone: boolean;
  129536. /**
  129537. * Instantiates a VRExperienceHelper.
  129538. * Helps to quickly add VR support to an existing scene.
  129539. * @param scene The scene the VRExperienceHelper belongs to.
  129540. * @param webVROptions Options to modify the vr experience helper's behavior.
  129541. */
  129542. constructor(scene: Scene,
  129543. /** Options to modify the vr experience helper's behavior. */
  129544. webVROptions?: VRExperienceHelperOptions);
  129545. private completeVRInit;
  129546. private _onDefaultMeshLoaded;
  129547. private _onResize;
  129548. private _onFullscreenChange;
  129549. /**
  129550. * Gets a value indicating if we are currently in VR mode.
  129551. */
  129552. get isInVRMode(): boolean;
  129553. private onVrDisplayPresentChange;
  129554. private onVRDisplayChanged;
  129555. private moveButtonToBottomRight;
  129556. private displayVRButton;
  129557. private updateButtonVisibility;
  129558. private _cachedAngularSensibility;
  129559. /**
  129560. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  129561. * Otherwise, will use the fullscreen API.
  129562. */
  129563. enterVR(): void;
  129564. /**
  129565. * Attempt to exit VR, or fullscreen.
  129566. */
  129567. exitVR(): void;
  129568. /**
  129569. * The position of the vr experience helper.
  129570. */
  129571. get position(): Vector3;
  129572. /**
  129573. * Sets the position of the vr experience helper.
  129574. */
  129575. set position(value: Vector3);
  129576. /**
  129577. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  129578. */
  129579. enableInteractions(): void;
  129580. private get _noControllerIsActive();
  129581. private beforeRender;
  129582. private _isTeleportationFloor;
  129583. /**
  129584. * Adds a floor mesh to be used for teleportation.
  129585. * @param floorMesh the mesh to be used for teleportation.
  129586. */
  129587. addFloorMesh(floorMesh: Mesh): void;
  129588. /**
  129589. * Removes a floor mesh from being used for teleportation.
  129590. * @param floorMesh the mesh to be removed.
  129591. */
  129592. removeFloorMesh(floorMesh: Mesh): void;
  129593. /**
  129594. * Enables interactions and teleportation using the VR controllers and gaze.
  129595. * @param vrTeleportationOptions options to modify teleportation behavior.
  129596. */
  129597. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  129598. private _onNewGamepadConnected;
  129599. private _tryEnableInteractionOnController;
  129600. private _onNewGamepadDisconnected;
  129601. private _enableInteractionOnController;
  129602. private _checkTeleportWithRay;
  129603. private _checkRotate;
  129604. private _checkTeleportBackwards;
  129605. private _enableTeleportationOnController;
  129606. private _createTeleportationCircles;
  129607. private _displayTeleportationTarget;
  129608. private _hideTeleportationTarget;
  129609. private _rotateCamera;
  129610. private _moveTeleportationSelectorTo;
  129611. private _workingVector;
  129612. private _workingQuaternion;
  129613. private _workingMatrix;
  129614. /**
  129615. * Time Constant Teleportation Mode
  129616. */
  129617. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  129618. /**
  129619. * Speed Constant Teleportation Mode
  129620. */
  129621. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  129622. /**
  129623. * Teleports the users feet to the desired location
  129624. * @param location The location where the user's feet should be placed
  129625. */
  129626. teleportCamera(location: Vector3): void;
  129627. private _convertNormalToDirectionOfRay;
  129628. private _castRayAndSelectObject;
  129629. private _notifySelectedMeshUnselected;
  129630. /**
  129631. * Permanently set new colors for the laser pointer
  129632. * @param color the new laser color
  129633. * @param pickedColor the new laser color when picked mesh detected
  129634. */
  129635. setLaserColor(color: Color3, pickedColor?: Color3): void;
  129636. /**
  129637. * Set lighting enabled / disabled on the laser pointer of both controllers
  129638. * @param enabled should the lighting be enabled on the laser pointer
  129639. */
  129640. setLaserLightingState(enabled?: boolean): void;
  129641. /**
  129642. * Permanently set new colors for the gaze pointer
  129643. * @param color the new gaze color
  129644. * @param pickedColor the new gaze color when picked mesh detected
  129645. */
  129646. setGazeColor(color: Color3, pickedColor?: Color3): void;
  129647. /**
  129648. * Sets the color of the laser ray from the vr controllers.
  129649. * @param color new color for the ray.
  129650. */
  129651. changeLaserColor(color: Color3): void;
  129652. /**
  129653. * Sets the color of the ray from the vr headsets gaze.
  129654. * @param color new color for the ray.
  129655. */
  129656. changeGazeColor(color: Color3): void;
  129657. /**
  129658. * Exits VR and disposes of the vr experience helper
  129659. */
  129660. dispose(): void;
  129661. /**
  129662. * Gets the name of the VRExperienceHelper class
  129663. * @returns "VRExperienceHelper"
  129664. */
  129665. getClassName(): string;
  129666. }
  129667. }
  129668. declare module BABYLON {
  129669. /**
  129670. * Contains an array of blocks representing the octree
  129671. */
  129672. export interface IOctreeContainer<T> {
  129673. /**
  129674. * Blocks within the octree
  129675. */
  129676. blocks: Array<OctreeBlock<T>>;
  129677. }
  129678. /**
  129679. * Class used to store a cell in an octree
  129680. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129681. */
  129682. export class OctreeBlock<T> {
  129683. /**
  129684. * Gets the content of the current block
  129685. */
  129686. entries: T[];
  129687. /**
  129688. * Gets the list of block children
  129689. */
  129690. blocks: Array<OctreeBlock<T>>;
  129691. private _depth;
  129692. private _maxDepth;
  129693. private _capacity;
  129694. private _minPoint;
  129695. private _maxPoint;
  129696. private _boundingVectors;
  129697. private _creationFunc;
  129698. /**
  129699. * Creates a new block
  129700. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  129701. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  129702. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129703. * @param depth defines the current depth of this block in the octree
  129704. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  129705. * @param creationFunc defines a callback to call when an element is added to the block
  129706. */
  129707. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  129708. /**
  129709. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129710. */
  129711. get capacity(): number;
  129712. /**
  129713. * Gets the minimum vector (in world space) of the block's bounding box
  129714. */
  129715. get minPoint(): Vector3;
  129716. /**
  129717. * Gets the maximum vector (in world space) of the block's bounding box
  129718. */
  129719. get maxPoint(): Vector3;
  129720. /**
  129721. * Add a new element to this block
  129722. * @param entry defines the element to add
  129723. */
  129724. addEntry(entry: T): void;
  129725. /**
  129726. * Remove an element from this block
  129727. * @param entry defines the element to remove
  129728. */
  129729. removeEntry(entry: T): void;
  129730. /**
  129731. * Add an array of elements to this block
  129732. * @param entries defines the array of elements to add
  129733. */
  129734. addEntries(entries: T[]): void;
  129735. /**
  129736. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  129737. * @param frustumPlanes defines the frustum planes to test
  129738. * @param selection defines the array to store current content if selection is positive
  129739. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129740. */
  129741. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129742. /**
  129743. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  129744. * @param sphereCenter defines the bounding sphere center
  129745. * @param sphereRadius defines the bounding sphere radius
  129746. * @param selection defines the array to store current content if selection is positive
  129747. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129748. */
  129749. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129750. /**
  129751. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  129752. * @param ray defines the ray to test with
  129753. * @param selection defines the array to store current content if selection is positive
  129754. */
  129755. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  129756. /**
  129757. * Subdivide the content into child blocks (this block will then be empty)
  129758. */
  129759. createInnerBlocks(): void;
  129760. /**
  129761. * @hidden
  129762. */
  129763. 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;
  129764. }
  129765. }
  129766. declare module BABYLON {
  129767. /**
  129768. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  129769. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129770. */
  129771. export class Octree<T> {
  129772. /** 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.) */
  129773. maxDepth: number;
  129774. /**
  129775. * Blocks within the octree containing objects
  129776. */
  129777. blocks: Array<OctreeBlock<T>>;
  129778. /**
  129779. * Content stored in the octree
  129780. */
  129781. dynamicContent: T[];
  129782. private _maxBlockCapacity;
  129783. private _selectionContent;
  129784. private _creationFunc;
  129785. /**
  129786. * Creates a octree
  129787. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129788. * @param creationFunc function to be used to instatiate the octree
  129789. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  129790. * @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.)
  129791. */
  129792. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  129793. /** 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.) */
  129794. maxDepth?: number);
  129795. /**
  129796. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  129797. * @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);
  129798. * @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);
  129799. * @param entries meshes to be added to the octree blocks
  129800. */
  129801. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  129802. /**
  129803. * Adds a mesh to the octree
  129804. * @param entry Mesh to add to the octree
  129805. */
  129806. addMesh(entry: T): void;
  129807. /**
  129808. * Remove an element from the octree
  129809. * @param entry defines the element to remove
  129810. */
  129811. removeMesh(entry: T): void;
  129812. /**
  129813. * Selects an array of meshes within the frustum
  129814. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  129815. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  129816. * @returns array of meshes within the frustum
  129817. */
  129818. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  129819. /**
  129820. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  129821. * @param sphereCenter defines the bounding sphere center
  129822. * @param sphereRadius defines the bounding sphere radius
  129823. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129824. * @returns an array of objects that intersect the sphere
  129825. */
  129826. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  129827. /**
  129828. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  129829. * @param ray defines the ray to test with
  129830. * @returns array of intersected objects
  129831. */
  129832. intersectsRay(ray: Ray): SmartArray<T>;
  129833. /**
  129834. * Adds a mesh into the octree block if it intersects the block
  129835. */
  129836. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  129837. /**
  129838. * Adds a submesh into the octree block if it intersects the block
  129839. */
  129840. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  129841. }
  129842. }
  129843. declare module BABYLON {
  129844. interface Scene {
  129845. /**
  129846. * @hidden
  129847. * Backing Filed
  129848. */
  129849. _selectionOctree: Octree<AbstractMesh>;
  129850. /**
  129851. * Gets the octree used to boost mesh selection (picking)
  129852. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129853. */
  129854. selectionOctree: Octree<AbstractMesh>;
  129855. /**
  129856. * Creates or updates the octree used to boost selection (picking)
  129857. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129858. * @param maxCapacity defines the maximum capacity per leaf
  129859. * @param maxDepth defines the maximum depth of the octree
  129860. * @returns an octree of AbstractMesh
  129861. */
  129862. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  129863. }
  129864. interface AbstractMesh {
  129865. /**
  129866. * @hidden
  129867. * Backing Field
  129868. */
  129869. _submeshesOctree: Octree<SubMesh>;
  129870. /**
  129871. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  129872. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  129873. * @param maxCapacity defines the maximum size of each block (64 by default)
  129874. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  129875. * @returns the new octree
  129876. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  129877. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129878. */
  129879. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  129880. }
  129881. /**
  129882. * Defines the octree scene component responsible to manage any octrees
  129883. * in a given scene.
  129884. */
  129885. export class OctreeSceneComponent {
  129886. /**
  129887. * The component name help to identify the component in the list of scene components.
  129888. */
  129889. readonly name: string;
  129890. /**
  129891. * The scene the component belongs to.
  129892. */
  129893. scene: Scene;
  129894. /**
  129895. * Indicates if the meshes have been checked to make sure they are isEnabled()
  129896. */
  129897. readonly checksIsEnabled: boolean;
  129898. /**
  129899. * Creates a new instance of the component for the given scene
  129900. * @param scene Defines the scene to register the component in
  129901. */
  129902. constructor(scene: Scene);
  129903. /**
  129904. * Registers the component in a given scene
  129905. */
  129906. register(): void;
  129907. /**
  129908. * Return the list of active meshes
  129909. * @returns the list of active meshes
  129910. */
  129911. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  129912. /**
  129913. * Return the list of active sub meshes
  129914. * @param mesh The mesh to get the candidates sub meshes from
  129915. * @returns the list of active sub meshes
  129916. */
  129917. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  129918. private _tempRay;
  129919. /**
  129920. * Return the list of sub meshes intersecting with a given local ray
  129921. * @param mesh defines the mesh to find the submesh for
  129922. * @param localRay defines the ray in local space
  129923. * @returns the list of intersecting sub meshes
  129924. */
  129925. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  129926. /**
  129927. * Return the list of sub meshes colliding with a collider
  129928. * @param mesh defines the mesh to find the submesh for
  129929. * @param collider defines the collider to evaluate the collision against
  129930. * @returns the list of colliding sub meshes
  129931. */
  129932. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  129933. /**
  129934. * Rebuilds the elements related to this component in case of
  129935. * context lost for instance.
  129936. */
  129937. rebuild(): void;
  129938. /**
  129939. * Disposes the component and the associated ressources.
  129940. */
  129941. dispose(): void;
  129942. }
  129943. }
  129944. declare module BABYLON {
  129945. /**
  129946. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  129947. */
  129948. export class Gizmo implements IDisposable {
  129949. /** The utility layer the gizmo will be added to */
  129950. gizmoLayer: UtilityLayerRenderer;
  129951. /**
  129952. * The root mesh of the gizmo
  129953. */
  129954. _rootMesh: Mesh;
  129955. private _attachedMesh;
  129956. private _attachedNode;
  129957. /**
  129958. * Ratio for the scale of the gizmo (Default: 1)
  129959. */
  129960. protected _scaleRatio: number;
  129961. /**
  129962. * Ratio for the scale of the gizmo (Default: 1)
  129963. */
  129964. set scaleRatio(value: number);
  129965. get scaleRatio(): number;
  129966. /**
  129967. * If a custom mesh has been set (Default: false)
  129968. */
  129969. protected _customMeshSet: boolean;
  129970. /**
  129971. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  129972. * * When set, interactions will be enabled
  129973. */
  129974. get attachedMesh(): Nullable<AbstractMesh>;
  129975. set attachedMesh(value: Nullable<AbstractMesh>);
  129976. /**
  129977. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  129978. * * When set, interactions will be enabled
  129979. */
  129980. get attachedNode(): Nullable<Node>;
  129981. set attachedNode(value: Nullable<Node>);
  129982. /**
  129983. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  129984. * @param mesh The mesh to replace the default mesh of the gizmo
  129985. */
  129986. setCustomMesh(mesh: Mesh): void;
  129987. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  129988. /**
  129989. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  129990. */
  129991. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  129992. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  129993. /**
  129994. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  129995. */
  129996. updateGizmoPositionToMatchAttachedMesh: boolean;
  129997. /**
  129998. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  129999. */
  130000. updateScale: boolean;
  130001. protected _interactionsEnabled: boolean;
  130002. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130003. private _beforeRenderObserver;
  130004. private _tempQuaternion;
  130005. private _tempVector;
  130006. private _tempVector2;
  130007. /**
  130008. * Creates a gizmo
  130009. * @param gizmoLayer The utility layer the gizmo will be added to
  130010. */
  130011. constructor(
  130012. /** The utility layer the gizmo will be added to */
  130013. gizmoLayer?: UtilityLayerRenderer);
  130014. /**
  130015. * Updates the gizmo to match the attached mesh's position/rotation
  130016. */
  130017. protected _update(): void;
  130018. /**
  130019. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  130020. * @param value Node, TransformNode or mesh
  130021. */
  130022. protected _matrixChanged(): void;
  130023. /**
  130024. * Disposes of the gizmo
  130025. */
  130026. dispose(): void;
  130027. }
  130028. }
  130029. declare module BABYLON {
  130030. /**
  130031. * Single plane drag gizmo
  130032. */
  130033. export class PlaneDragGizmo extends Gizmo {
  130034. /**
  130035. * Drag behavior responsible for the gizmos dragging interactions
  130036. */
  130037. dragBehavior: PointerDragBehavior;
  130038. private _pointerObserver;
  130039. /**
  130040. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130041. */
  130042. snapDistance: number;
  130043. /**
  130044. * Event that fires each time the gizmo snaps to a new location.
  130045. * * snapDistance is the the change in distance
  130046. */
  130047. onSnapObservable: Observable<{
  130048. snapDistance: number;
  130049. }>;
  130050. private _plane;
  130051. private _coloredMaterial;
  130052. private _hoverMaterial;
  130053. private _isEnabled;
  130054. private _parent;
  130055. /** @hidden */
  130056. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  130057. /** @hidden */
  130058. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130059. /**
  130060. * Creates a PlaneDragGizmo
  130061. * @param gizmoLayer The utility layer the gizmo will be added to
  130062. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  130063. * @param color The color of the gizmo
  130064. */
  130065. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  130066. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130067. /**
  130068. * If the gizmo is enabled
  130069. */
  130070. set isEnabled(value: boolean);
  130071. get isEnabled(): boolean;
  130072. /**
  130073. * Disposes of the gizmo
  130074. */
  130075. dispose(): void;
  130076. }
  130077. }
  130078. declare module BABYLON {
  130079. /**
  130080. * Gizmo that enables dragging a mesh along 3 axis
  130081. */
  130082. export class PositionGizmo extends Gizmo {
  130083. /**
  130084. * Internal gizmo used for interactions on the x axis
  130085. */
  130086. xGizmo: AxisDragGizmo;
  130087. /**
  130088. * Internal gizmo used for interactions on the y axis
  130089. */
  130090. yGizmo: AxisDragGizmo;
  130091. /**
  130092. * Internal gizmo used for interactions on the z axis
  130093. */
  130094. zGizmo: AxisDragGizmo;
  130095. /**
  130096. * Internal gizmo used for interactions on the yz plane
  130097. */
  130098. xPlaneGizmo: PlaneDragGizmo;
  130099. /**
  130100. * Internal gizmo used for interactions on the xz plane
  130101. */
  130102. yPlaneGizmo: PlaneDragGizmo;
  130103. /**
  130104. * Internal gizmo used for interactions on the xy plane
  130105. */
  130106. zPlaneGizmo: PlaneDragGizmo;
  130107. /**
  130108. * private variables
  130109. */
  130110. private _meshAttached;
  130111. private _nodeAttached;
  130112. private _snapDistance;
  130113. /** Fires an event when any of it's sub gizmos are dragged */
  130114. onDragStartObservable: Observable<unknown>;
  130115. /** Fires an event when any of it's sub gizmos are released from dragging */
  130116. onDragEndObservable: Observable<unknown>;
  130117. /**
  130118. * If set to true, planar drag is enabled
  130119. */
  130120. private _planarGizmoEnabled;
  130121. get attachedMesh(): Nullable<AbstractMesh>;
  130122. set attachedMesh(mesh: Nullable<AbstractMesh>);
  130123. get attachedNode(): Nullable<Node>;
  130124. set attachedNode(node: Nullable<Node>);
  130125. /**
  130126. * Creates a PositionGizmo
  130127. * @param gizmoLayer The utility layer the gizmo will be added to
  130128. @param thickness display gizmo axis thickness
  130129. */
  130130. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  130131. /**
  130132. * If the planar drag gizmo is enabled
  130133. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  130134. */
  130135. set planarGizmoEnabled(value: boolean);
  130136. get planarGizmoEnabled(): boolean;
  130137. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130138. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130139. /**
  130140. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130141. */
  130142. set snapDistance(value: number);
  130143. get snapDistance(): number;
  130144. /**
  130145. * Ratio for the scale of the gizmo (Default: 1)
  130146. */
  130147. set scaleRatio(value: number);
  130148. get scaleRatio(): number;
  130149. /**
  130150. * Disposes of the gizmo
  130151. */
  130152. dispose(): void;
  130153. /**
  130154. * CustomMeshes are not supported by this gizmo
  130155. * @param mesh The mesh to replace the default mesh of the gizmo
  130156. */
  130157. setCustomMesh(mesh: Mesh): void;
  130158. }
  130159. }
  130160. declare module BABYLON {
  130161. /**
  130162. * Single axis drag gizmo
  130163. */
  130164. export class AxisDragGizmo extends Gizmo {
  130165. /**
  130166. * Drag behavior responsible for the gizmos dragging interactions
  130167. */
  130168. dragBehavior: PointerDragBehavior;
  130169. private _pointerObserver;
  130170. /**
  130171. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130172. */
  130173. snapDistance: number;
  130174. /**
  130175. * Event that fires each time the gizmo snaps to a new location.
  130176. * * snapDistance is the the change in distance
  130177. */
  130178. onSnapObservable: Observable<{
  130179. snapDistance: number;
  130180. }>;
  130181. private _isEnabled;
  130182. private _parent;
  130183. private _arrow;
  130184. private _coloredMaterial;
  130185. private _hoverMaterial;
  130186. /** @hidden */
  130187. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  130188. /** @hidden */
  130189. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130190. /**
  130191. * Creates an AxisDragGizmo
  130192. * @param gizmoLayer The utility layer the gizmo will be added to
  130193. * @param dragAxis The axis which the gizmo will be able to drag on
  130194. * @param color The color of the gizmo
  130195. * @param thickness display gizmo axis thickness
  130196. */
  130197. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  130198. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130199. /**
  130200. * If the gizmo is enabled
  130201. */
  130202. set isEnabled(value: boolean);
  130203. get isEnabled(): boolean;
  130204. /**
  130205. * Disposes of the gizmo
  130206. */
  130207. dispose(): void;
  130208. }
  130209. }
  130210. declare module BABYLON.Debug {
  130211. /**
  130212. * The Axes viewer will show 3 axes in a specific point in space
  130213. */
  130214. export class AxesViewer {
  130215. private _xAxis;
  130216. private _yAxis;
  130217. private _zAxis;
  130218. private _scaleLinesFactor;
  130219. private _instanced;
  130220. /**
  130221. * Gets the hosting scene
  130222. */
  130223. scene: Nullable<Scene>;
  130224. /**
  130225. * Gets or sets a number used to scale line length
  130226. */
  130227. scaleLines: number;
  130228. /** Gets the node hierarchy used to render x-axis */
  130229. get xAxis(): TransformNode;
  130230. /** Gets the node hierarchy used to render y-axis */
  130231. get yAxis(): TransformNode;
  130232. /** Gets the node hierarchy used to render z-axis */
  130233. get zAxis(): TransformNode;
  130234. /**
  130235. * Creates a new AxesViewer
  130236. * @param scene defines the hosting scene
  130237. * @param scaleLines defines a number used to scale line length (1 by default)
  130238. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  130239. * @param xAxis defines the node hierarchy used to render the x-axis
  130240. * @param yAxis defines the node hierarchy used to render the y-axis
  130241. * @param zAxis defines the node hierarchy used to render the z-axis
  130242. */
  130243. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  130244. /**
  130245. * Force the viewer to update
  130246. * @param position defines the position of the viewer
  130247. * @param xaxis defines the x axis of the viewer
  130248. * @param yaxis defines the y axis of the viewer
  130249. * @param zaxis defines the z axis of the viewer
  130250. */
  130251. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  130252. /**
  130253. * Creates an instance of this axes viewer.
  130254. * @returns a new axes viewer with instanced meshes
  130255. */
  130256. createInstance(): AxesViewer;
  130257. /** Releases resources */
  130258. dispose(): void;
  130259. private static _SetRenderingGroupId;
  130260. }
  130261. }
  130262. declare module BABYLON.Debug {
  130263. /**
  130264. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  130265. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  130266. */
  130267. export class BoneAxesViewer extends AxesViewer {
  130268. /**
  130269. * Gets or sets the target mesh where to display the axes viewer
  130270. */
  130271. mesh: Nullable<Mesh>;
  130272. /**
  130273. * Gets or sets the target bone where to display the axes viewer
  130274. */
  130275. bone: Nullable<Bone>;
  130276. /** Gets current position */
  130277. pos: Vector3;
  130278. /** Gets direction of X axis */
  130279. xaxis: Vector3;
  130280. /** Gets direction of Y axis */
  130281. yaxis: Vector3;
  130282. /** Gets direction of Z axis */
  130283. zaxis: Vector3;
  130284. /**
  130285. * Creates a new BoneAxesViewer
  130286. * @param scene defines the hosting scene
  130287. * @param bone defines the target bone
  130288. * @param mesh defines the target mesh
  130289. * @param scaleLines defines a scaling factor for line length (1 by default)
  130290. */
  130291. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  130292. /**
  130293. * Force the viewer to update
  130294. */
  130295. update(): void;
  130296. /** Releases resources */
  130297. dispose(): void;
  130298. }
  130299. }
  130300. declare module BABYLON {
  130301. /**
  130302. * Interface used to define scene explorer extensibility option
  130303. */
  130304. export interface IExplorerExtensibilityOption {
  130305. /**
  130306. * Define the option label
  130307. */
  130308. label: string;
  130309. /**
  130310. * Defines the action to execute on click
  130311. */
  130312. action: (entity: any) => void;
  130313. }
  130314. /**
  130315. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  130316. */
  130317. export interface IExplorerExtensibilityGroup {
  130318. /**
  130319. * Defines a predicate to test if a given type mut be extended
  130320. */
  130321. predicate: (entity: any) => boolean;
  130322. /**
  130323. * Gets the list of options added to a type
  130324. */
  130325. entries: IExplorerExtensibilityOption[];
  130326. }
  130327. /**
  130328. * Interface used to define the options to use to create the Inspector
  130329. */
  130330. export interface IInspectorOptions {
  130331. /**
  130332. * Display in overlay mode (default: false)
  130333. */
  130334. overlay?: boolean;
  130335. /**
  130336. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  130337. */
  130338. globalRoot?: HTMLElement;
  130339. /**
  130340. * Display the Scene explorer
  130341. */
  130342. showExplorer?: boolean;
  130343. /**
  130344. * Display the property inspector
  130345. */
  130346. showInspector?: boolean;
  130347. /**
  130348. * Display in embed mode (both panes on the right)
  130349. */
  130350. embedMode?: boolean;
  130351. /**
  130352. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  130353. */
  130354. handleResize?: boolean;
  130355. /**
  130356. * Allow the panes to popup (default: true)
  130357. */
  130358. enablePopup?: boolean;
  130359. /**
  130360. * Allow the panes to be closed by users (default: true)
  130361. */
  130362. enableClose?: boolean;
  130363. /**
  130364. * Optional list of extensibility entries
  130365. */
  130366. explorerExtensibility?: IExplorerExtensibilityGroup[];
  130367. /**
  130368. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  130369. */
  130370. inspectorURL?: string;
  130371. /**
  130372. * Optional initial tab (default to DebugLayerTab.Properties)
  130373. */
  130374. initialTab?: DebugLayerTab;
  130375. }
  130376. interface Scene {
  130377. /**
  130378. * @hidden
  130379. * Backing field
  130380. */
  130381. _debugLayer: DebugLayer;
  130382. /**
  130383. * Gets the debug layer (aka Inspector) associated with the scene
  130384. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130385. */
  130386. debugLayer: DebugLayer;
  130387. }
  130388. /**
  130389. * Enum of inspector action tab
  130390. */
  130391. export enum DebugLayerTab {
  130392. /**
  130393. * Properties tag (default)
  130394. */
  130395. Properties = 0,
  130396. /**
  130397. * Debug tab
  130398. */
  130399. Debug = 1,
  130400. /**
  130401. * Statistics tab
  130402. */
  130403. Statistics = 2,
  130404. /**
  130405. * Tools tab
  130406. */
  130407. Tools = 3,
  130408. /**
  130409. * Settings tab
  130410. */
  130411. Settings = 4
  130412. }
  130413. /**
  130414. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130415. * what is happening in your scene
  130416. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130417. */
  130418. export class DebugLayer {
  130419. /**
  130420. * Define the url to get the inspector script from.
  130421. * By default it uses the babylonjs CDN.
  130422. * @ignoreNaming
  130423. */
  130424. static InspectorURL: string;
  130425. private _scene;
  130426. private BJSINSPECTOR;
  130427. private _onPropertyChangedObservable?;
  130428. /**
  130429. * Observable triggered when a property is changed through the inspector.
  130430. */
  130431. get onPropertyChangedObservable(): any;
  130432. /**
  130433. * Instantiates a new debug layer.
  130434. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130435. * what is happening in your scene
  130436. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130437. * @param scene Defines the scene to inspect
  130438. */
  130439. constructor(scene: Scene);
  130440. /** Creates the inspector window. */
  130441. private _createInspector;
  130442. /**
  130443. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  130444. * @param entity defines the entity to select
  130445. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  130446. */
  130447. select(entity: any, lineContainerTitles?: string | string[]): void;
  130448. /** Get the inspector from bundle or global */
  130449. private _getGlobalInspector;
  130450. /**
  130451. * Get if the inspector is visible or not.
  130452. * @returns true if visible otherwise, false
  130453. */
  130454. isVisible(): boolean;
  130455. /**
  130456. * Hide the inspector and close its window.
  130457. */
  130458. hide(): void;
  130459. /**
  130460. * Update the scene in the inspector
  130461. */
  130462. setAsActiveScene(): void;
  130463. /**
  130464. * Launch the debugLayer.
  130465. * @param config Define the configuration of the inspector
  130466. * @return a promise fulfilled when the debug layer is visible
  130467. */
  130468. show(config?: IInspectorOptions): Promise<DebugLayer>;
  130469. }
  130470. }
  130471. declare module BABYLON {
  130472. /**
  130473. * Class containing static functions to help procedurally build meshes
  130474. */
  130475. export class BoxBuilder {
  130476. /**
  130477. * Creates a box mesh
  130478. * * The parameter `size` sets the size (float) of each box side (default 1)
  130479. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  130480. * * 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)
  130481. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  130482. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130483. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130484. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130485. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  130486. * @param name defines the name of the mesh
  130487. * @param options defines the options used to create the mesh
  130488. * @param scene defines the hosting scene
  130489. * @returns the box mesh
  130490. */
  130491. static CreateBox(name: string, options: {
  130492. size?: number;
  130493. width?: number;
  130494. height?: number;
  130495. depth?: number;
  130496. faceUV?: Vector4[];
  130497. faceColors?: Color4[];
  130498. sideOrientation?: number;
  130499. frontUVs?: Vector4;
  130500. backUVs?: Vector4;
  130501. wrap?: boolean;
  130502. topBaseAt?: number;
  130503. bottomBaseAt?: number;
  130504. updatable?: boolean;
  130505. }, scene?: Nullable<Scene>): Mesh;
  130506. }
  130507. }
  130508. declare module BABYLON.Debug {
  130509. /**
  130510. * Used to show the physics impostor around the specific mesh
  130511. */
  130512. export class PhysicsViewer {
  130513. /** @hidden */
  130514. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  130515. /** @hidden */
  130516. protected _meshes: Array<Nullable<AbstractMesh>>;
  130517. /** @hidden */
  130518. protected _scene: Nullable<Scene>;
  130519. /** @hidden */
  130520. protected _numMeshes: number;
  130521. /** @hidden */
  130522. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  130523. private _renderFunction;
  130524. private _utilityLayer;
  130525. private _debugBoxMesh;
  130526. private _debugSphereMesh;
  130527. private _debugCylinderMesh;
  130528. private _debugMaterial;
  130529. private _debugMeshMeshes;
  130530. /**
  130531. * Creates a new PhysicsViewer
  130532. * @param scene defines the hosting scene
  130533. */
  130534. constructor(scene: Scene);
  130535. /** @hidden */
  130536. protected _updateDebugMeshes(): void;
  130537. /**
  130538. * Renders a specified physic impostor
  130539. * @param impostor defines the impostor to render
  130540. * @param targetMesh defines the mesh represented by the impostor
  130541. * @returns the new debug mesh used to render the impostor
  130542. */
  130543. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  130544. /**
  130545. * Hides a specified physic impostor
  130546. * @param impostor defines the impostor to hide
  130547. */
  130548. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  130549. private _getDebugMaterial;
  130550. private _getDebugBoxMesh;
  130551. private _getDebugSphereMesh;
  130552. private _getDebugCylinderMesh;
  130553. private _getDebugMeshMesh;
  130554. private _getDebugMesh;
  130555. /** Releases all resources */
  130556. dispose(): void;
  130557. }
  130558. }
  130559. declare module BABYLON {
  130560. /**
  130561. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130562. * in order to better appreciate the issue one might have.
  130563. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130564. */
  130565. export class RayHelper {
  130566. /**
  130567. * Defines the ray we are currently tryin to visualize.
  130568. */
  130569. ray: Nullable<Ray>;
  130570. private _renderPoints;
  130571. private _renderLine;
  130572. private _renderFunction;
  130573. private _scene;
  130574. private _onAfterRenderObserver;
  130575. private _onAfterStepObserver;
  130576. private _attachedToMesh;
  130577. private _meshSpaceDirection;
  130578. private _meshSpaceOrigin;
  130579. /**
  130580. * Helper function to create a colored helper in a scene in one line.
  130581. * @param ray Defines the ray we are currently tryin to visualize
  130582. * @param scene Defines the scene the ray is used in
  130583. * @param color Defines the color we want to see the ray in
  130584. * @returns The newly created ray helper.
  130585. */
  130586. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  130587. /**
  130588. * Instantiate a new ray helper.
  130589. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130590. * in order to better appreciate the issue one might have.
  130591. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130592. * @param ray Defines the ray we are currently tryin to visualize
  130593. */
  130594. constructor(ray: Ray);
  130595. /**
  130596. * Shows the ray we are willing to debug.
  130597. * @param scene Defines the scene the ray needs to be rendered in
  130598. * @param color Defines the color the ray needs to be rendered in
  130599. */
  130600. show(scene: Scene, color?: Color3): void;
  130601. /**
  130602. * Hides the ray we are debugging.
  130603. */
  130604. hide(): void;
  130605. private _render;
  130606. /**
  130607. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  130608. * @param mesh Defines the mesh we want the helper attached to
  130609. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  130610. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  130611. * @param length Defines the length of the ray
  130612. */
  130613. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  130614. /**
  130615. * Detach the ray helper from the mesh it has previously been attached to.
  130616. */
  130617. detachFromMesh(): void;
  130618. private _updateToMesh;
  130619. /**
  130620. * Dispose the helper and release its associated resources.
  130621. */
  130622. dispose(): void;
  130623. }
  130624. }
  130625. declare module BABYLON {
  130626. /**
  130627. * Defines the options associated with the creation of a SkeletonViewer.
  130628. */
  130629. export interface ISkeletonViewerOptions {
  130630. /** Should the system pause animations before building the Viewer? */
  130631. pauseAnimations: boolean;
  130632. /** Should the system return the skeleton to rest before building? */
  130633. returnToRest: boolean;
  130634. /** public Display Mode of the Viewer */
  130635. displayMode: number;
  130636. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130637. displayOptions: ISkeletonViewerDisplayOptions;
  130638. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130639. computeBonesUsingShaders: boolean;
  130640. }
  130641. /**
  130642. * Defines how to display the various bone meshes for the viewer.
  130643. */
  130644. export interface ISkeletonViewerDisplayOptions {
  130645. /** How far down to start tapering the bone spurs */
  130646. midStep?: number;
  130647. /** How big is the midStep? */
  130648. midStepFactor?: number;
  130649. /** Base for the Sphere Size */
  130650. sphereBaseSize?: number;
  130651. /** The ratio of the sphere to the longest bone in units */
  130652. sphereScaleUnit?: number;
  130653. /** Ratio for the Sphere Size */
  130654. sphereFactor?: number;
  130655. }
  130656. }
  130657. declare module BABYLON {
  130658. /**
  130659. * Class containing static functions to help procedurally build meshes
  130660. */
  130661. export class RibbonBuilder {
  130662. /**
  130663. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  130664. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  130665. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  130666. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  130667. * * 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
  130668. * * 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
  130669. * * 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
  130670. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130671. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130672. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130673. * * 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
  130674. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  130675. * * 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
  130676. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  130677. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130678. * @param name defines the name of the mesh
  130679. * @param options defines the options used to create the mesh
  130680. * @param scene defines the hosting scene
  130681. * @returns the ribbon mesh
  130682. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  130683. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130684. */
  130685. static CreateRibbon(name: string, options: {
  130686. pathArray: Vector3[][];
  130687. closeArray?: boolean;
  130688. closePath?: boolean;
  130689. offset?: number;
  130690. updatable?: boolean;
  130691. sideOrientation?: number;
  130692. frontUVs?: Vector4;
  130693. backUVs?: Vector4;
  130694. instance?: Mesh;
  130695. invertUV?: boolean;
  130696. uvs?: Vector2[];
  130697. colors?: Color4[];
  130698. }, scene?: Nullable<Scene>): Mesh;
  130699. }
  130700. }
  130701. declare module BABYLON {
  130702. /**
  130703. * Class containing static functions to help procedurally build meshes
  130704. */
  130705. export class ShapeBuilder {
  130706. /**
  130707. * 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.
  130708. * * 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.
  130709. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130710. * * 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.
  130711. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  130712. * * 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
  130713. * * 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
  130714. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  130715. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130716. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130717. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  130718. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  130719. * @param name defines the name of the mesh
  130720. * @param options defines the options used to create the mesh
  130721. * @param scene defines the hosting scene
  130722. * @returns the extruded shape mesh
  130723. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130724. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130725. */
  130726. static ExtrudeShape(name: string, options: {
  130727. shape: Vector3[];
  130728. path: Vector3[];
  130729. scale?: number;
  130730. rotation?: number;
  130731. cap?: number;
  130732. updatable?: boolean;
  130733. sideOrientation?: number;
  130734. frontUVs?: Vector4;
  130735. backUVs?: Vector4;
  130736. instance?: Mesh;
  130737. invertUV?: boolean;
  130738. }, scene?: Nullable<Scene>): Mesh;
  130739. /**
  130740. * Creates an custom extruded shape mesh.
  130741. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  130742. * * 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.
  130743. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130744. * * 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
  130745. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  130746. * * 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
  130747. * * It must returns a float value that will be the scale value applied to the shape on each path point
  130748. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  130749. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  130750. * * 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
  130751. * * 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
  130752. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  130753. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130754. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130755. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130756. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130757. * @param name defines the name of the mesh
  130758. * @param options defines the options used to create the mesh
  130759. * @param scene defines the hosting scene
  130760. * @returns the custom extruded shape mesh
  130761. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  130762. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130763. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130764. */
  130765. static ExtrudeShapeCustom(name: string, options: {
  130766. shape: Vector3[];
  130767. path: Vector3[];
  130768. scaleFunction?: any;
  130769. rotationFunction?: any;
  130770. ribbonCloseArray?: boolean;
  130771. ribbonClosePath?: boolean;
  130772. cap?: number;
  130773. updatable?: boolean;
  130774. sideOrientation?: number;
  130775. frontUVs?: Vector4;
  130776. backUVs?: Vector4;
  130777. instance?: Mesh;
  130778. invertUV?: boolean;
  130779. }, scene?: Nullable<Scene>): Mesh;
  130780. private static _ExtrudeShapeGeneric;
  130781. }
  130782. }
  130783. declare module BABYLON.Debug {
  130784. /**
  130785. * Class used to render a debug view of a given skeleton
  130786. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  130787. */
  130788. export class SkeletonViewer {
  130789. /** defines the skeleton to render */
  130790. skeleton: Skeleton;
  130791. /** defines the mesh attached to the skeleton */
  130792. mesh: AbstractMesh;
  130793. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130794. autoUpdateBonesMatrices: boolean;
  130795. /** defines the rendering group id to use with the viewer */
  130796. renderingGroupId: number;
  130797. /** is the options for the viewer */
  130798. options: Partial<ISkeletonViewerOptions>;
  130799. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  130800. static readonly DISPLAY_LINES: number;
  130801. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  130802. static readonly DISPLAY_SPHERES: number;
  130803. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  130804. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  130805. /** If SkeletonViewer scene scope. */
  130806. private _scene;
  130807. /** Gets or sets the color used to render the skeleton */
  130808. color: Color3;
  130809. /** Array of the points of the skeleton fo the line view. */
  130810. private _debugLines;
  130811. /** The SkeletonViewers Mesh. */
  130812. private _debugMesh;
  130813. /** If SkeletonViewer is enabled. */
  130814. private _isEnabled;
  130815. /** If SkeletonViewer is ready. */
  130816. private _ready;
  130817. /** SkeletonViewer render observable. */
  130818. private _obs;
  130819. /** The Utility Layer to render the gizmos in. */
  130820. private _utilityLayer;
  130821. private _boneIndices;
  130822. /** Gets the Scene. */
  130823. get scene(): Scene;
  130824. /** Gets the utilityLayer. */
  130825. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  130826. /** Checks Ready Status. */
  130827. get isReady(): Boolean;
  130828. /** Sets Ready Status. */
  130829. set ready(value: boolean);
  130830. /** Gets the debugMesh */
  130831. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  130832. /** Sets the debugMesh */
  130833. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  130834. /** Gets the material */
  130835. get material(): StandardMaterial;
  130836. /** Sets the material */
  130837. set material(value: StandardMaterial);
  130838. /** Gets the material */
  130839. get displayMode(): number;
  130840. /** Sets the material */
  130841. set displayMode(value: number);
  130842. /**
  130843. * Creates a new SkeletonViewer
  130844. * @param skeleton defines the skeleton to render
  130845. * @param mesh defines the mesh attached to the skeleton
  130846. * @param scene defines the hosting scene
  130847. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  130848. * @param renderingGroupId defines the rendering group id to use with the viewer
  130849. * @param options All of the extra constructor options for the SkeletonViewer
  130850. */
  130851. constructor(
  130852. /** defines the skeleton to render */
  130853. skeleton: Skeleton,
  130854. /** defines the mesh attached to the skeleton */
  130855. mesh: AbstractMesh,
  130856. /** The Scene scope*/
  130857. scene: Scene,
  130858. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130859. autoUpdateBonesMatrices?: boolean,
  130860. /** defines the rendering group id to use with the viewer */
  130861. renderingGroupId?: number,
  130862. /** is the options for the viewer */
  130863. options?: Partial<ISkeletonViewerOptions>);
  130864. /** The Dynamic bindings for the update functions */
  130865. private _bindObs;
  130866. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  130867. update(): void;
  130868. /** Gets or sets a boolean indicating if the viewer is enabled */
  130869. set isEnabled(value: boolean);
  130870. get isEnabled(): boolean;
  130871. private _getBonePosition;
  130872. private _getLinesForBonesWithLength;
  130873. private _getLinesForBonesNoLength;
  130874. /** function to revert the mesh and scene back to the initial state. */
  130875. private _revert;
  130876. /** function to build and bind sphere joint points and spur bone representations. */
  130877. private _buildSpheresAndSpurs;
  130878. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  130879. private _displayLinesUpdate;
  130880. /** Changes the displayMode of the skeleton viewer
  130881. * @param mode The displayMode numerical value
  130882. */
  130883. changeDisplayMode(mode: number): void;
  130884. /** Changes the displayMode of the skeleton viewer
  130885. * @param option String of the option name
  130886. * @param value The numerical option value
  130887. */
  130888. changeDisplayOptions(option: string, value: number): void;
  130889. /** Release associated resources */
  130890. dispose(): void;
  130891. }
  130892. }
  130893. declare module BABYLON {
  130894. /**
  130895. * Enum for Device Types
  130896. */
  130897. export enum DeviceType {
  130898. /** Generic */
  130899. Generic = 0,
  130900. /** Keyboard */
  130901. Keyboard = 1,
  130902. /** Mouse */
  130903. Mouse = 2,
  130904. /** Touch Pointers */
  130905. Touch = 3,
  130906. /** PS4 Dual Shock */
  130907. DualShock = 4,
  130908. /** Xbox */
  130909. Xbox = 5,
  130910. /** Switch Controller */
  130911. Switch = 6
  130912. }
  130913. /**
  130914. * Enum for All Pointers (Touch/Mouse)
  130915. */
  130916. export enum PointerInput {
  130917. /** Horizontal Axis */
  130918. Horizontal = 0,
  130919. /** Vertical Axis */
  130920. Vertical = 1,
  130921. /** Left Click or Touch */
  130922. LeftClick = 2,
  130923. /** Middle Click */
  130924. MiddleClick = 3,
  130925. /** Right Click */
  130926. RightClick = 4,
  130927. /** Browser Back */
  130928. BrowserBack = 5,
  130929. /** Browser Forward */
  130930. BrowserForward = 6
  130931. }
  130932. /**
  130933. * Enum for Dual Shock Gamepad
  130934. */
  130935. export enum DualShockInput {
  130936. /** Cross */
  130937. Cross = 0,
  130938. /** Circle */
  130939. Circle = 1,
  130940. /** Square */
  130941. Square = 2,
  130942. /** Triangle */
  130943. Triangle = 3,
  130944. /** L1 */
  130945. L1 = 4,
  130946. /** R1 */
  130947. R1 = 5,
  130948. /** L2 */
  130949. L2 = 6,
  130950. /** R2 */
  130951. R2 = 7,
  130952. /** Share */
  130953. Share = 8,
  130954. /** Options */
  130955. Options = 9,
  130956. /** L3 */
  130957. L3 = 10,
  130958. /** R3 */
  130959. R3 = 11,
  130960. /** DPadUp */
  130961. DPadUp = 12,
  130962. /** DPadDown */
  130963. DPadDown = 13,
  130964. /** DPadLeft */
  130965. DPadLeft = 14,
  130966. /** DRight */
  130967. DPadRight = 15,
  130968. /** Home */
  130969. Home = 16,
  130970. /** TouchPad */
  130971. TouchPad = 17,
  130972. /** LStickXAxis */
  130973. LStickXAxis = 18,
  130974. /** LStickYAxis */
  130975. LStickYAxis = 19,
  130976. /** RStickXAxis */
  130977. RStickXAxis = 20,
  130978. /** RStickYAxis */
  130979. RStickYAxis = 21
  130980. }
  130981. /**
  130982. * Enum for Xbox Gamepad
  130983. */
  130984. export enum XboxInput {
  130985. /** A */
  130986. A = 0,
  130987. /** B */
  130988. B = 1,
  130989. /** X */
  130990. X = 2,
  130991. /** Y */
  130992. Y = 3,
  130993. /** LB */
  130994. LB = 4,
  130995. /** RB */
  130996. RB = 5,
  130997. /** LT */
  130998. LT = 6,
  130999. /** RT */
  131000. RT = 7,
  131001. /** Back */
  131002. Back = 8,
  131003. /** Start */
  131004. Start = 9,
  131005. /** LS */
  131006. LS = 10,
  131007. /** RS */
  131008. RS = 11,
  131009. /** DPadUp */
  131010. DPadUp = 12,
  131011. /** DPadDown */
  131012. DPadDown = 13,
  131013. /** DPadLeft */
  131014. DPadLeft = 14,
  131015. /** DRight */
  131016. DPadRight = 15,
  131017. /** Home */
  131018. Home = 16,
  131019. /** LStickXAxis */
  131020. LStickXAxis = 17,
  131021. /** LStickYAxis */
  131022. LStickYAxis = 18,
  131023. /** RStickXAxis */
  131024. RStickXAxis = 19,
  131025. /** RStickYAxis */
  131026. RStickYAxis = 20
  131027. }
  131028. /**
  131029. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  131030. */
  131031. export enum SwitchInput {
  131032. /** B */
  131033. B = 0,
  131034. /** A */
  131035. A = 1,
  131036. /** Y */
  131037. Y = 2,
  131038. /** X */
  131039. X = 3,
  131040. /** L */
  131041. L = 4,
  131042. /** R */
  131043. R = 5,
  131044. /** ZL */
  131045. ZL = 6,
  131046. /** ZR */
  131047. ZR = 7,
  131048. /** Minus */
  131049. Minus = 8,
  131050. /** Plus */
  131051. Plus = 9,
  131052. /** LS */
  131053. LS = 10,
  131054. /** RS */
  131055. RS = 11,
  131056. /** DPadUp */
  131057. DPadUp = 12,
  131058. /** DPadDown */
  131059. DPadDown = 13,
  131060. /** DPadLeft */
  131061. DPadLeft = 14,
  131062. /** DRight */
  131063. DPadRight = 15,
  131064. /** Home */
  131065. Home = 16,
  131066. /** Capture */
  131067. Capture = 17,
  131068. /** LStickXAxis */
  131069. LStickXAxis = 18,
  131070. /** LStickYAxis */
  131071. LStickYAxis = 19,
  131072. /** RStickXAxis */
  131073. RStickXAxis = 20,
  131074. /** RStickYAxis */
  131075. RStickYAxis = 21
  131076. }
  131077. }
  131078. declare module BABYLON {
  131079. /**
  131080. * This class will take all inputs from Keyboard, Pointer, and
  131081. * any Gamepads and provide a polling system that all devices
  131082. * will use. This class assumes that there will only be one
  131083. * pointer device and one keyboard.
  131084. */
  131085. export class DeviceInputSystem implements IDisposable {
  131086. /**
  131087. * Callback to be triggered when a device is connected
  131088. */
  131089. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131090. /**
  131091. * Callback to be triggered when a device is disconnected
  131092. */
  131093. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131094. /**
  131095. * Callback to be triggered when event driven input is updated
  131096. */
  131097. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  131098. private _inputs;
  131099. private _gamepads;
  131100. private _keyboardActive;
  131101. private _pointerActive;
  131102. private _elementToAttachTo;
  131103. private _keyboardDownEvent;
  131104. private _keyboardUpEvent;
  131105. private _pointerMoveEvent;
  131106. private _pointerDownEvent;
  131107. private _pointerUpEvent;
  131108. private _gamepadConnectedEvent;
  131109. private _gamepadDisconnectedEvent;
  131110. private static _MAX_KEYCODES;
  131111. private static _MAX_POINTER_INPUTS;
  131112. private constructor();
  131113. /**
  131114. * Creates a new DeviceInputSystem instance
  131115. * @param engine Engine to pull input element from
  131116. * @returns The new instance
  131117. */
  131118. static Create(engine: Engine): DeviceInputSystem;
  131119. /**
  131120. * Checks for current device input value, given an id and input index
  131121. * @param deviceName Id of connected device
  131122. * @param inputIndex Index of device input
  131123. * @returns Current value of input
  131124. */
  131125. /**
  131126. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  131127. * @param deviceType Enum specifiying device type
  131128. * @param deviceSlot "Slot" or index that device is referenced in
  131129. * @param inputIndex Id of input to be checked
  131130. * @returns Current value of input
  131131. */
  131132. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  131133. /**
  131134. * Dispose of all the eventlisteners
  131135. */
  131136. dispose(): void;
  131137. /**
  131138. * Add device and inputs to device array
  131139. * @param deviceType Enum specifiying device type
  131140. * @param deviceSlot "Slot" or index that device is referenced in
  131141. * @param numberOfInputs Number of input entries to create for given device
  131142. */
  131143. private _registerDevice;
  131144. /**
  131145. * Given a specific device name, remove that device from the device map
  131146. * @param deviceType Enum specifiying device type
  131147. * @param deviceSlot "Slot" or index that device is referenced in
  131148. */
  131149. private _unregisterDevice;
  131150. /**
  131151. * Handle all actions that come from keyboard interaction
  131152. */
  131153. private _handleKeyActions;
  131154. /**
  131155. * Handle all actions that come from pointer interaction
  131156. */
  131157. private _handlePointerActions;
  131158. /**
  131159. * Handle all actions that come from gamepad interaction
  131160. */
  131161. private _handleGamepadActions;
  131162. /**
  131163. * Update all non-event based devices with each frame
  131164. * @param deviceType Enum specifiying device type
  131165. * @param deviceSlot "Slot" or index that device is referenced in
  131166. * @param inputIndex Id of input to be checked
  131167. */
  131168. private _updateDevice;
  131169. /**
  131170. * Gets DeviceType from the device name
  131171. * @param deviceName Name of Device from DeviceInputSystem
  131172. * @returns DeviceType enum value
  131173. */
  131174. private _getGamepadDeviceType;
  131175. }
  131176. }
  131177. declare module BABYLON {
  131178. /**
  131179. * Type to handle enforcement of inputs
  131180. */
  131181. 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;
  131182. }
  131183. declare module BABYLON {
  131184. /**
  131185. * Class that handles all input for a specific device
  131186. */
  131187. export class DeviceSource<T extends DeviceType> {
  131188. /** Type of device */
  131189. readonly deviceType: DeviceType;
  131190. /** "Slot" or index that device is referenced in */
  131191. readonly deviceSlot: number;
  131192. /**
  131193. * Observable to handle device input changes per device
  131194. */
  131195. readonly onInputChangedObservable: Observable<{
  131196. inputIndex: DeviceInput<T>;
  131197. previousState: Nullable<number>;
  131198. currentState: Nullable<number>;
  131199. }>;
  131200. private readonly _deviceInputSystem;
  131201. /**
  131202. * Default Constructor
  131203. * @param deviceInputSystem Reference to DeviceInputSystem
  131204. * @param deviceType Type of device
  131205. * @param deviceSlot "Slot" or index that device is referenced in
  131206. */
  131207. constructor(deviceInputSystem: DeviceInputSystem,
  131208. /** Type of device */
  131209. deviceType: DeviceType,
  131210. /** "Slot" or index that device is referenced in */
  131211. deviceSlot?: number);
  131212. /**
  131213. * Get input for specific input
  131214. * @param inputIndex index of specific input on device
  131215. * @returns Input value from DeviceInputSystem
  131216. */
  131217. getInput(inputIndex: DeviceInput<T>): number;
  131218. }
  131219. /**
  131220. * Class to keep track of devices
  131221. */
  131222. export class DeviceSourceManager implements IDisposable {
  131223. /**
  131224. * Observable to be triggered when before a device is connected
  131225. */
  131226. readonly onBeforeDeviceConnectedObservable: Observable<{
  131227. deviceType: DeviceType;
  131228. deviceSlot: number;
  131229. }>;
  131230. /**
  131231. * Observable to be triggered when before a device is disconnected
  131232. */
  131233. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  131234. deviceType: DeviceType;
  131235. deviceSlot: number;
  131236. }>;
  131237. /**
  131238. * Observable to be triggered when after a device is connected
  131239. */
  131240. readonly onAfterDeviceConnectedObservable: Observable<{
  131241. deviceType: DeviceType;
  131242. deviceSlot: number;
  131243. }>;
  131244. /**
  131245. * Observable to be triggered when after a device is disconnected
  131246. */
  131247. readonly onAfterDeviceDisconnectedObservable: Observable<{
  131248. deviceType: DeviceType;
  131249. deviceSlot: number;
  131250. }>;
  131251. private readonly _devices;
  131252. private readonly _firstDevice;
  131253. private readonly _deviceInputSystem;
  131254. /**
  131255. * Default Constructor
  131256. * @param engine engine to pull input element from
  131257. */
  131258. constructor(engine: Engine);
  131259. /**
  131260. * Gets a DeviceSource, given a type and slot
  131261. * @param deviceType Enum specifying device type
  131262. * @param deviceSlot "Slot" or index that device is referenced in
  131263. * @returns DeviceSource object
  131264. */
  131265. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  131266. /**
  131267. * Gets an array of DeviceSource objects for a given device type
  131268. * @param deviceType Enum specifying device type
  131269. * @returns Array of DeviceSource objects
  131270. */
  131271. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  131272. /**
  131273. * Dispose of DeviceInputSystem and other parts
  131274. */
  131275. dispose(): void;
  131276. /**
  131277. * Function to add device name to device list
  131278. * @param deviceType Enum specifying device type
  131279. * @param deviceSlot "Slot" or index that device is referenced in
  131280. */
  131281. private _addDevice;
  131282. /**
  131283. * Function to remove device name to device list
  131284. * @param deviceType Enum specifying device type
  131285. * @param deviceSlot "Slot" or index that device is referenced in
  131286. */
  131287. private _removeDevice;
  131288. /**
  131289. * Updates array storing first connected device of each type
  131290. * @param type Type of Device
  131291. */
  131292. private _updateFirstDevices;
  131293. }
  131294. }
  131295. declare module BABYLON {
  131296. /**
  131297. * Options to create the null engine
  131298. */
  131299. export class NullEngineOptions {
  131300. /**
  131301. * Render width (Default: 512)
  131302. */
  131303. renderWidth: number;
  131304. /**
  131305. * Render height (Default: 256)
  131306. */
  131307. renderHeight: number;
  131308. /**
  131309. * Texture size (Default: 512)
  131310. */
  131311. textureSize: number;
  131312. /**
  131313. * If delta time between frames should be constant
  131314. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131315. */
  131316. deterministicLockstep: boolean;
  131317. /**
  131318. * Maximum about of steps between frames (Default: 4)
  131319. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131320. */
  131321. lockstepMaxSteps: number;
  131322. /**
  131323. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  131324. */
  131325. useHighPrecisionMatrix?: boolean;
  131326. }
  131327. /**
  131328. * The null engine class provides support for headless version of babylon.js.
  131329. * This can be used in server side scenario or for testing purposes
  131330. */
  131331. export class NullEngine extends Engine {
  131332. private _options;
  131333. /**
  131334. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  131335. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131336. * @returns true if engine is in deterministic lock step mode
  131337. */
  131338. isDeterministicLockStep(): boolean;
  131339. /**
  131340. * Gets the max steps when engine is running in deterministic lock step
  131341. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131342. * @returns the max steps
  131343. */
  131344. getLockstepMaxSteps(): number;
  131345. /**
  131346. * Gets the current hardware scaling level.
  131347. * By default the hardware scaling level is computed from the window device ratio.
  131348. * 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.
  131349. * @returns a number indicating the current hardware scaling level
  131350. */
  131351. getHardwareScalingLevel(): number;
  131352. constructor(options?: NullEngineOptions);
  131353. /**
  131354. * Creates a vertex buffer
  131355. * @param vertices the data for the vertex buffer
  131356. * @returns the new WebGL static buffer
  131357. */
  131358. createVertexBuffer(vertices: FloatArray): DataBuffer;
  131359. /**
  131360. * Creates a new index buffer
  131361. * @param indices defines the content of the index buffer
  131362. * @param updatable defines if the index buffer must be updatable
  131363. * @returns a new webGL buffer
  131364. */
  131365. createIndexBuffer(indices: IndicesArray): DataBuffer;
  131366. /**
  131367. * Clear the current render buffer or the current render target (if any is set up)
  131368. * @param color defines the color to use
  131369. * @param backBuffer defines if the back buffer must be cleared
  131370. * @param depth defines if the depth buffer must be cleared
  131371. * @param stencil defines if the stencil buffer must be cleared
  131372. */
  131373. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  131374. /**
  131375. * Gets the current render width
  131376. * @param useScreen defines if screen size must be used (or the current render target if any)
  131377. * @returns a number defining the current render width
  131378. */
  131379. getRenderWidth(useScreen?: boolean): number;
  131380. /**
  131381. * Gets the current render height
  131382. * @param useScreen defines if screen size must be used (or the current render target if any)
  131383. * @returns a number defining the current render height
  131384. */
  131385. getRenderHeight(useScreen?: boolean): number;
  131386. /**
  131387. * Set the WebGL's viewport
  131388. * @param viewport defines the viewport element to be used
  131389. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  131390. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  131391. */
  131392. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  131393. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  131394. /**
  131395. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  131396. * @param pipelineContext defines the pipeline context to use
  131397. * @param uniformsNames defines the list of uniform names
  131398. * @returns an array of webGL uniform locations
  131399. */
  131400. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  131401. /**
  131402. * Gets the lsit of active attributes for a given webGL program
  131403. * @param pipelineContext defines the pipeline context to use
  131404. * @param attributesNames defines the list of attribute names to get
  131405. * @returns an array of indices indicating the offset of each attribute
  131406. */
  131407. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  131408. /**
  131409. * Binds an effect to the webGL context
  131410. * @param effect defines the effect to bind
  131411. */
  131412. bindSamplers(effect: Effect): void;
  131413. /**
  131414. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  131415. * @param effect defines the effect to activate
  131416. */
  131417. enableEffect(effect: Effect): void;
  131418. /**
  131419. * Set various states to the webGL context
  131420. * @param culling defines backface culling state
  131421. * @param zOffset defines the value to apply to zOffset (0 by default)
  131422. * @param force defines if states must be applied even if cache is up to date
  131423. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  131424. */
  131425. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  131426. /**
  131427. * Set the value of an uniform to an array of int32
  131428. * @param uniform defines the webGL uniform location where to store the value
  131429. * @param array defines the array of int32 to store
  131430. */
  131431. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  131432. /**
  131433. * Set the value of an uniform to an array of int32 (stored as vec2)
  131434. * @param uniform defines the webGL uniform location where to store the value
  131435. * @param array defines the array of int32 to store
  131436. */
  131437. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  131438. /**
  131439. * Set the value of an uniform to an array of int32 (stored as vec3)
  131440. * @param uniform defines the webGL uniform location where to store the value
  131441. * @param array defines the array of int32 to store
  131442. */
  131443. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  131444. /**
  131445. * Set the value of an uniform to an array of int32 (stored as vec4)
  131446. * @param uniform defines the webGL uniform location where to store the value
  131447. * @param array defines the array of int32 to store
  131448. */
  131449. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  131450. /**
  131451. * Set the value of an uniform to an array of float32
  131452. * @param uniform defines the webGL uniform location where to store the value
  131453. * @param array defines the array of float32 to store
  131454. */
  131455. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  131456. /**
  131457. * Set the value of an uniform to an array of float32 (stored as vec2)
  131458. * @param uniform defines the webGL uniform location where to store the value
  131459. * @param array defines the array of float32 to store
  131460. */
  131461. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  131462. /**
  131463. * Set the value of an uniform to an array of float32 (stored as vec3)
  131464. * @param uniform defines the webGL uniform location where to store the value
  131465. * @param array defines the array of float32 to store
  131466. */
  131467. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  131468. /**
  131469. * Set the value of an uniform to an array of float32 (stored as vec4)
  131470. * @param uniform defines the webGL uniform location where to store the value
  131471. * @param array defines the array of float32 to store
  131472. */
  131473. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  131474. /**
  131475. * Set the value of an uniform to an array of number
  131476. * @param uniform defines the webGL uniform location where to store the value
  131477. * @param array defines the array of number to store
  131478. */
  131479. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  131480. /**
  131481. * Set the value of an uniform to an array of number (stored as vec2)
  131482. * @param uniform defines the webGL uniform location where to store the value
  131483. * @param array defines the array of number to store
  131484. */
  131485. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  131486. /**
  131487. * Set the value of an uniform to an array of number (stored as vec3)
  131488. * @param uniform defines the webGL uniform location where to store the value
  131489. * @param array defines the array of number to store
  131490. */
  131491. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  131492. /**
  131493. * Set the value of an uniform to an array of number (stored as vec4)
  131494. * @param uniform defines the webGL uniform location where to store the value
  131495. * @param array defines the array of number to store
  131496. */
  131497. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  131498. /**
  131499. * Set the value of an uniform to an array of float32 (stored as matrices)
  131500. * @param uniform defines the webGL uniform location where to store the value
  131501. * @param matrices defines the array of float32 to store
  131502. */
  131503. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  131504. /**
  131505. * Set the value of an uniform to a matrix (3x3)
  131506. * @param uniform defines the webGL uniform location where to store the value
  131507. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  131508. */
  131509. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131510. /**
  131511. * Set the value of an uniform to a matrix (2x2)
  131512. * @param uniform defines the webGL uniform location where to store the value
  131513. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  131514. */
  131515. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131516. /**
  131517. * Set the value of an uniform to a number (float)
  131518. * @param uniform defines the webGL uniform location where to store the value
  131519. * @param value defines the float number to store
  131520. */
  131521. setFloat(uniform: WebGLUniformLocation, value: number): void;
  131522. /**
  131523. * Set the value of an uniform to a vec2
  131524. * @param uniform defines the webGL uniform location where to store the value
  131525. * @param x defines the 1st component of the value
  131526. * @param y defines the 2nd component of the value
  131527. */
  131528. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  131529. /**
  131530. * Set the value of an uniform to a vec3
  131531. * @param uniform defines the webGL uniform location where to store the value
  131532. * @param x defines the 1st component of the value
  131533. * @param y defines the 2nd component of the value
  131534. * @param z defines the 3rd component of the value
  131535. */
  131536. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  131537. /**
  131538. * Set the value of an uniform to a boolean
  131539. * @param uniform defines the webGL uniform location where to store the value
  131540. * @param bool defines the boolean to store
  131541. */
  131542. setBool(uniform: WebGLUniformLocation, bool: number): void;
  131543. /**
  131544. * Set the value of an uniform to a vec4
  131545. * @param uniform defines the webGL uniform location where to store the value
  131546. * @param x defines the 1st component of the value
  131547. * @param y defines the 2nd component of the value
  131548. * @param z defines the 3rd component of the value
  131549. * @param w defines the 4th component of the value
  131550. */
  131551. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  131552. /**
  131553. * Sets the current alpha mode
  131554. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  131555. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  131556. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  131557. */
  131558. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  131559. /**
  131560. * Bind webGl buffers directly to the webGL context
  131561. * @param vertexBuffers defines the vertex buffer to bind
  131562. * @param indexBuffer defines the index buffer to bind
  131563. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  131564. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  131565. * @param effect defines the effect associated with the vertex buffer
  131566. */
  131567. bindBuffers(vertexBuffers: {
  131568. [key: string]: VertexBuffer;
  131569. }, indexBuffer: DataBuffer, effect: Effect): void;
  131570. /**
  131571. * Force the entire cache to be cleared
  131572. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  131573. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  131574. */
  131575. wipeCaches(bruteForce?: boolean): void;
  131576. /**
  131577. * Send a draw order
  131578. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  131579. * @param indexStart defines the starting index
  131580. * @param indexCount defines the number of index to draw
  131581. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131582. */
  131583. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  131584. /**
  131585. * Draw a list of indexed primitives
  131586. * @param fillMode defines the primitive to use
  131587. * @param indexStart defines the starting index
  131588. * @param indexCount defines the number of index to draw
  131589. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131590. */
  131591. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  131592. /**
  131593. * Draw a list of unindexed primitives
  131594. * @param fillMode defines the primitive to use
  131595. * @param verticesStart defines the index of first vertex to draw
  131596. * @param verticesCount defines the count of vertices to draw
  131597. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131598. */
  131599. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  131600. /** @hidden */
  131601. _createTexture(): WebGLTexture;
  131602. /** @hidden */
  131603. _releaseTexture(texture: InternalTexture): void;
  131604. /**
  131605. * Usually called from Texture.ts.
  131606. * Passed information to create a WebGLTexture
  131607. * @param urlArg defines a value which contains one of the following:
  131608. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  131609. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  131610. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  131611. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  131612. * @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)
  131613. * @param scene needed for loading to the correct scene
  131614. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  131615. * @param onLoad optional callback to be called upon successful completion
  131616. * @param onError optional callback to be called upon failure
  131617. * @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
  131618. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  131619. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  131620. * @param forcedExtension defines the extension to use to pick the right loader
  131621. * @param mimeType defines an optional mime type
  131622. * @returns a InternalTexture for assignment back into BABYLON.Texture
  131623. */
  131624. 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;
  131625. /**
  131626. * Creates a new render target texture
  131627. * @param size defines the size of the texture
  131628. * @param options defines the options used to create the texture
  131629. * @returns a new render target texture stored in an InternalTexture
  131630. */
  131631. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  131632. /**
  131633. * Update the sampling mode of a given texture
  131634. * @param samplingMode defines the required sampling mode
  131635. * @param texture defines the texture to update
  131636. */
  131637. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  131638. /**
  131639. * Binds the frame buffer to the specified texture.
  131640. * @param texture The texture to render to or null for the default canvas
  131641. * @param faceIndex The face of the texture to render to in case of cube texture
  131642. * @param requiredWidth The width of the target to render to
  131643. * @param requiredHeight The height of the target to render to
  131644. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  131645. * @param lodLevel defines le lod level to bind to the frame buffer
  131646. */
  131647. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  131648. /**
  131649. * Unbind the current render target texture from the webGL context
  131650. * @param texture defines the render target texture to unbind
  131651. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  131652. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  131653. */
  131654. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  131655. /**
  131656. * Creates a dynamic vertex buffer
  131657. * @param vertices the data for the dynamic vertex buffer
  131658. * @returns the new WebGL dynamic buffer
  131659. */
  131660. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  131661. /**
  131662. * Update the content of a dynamic texture
  131663. * @param texture defines the texture to update
  131664. * @param canvas defines the canvas containing the source
  131665. * @param invertY defines if data must be stored with Y axis inverted
  131666. * @param premulAlpha defines if alpha is stored as premultiplied
  131667. * @param format defines the format of the data
  131668. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  131669. */
  131670. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  131671. /**
  131672. * Gets a boolean indicating if all created effects are ready
  131673. * @returns true if all effects are ready
  131674. */
  131675. areAllEffectsReady(): boolean;
  131676. /**
  131677. * @hidden
  131678. * Get the current error code of the webGL context
  131679. * @returns the error code
  131680. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  131681. */
  131682. getError(): number;
  131683. /** @hidden */
  131684. _getUnpackAlignement(): number;
  131685. /** @hidden */
  131686. _unpackFlipY(value: boolean): void;
  131687. /**
  131688. * Update a dynamic index buffer
  131689. * @param indexBuffer defines the target index buffer
  131690. * @param indices defines the data to update
  131691. * @param offset defines the offset in the target index buffer where update should start
  131692. */
  131693. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  131694. /**
  131695. * Updates a dynamic vertex buffer.
  131696. * @param vertexBuffer the vertex buffer to update
  131697. * @param vertices the data used to update the vertex buffer
  131698. * @param byteOffset the byte offset of the data (optional)
  131699. * @param byteLength the byte length of the data (optional)
  131700. */
  131701. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  131702. /** @hidden */
  131703. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  131704. /** @hidden */
  131705. _bindTexture(channel: number, texture: InternalTexture): void;
  131706. protected _deleteBuffer(buffer: WebGLBuffer): void;
  131707. /**
  131708. * 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
  131709. */
  131710. releaseEffects(): void;
  131711. displayLoadingUI(): void;
  131712. hideLoadingUI(): void;
  131713. /** @hidden */
  131714. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131715. /** @hidden */
  131716. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131717. /** @hidden */
  131718. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131719. /** @hidden */
  131720. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  131721. }
  131722. }
  131723. declare module BABYLON {
  131724. /**
  131725. * @hidden
  131726. **/
  131727. export class _TimeToken {
  131728. _startTimeQuery: Nullable<WebGLQuery>;
  131729. _endTimeQuery: Nullable<WebGLQuery>;
  131730. _timeElapsedQuery: Nullable<WebGLQuery>;
  131731. _timeElapsedQueryEnded: boolean;
  131732. }
  131733. }
  131734. declare module BABYLON {
  131735. /** @hidden */
  131736. export class _OcclusionDataStorage {
  131737. /** @hidden */
  131738. occlusionInternalRetryCounter: number;
  131739. /** @hidden */
  131740. isOcclusionQueryInProgress: boolean;
  131741. /** @hidden */
  131742. isOccluded: boolean;
  131743. /** @hidden */
  131744. occlusionRetryCount: number;
  131745. /** @hidden */
  131746. occlusionType: number;
  131747. /** @hidden */
  131748. occlusionQueryAlgorithmType: number;
  131749. }
  131750. interface Engine {
  131751. /**
  131752. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  131753. * @return the new query
  131754. */
  131755. createQuery(): WebGLQuery;
  131756. /**
  131757. * Delete and release a webGL query
  131758. * @param query defines the query to delete
  131759. * @return the current engine
  131760. */
  131761. deleteQuery(query: WebGLQuery): Engine;
  131762. /**
  131763. * Check if a given query has resolved and got its value
  131764. * @param query defines the query to check
  131765. * @returns true if the query got its value
  131766. */
  131767. isQueryResultAvailable(query: WebGLQuery): boolean;
  131768. /**
  131769. * Gets the value of a given query
  131770. * @param query defines the query to check
  131771. * @returns the value of the query
  131772. */
  131773. getQueryResult(query: WebGLQuery): number;
  131774. /**
  131775. * Initiates an occlusion query
  131776. * @param algorithmType defines the algorithm to use
  131777. * @param query defines the query to use
  131778. * @returns the current engine
  131779. * @see https://doc.babylonjs.com/features/occlusionquery
  131780. */
  131781. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  131782. /**
  131783. * Ends an occlusion query
  131784. * @see https://doc.babylonjs.com/features/occlusionquery
  131785. * @param algorithmType defines the algorithm to use
  131786. * @returns the current engine
  131787. */
  131788. endOcclusionQuery(algorithmType: number): Engine;
  131789. /**
  131790. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  131791. * Please note that only one query can be issued at a time
  131792. * @returns a time token used to track the time span
  131793. */
  131794. startTimeQuery(): Nullable<_TimeToken>;
  131795. /**
  131796. * Ends a time query
  131797. * @param token defines the token used to measure the time span
  131798. * @returns the time spent (in ns)
  131799. */
  131800. endTimeQuery(token: _TimeToken): int;
  131801. /** @hidden */
  131802. _currentNonTimestampToken: Nullable<_TimeToken>;
  131803. /** @hidden */
  131804. _createTimeQuery(): WebGLQuery;
  131805. /** @hidden */
  131806. _deleteTimeQuery(query: WebGLQuery): void;
  131807. /** @hidden */
  131808. _getGlAlgorithmType(algorithmType: number): number;
  131809. /** @hidden */
  131810. _getTimeQueryResult(query: WebGLQuery): any;
  131811. /** @hidden */
  131812. _getTimeQueryAvailability(query: WebGLQuery): any;
  131813. }
  131814. interface AbstractMesh {
  131815. /**
  131816. * Backing filed
  131817. * @hidden
  131818. */
  131819. __occlusionDataStorage: _OcclusionDataStorage;
  131820. /**
  131821. * Access property
  131822. * @hidden
  131823. */
  131824. _occlusionDataStorage: _OcclusionDataStorage;
  131825. /**
  131826. * 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.
  131827. * The default value is -1 which means don't break the query and wait till the result
  131828. * @see https://doc.babylonjs.com/features/occlusionquery
  131829. */
  131830. occlusionRetryCount: number;
  131831. /**
  131832. * 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:
  131833. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  131834. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  131835. * * 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.
  131836. * @see https://doc.babylonjs.com/features/occlusionquery
  131837. */
  131838. occlusionType: number;
  131839. /**
  131840. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  131841. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  131842. * * 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.
  131843. * @see https://doc.babylonjs.com/features/occlusionquery
  131844. */
  131845. occlusionQueryAlgorithmType: number;
  131846. /**
  131847. * 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
  131848. * @see https://doc.babylonjs.com/features/occlusionquery
  131849. */
  131850. isOccluded: boolean;
  131851. /**
  131852. * Flag to check the progress status of the query
  131853. * @see https://doc.babylonjs.com/features/occlusionquery
  131854. */
  131855. isOcclusionQueryInProgress: boolean;
  131856. }
  131857. }
  131858. declare module BABYLON {
  131859. /** @hidden */
  131860. export var _forceTransformFeedbackToBundle: boolean;
  131861. interface Engine {
  131862. /**
  131863. * Creates a webGL transform feedback object
  131864. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  131865. * @returns the webGL transform feedback object
  131866. */
  131867. createTransformFeedback(): WebGLTransformFeedback;
  131868. /**
  131869. * Delete a webGL transform feedback object
  131870. * @param value defines the webGL transform feedback object to delete
  131871. */
  131872. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  131873. /**
  131874. * Bind a webGL transform feedback object to the webgl context
  131875. * @param value defines the webGL transform feedback object to bind
  131876. */
  131877. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  131878. /**
  131879. * Begins a transform feedback operation
  131880. * @param usePoints defines if points or triangles must be used
  131881. */
  131882. beginTransformFeedback(usePoints: boolean): void;
  131883. /**
  131884. * Ends a transform feedback operation
  131885. */
  131886. endTransformFeedback(): void;
  131887. /**
  131888. * Specify the varyings to use with transform feedback
  131889. * @param program defines the associated webGL program
  131890. * @param value defines the list of strings representing the varying names
  131891. */
  131892. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  131893. /**
  131894. * Bind a webGL buffer for a transform feedback operation
  131895. * @param value defines the webGL buffer to bind
  131896. */
  131897. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  131898. }
  131899. }
  131900. declare module BABYLON {
  131901. /**
  131902. * Class used to define an additional view for the engine
  131903. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131904. */
  131905. export class EngineView {
  131906. /** Defines the canvas where to render the view */
  131907. target: HTMLCanvasElement;
  131908. /** Defines an optional camera used to render the view (will use active camera else) */
  131909. camera?: Camera;
  131910. }
  131911. interface Engine {
  131912. /**
  131913. * Gets or sets the HTML element to use for attaching events
  131914. */
  131915. inputElement: Nullable<HTMLElement>;
  131916. /**
  131917. * Gets the current engine view
  131918. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131919. */
  131920. activeView: Nullable<EngineView>;
  131921. /** Gets or sets the list of views */
  131922. views: EngineView[];
  131923. /**
  131924. * Register a new child canvas
  131925. * @param canvas defines the canvas to register
  131926. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  131927. * @returns the associated view
  131928. */
  131929. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  131930. /**
  131931. * Remove a registered child canvas
  131932. * @param canvas defines the canvas to remove
  131933. * @returns the current engine
  131934. */
  131935. unRegisterView(canvas: HTMLCanvasElement): Engine;
  131936. }
  131937. }
  131938. declare module BABYLON {
  131939. interface Engine {
  131940. /** @hidden */
  131941. _excludedCompressedTextures: string[];
  131942. /** @hidden */
  131943. _textureFormatInUse: string;
  131944. /**
  131945. * Gets the list of texture formats supported
  131946. */
  131947. readonly texturesSupported: Array<string>;
  131948. /**
  131949. * Gets the texture format in use
  131950. */
  131951. readonly textureFormatInUse: Nullable<string>;
  131952. /**
  131953. * Set the compressed texture extensions or file names to skip.
  131954. *
  131955. * @param skippedFiles defines the list of those texture files you want to skip
  131956. * Example: [".dds", ".env", "myfile.png"]
  131957. */
  131958. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  131959. /**
  131960. * Set the compressed texture format to use, based on the formats you have, and the formats
  131961. * supported by the hardware / browser.
  131962. *
  131963. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  131964. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  131965. * to API arguments needed to compressed textures. This puts the burden on the container
  131966. * generator to house the arcane code for determining these for current & future formats.
  131967. *
  131968. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  131969. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  131970. *
  131971. * Note: The result of this call is not taken into account when a texture is base64.
  131972. *
  131973. * @param formatsAvailable defines the list of those format families you have created
  131974. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  131975. *
  131976. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  131977. * @returns The extension selected.
  131978. */
  131979. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  131980. }
  131981. }
  131982. declare module BABYLON {
  131983. /**
  131984. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  131985. */
  131986. export interface CubeMapInfo {
  131987. /**
  131988. * The pixel array for the front face.
  131989. * This is stored in format, left to right, up to down format.
  131990. */
  131991. front: Nullable<ArrayBufferView>;
  131992. /**
  131993. * The pixel array for the back face.
  131994. * This is stored in format, left to right, up to down format.
  131995. */
  131996. back: Nullable<ArrayBufferView>;
  131997. /**
  131998. * The pixel array for the left face.
  131999. * This is stored in format, left to right, up to down format.
  132000. */
  132001. left: Nullable<ArrayBufferView>;
  132002. /**
  132003. * The pixel array for the right face.
  132004. * This is stored in format, left to right, up to down format.
  132005. */
  132006. right: Nullable<ArrayBufferView>;
  132007. /**
  132008. * The pixel array for the up face.
  132009. * This is stored in format, left to right, up to down format.
  132010. */
  132011. up: Nullable<ArrayBufferView>;
  132012. /**
  132013. * The pixel array for the down face.
  132014. * This is stored in format, left to right, up to down format.
  132015. */
  132016. down: Nullable<ArrayBufferView>;
  132017. /**
  132018. * The size of the cubemap stored.
  132019. *
  132020. * Each faces will be size * size pixels.
  132021. */
  132022. size: number;
  132023. /**
  132024. * The format of the texture.
  132025. *
  132026. * RGBA, RGB.
  132027. */
  132028. format: number;
  132029. /**
  132030. * The type of the texture data.
  132031. *
  132032. * UNSIGNED_INT, FLOAT.
  132033. */
  132034. type: number;
  132035. /**
  132036. * Specifies whether the texture is in gamma space.
  132037. */
  132038. gammaSpace: boolean;
  132039. }
  132040. /**
  132041. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  132042. */
  132043. export class PanoramaToCubeMapTools {
  132044. private static FACE_LEFT;
  132045. private static FACE_RIGHT;
  132046. private static FACE_FRONT;
  132047. private static FACE_BACK;
  132048. private static FACE_DOWN;
  132049. private static FACE_UP;
  132050. /**
  132051. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  132052. *
  132053. * @param float32Array The source data.
  132054. * @param inputWidth The width of the input panorama.
  132055. * @param inputHeight The height of the input panorama.
  132056. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  132057. * @return The cubemap data
  132058. */
  132059. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  132060. private static CreateCubemapTexture;
  132061. private static CalcProjectionSpherical;
  132062. }
  132063. }
  132064. declare module BABYLON {
  132065. /**
  132066. * Helper class dealing with the extraction of spherical polynomial dataArray
  132067. * from a cube map.
  132068. */
  132069. export class CubeMapToSphericalPolynomialTools {
  132070. private static FileFaces;
  132071. /**
  132072. * Converts a texture to the according Spherical Polynomial data.
  132073. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132074. *
  132075. * @param texture The texture to extract the information from.
  132076. * @return The Spherical Polynomial data.
  132077. */
  132078. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  132079. /**
  132080. * Converts a cubemap to the according Spherical Polynomial data.
  132081. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132082. *
  132083. * @param cubeInfo The Cube map to extract the information from.
  132084. * @return The Spherical Polynomial data.
  132085. */
  132086. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  132087. }
  132088. }
  132089. declare module BABYLON {
  132090. interface BaseTexture {
  132091. /**
  132092. * Get the polynomial representation of the texture data.
  132093. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  132094. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  132095. */
  132096. sphericalPolynomial: Nullable<SphericalPolynomial>;
  132097. }
  132098. }
  132099. declare module BABYLON {
  132100. /** @hidden */
  132101. export var rgbdEncodePixelShader: {
  132102. name: string;
  132103. shader: string;
  132104. };
  132105. }
  132106. declare module BABYLON {
  132107. /** @hidden */
  132108. export var rgbdDecodePixelShader: {
  132109. name: string;
  132110. shader: string;
  132111. };
  132112. }
  132113. declare module BABYLON {
  132114. /**
  132115. * Raw texture data and descriptor sufficient for WebGL texture upload
  132116. */
  132117. export interface EnvironmentTextureInfo {
  132118. /**
  132119. * Version of the environment map
  132120. */
  132121. version: number;
  132122. /**
  132123. * Width of image
  132124. */
  132125. width: number;
  132126. /**
  132127. * Irradiance information stored in the file.
  132128. */
  132129. irradiance: any;
  132130. /**
  132131. * Specular information stored in the file.
  132132. */
  132133. specular: any;
  132134. }
  132135. /**
  132136. * Defines One Image in the file. It requires only the position in the file
  132137. * as well as the length.
  132138. */
  132139. interface BufferImageData {
  132140. /**
  132141. * Length of the image data.
  132142. */
  132143. length: number;
  132144. /**
  132145. * Position of the data from the null terminator delimiting the end of the JSON.
  132146. */
  132147. position: number;
  132148. }
  132149. /**
  132150. * Defines the specular data enclosed in the file.
  132151. * This corresponds to the version 1 of the data.
  132152. */
  132153. export interface EnvironmentTextureSpecularInfoV1 {
  132154. /**
  132155. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  132156. */
  132157. specularDataPosition?: number;
  132158. /**
  132159. * This contains all the images data needed to reconstruct the cubemap.
  132160. */
  132161. mipmaps: Array<BufferImageData>;
  132162. /**
  132163. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  132164. */
  132165. lodGenerationScale: number;
  132166. }
  132167. /**
  132168. * Sets of helpers addressing the serialization and deserialization of environment texture
  132169. * stored in a BabylonJS env file.
  132170. * Those files are usually stored as .env files.
  132171. */
  132172. export class EnvironmentTextureTools {
  132173. /**
  132174. * Magic number identifying the env file.
  132175. */
  132176. private static _MagicBytes;
  132177. /**
  132178. * Gets the environment info from an env file.
  132179. * @param data The array buffer containing the .env bytes.
  132180. * @returns the environment file info (the json header) if successfully parsed.
  132181. */
  132182. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  132183. /**
  132184. * Creates an environment texture from a loaded cube texture.
  132185. * @param texture defines the cube texture to convert in env file
  132186. * @return a promise containing the environment data if succesfull.
  132187. */
  132188. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  132189. /**
  132190. * Creates a JSON representation of the spherical data.
  132191. * @param texture defines the texture containing the polynomials
  132192. * @return the JSON representation of the spherical info
  132193. */
  132194. private static _CreateEnvTextureIrradiance;
  132195. /**
  132196. * Creates the ArrayBufferViews used for initializing environment texture image data.
  132197. * @param data the image data
  132198. * @param info parameters that determine what views will be created for accessing the underlying buffer
  132199. * @return the views described by info providing access to the underlying buffer
  132200. */
  132201. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  132202. /**
  132203. * Uploads the texture info contained in the env file to the GPU.
  132204. * @param texture defines the internal texture to upload to
  132205. * @param data defines the data to load
  132206. * @param info defines the texture info retrieved through the GetEnvInfo method
  132207. * @returns a promise
  132208. */
  132209. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  132210. private static _OnImageReadyAsync;
  132211. /**
  132212. * Uploads the levels of image data to the GPU.
  132213. * @param texture defines the internal texture to upload to
  132214. * @param imageData defines the array buffer views of image data [mipmap][face]
  132215. * @returns a promise
  132216. */
  132217. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  132218. /**
  132219. * Uploads spherical polynomials information to the texture.
  132220. * @param texture defines the texture we are trying to upload the information to
  132221. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  132222. */
  132223. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  132224. /** @hidden */
  132225. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  132226. }
  132227. }
  132228. declare module BABYLON {
  132229. /**
  132230. * Class used to inline functions in shader code
  132231. */
  132232. export class ShaderCodeInliner {
  132233. private static readonly _RegexpFindFunctionNameAndType;
  132234. private _sourceCode;
  132235. private _functionDescr;
  132236. private _numMaxIterations;
  132237. /** Gets or sets the token used to mark the functions to inline */
  132238. inlineToken: string;
  132239. /** Gets or sets the debug mode */
  132240. debug: boolean;
  132241. /** Gets the code after the inlining process */
  132242. get code(): string;
  132243. /**
  132244. * Initializes the inliner
  132245. * @param sourceCode shader code source to inline
  132246. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  132247. */
  132248. constructor(sourceCode: string, numMaxIterations?: number);
  132249. /**
  132250. * Start the processing of the shader code
  132251. */
  132252. processCode(): void;
  132253. private _collectFunctions;
  132254. private _processInlining;
  132255. private _extractBetweenMarkers;
  132256. private _skipWhitespaces;
  132257. private _removeComments;
  132258. private _replaceFunctionCallsByCode;
  132259. private _findBackward;
  132260. private _escapeRegExp;
  132261. private _replaceNames;
  132262. }
  132263. }
  132264. declare module BABYLON {
  132265. /**
  132266. * Container for accessors for natively-stored mesh data buffers.
  132267. */
  132268. class NativeDataBuffer extends DataBuffer {
  132269. /**
  132270. * Accessor value used to identify/retrieve a natively-stored index buffer.
  132271. */
  132272. nativeIndexBuffer?: any;
  132273. /**
  132274. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  132275. */
  132276. nativeVertexBuffer?: any;
  132277. }
  132278. /** @hidden */
  132279. class NativeTexture extends InternalTexture {
  132280. getInternalTexture(): InternalTexture;
  132281. getViewCount(): number;
  132282. }
  132283. /** @hidden */
  132284. export class NativeEngine extends Engine {
  132285. private readonly _native;
  132286. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  132287. private readonly INVALID_HANDLE;
  132288. private _boundBuffersVertexArray;
  132289. getHardwareScalingLevel(): number;
  132290. constructor();
  132291. dispose(): void;
  132292. /**
  132293. * Can be used to override the current requestAnimationFrame requester.
  132294. * @hidden
  132295. */
  132296. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  132297. /**
  132298. * Override default engine behavior.
  132299. * @param color
  132300. * @param backBuffer
  132301. * @param depth
  132302. * @param stencil
  132303. */
  132304. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  132305. /**
  132306. * Gets host document
  132307. * @returns the host document object
  132308. */
  132309. getHostDocument(): Nullable<Document>;
  132310. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  132311. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  132312. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  132313. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  132314. [key: string]: VertexBuffer;
  132315. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132316. bindBuffers(vertexBuffers: {
  132317. [key: string]: VertexBuffer;
  132318. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132319. recordVertexArrayObject(vertexBuffers: {
  132320. [key: string]: VertexBuffer;
  132321. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  132322. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132323. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132324. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  132325. /**
  132326. * Draw a list of indexed primitives
  132327. * @param fillMode defines the primitive to use
  132328. * @param indexStart defines the starting index
  132329. * @param indexCount defines the number of index to draw
  132330. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132331. */
  132332. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  132333. /**
  132334. * Draw a list of unindexed primitives
  132335. * @param fillMode defines the primitive to use
  132336. * @param verticesStart defines the index of first vertex to draw
  132337. * @param verticesCount defines the count of vertices to draw
  132338. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132339. */
  132340. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  132341. createPipelineContext(): IPipelineContext;
  132342. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  132343. /** @hidden */
  132344. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  132345. /** @hidden */
  132346. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  132347. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132348. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132349. protected _setProgram(program: WebGLProgram): void;
  132350. _releaseEffect(effect: Effect): void;
  132351. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  132352. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  132353. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  132354. bindSamplers(effect: Effect): void;
  132355. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  132356. getRenderWidth(useScreen?: boolean): number;
  132357. getRenderHeight(useScreen?: boolean): number;
  132358. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  132359. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  132360. /**
  132361. * Set the z offset to apply to current rendering
  132362. * @param value defines the offset to apply
  132363. */
  132364. setZOffset(value: number): void;
  132365. /**
  132366. * Gets the current value of the zOffset
  132367. * @returns the current zOffset state
  132368. */
  132369. getZOffset(): number;
  132370. /**
  132371. * Enable or disable depth buffering
  132372. * @param enable defines the state to set
  132373. */
  132374. setDepthBuffer(enable: boolean): void;
  132375. /**
  132376. * Gets a boolean indicating if depth writing is enabled
  132377. * @returns the current depth writing state
  132378. */
  132379. getDepthWrite(): boolean;
  132380. /**
  132381. * Enable or disable depth writing
  132382. * @param enable defines the state to set
  132383. */
  132384. setDepthWrite(enable: boolean): void;
  132385. /**
  132386. * Enable or disable color writing
  132387. * @param enable defines the state to set
  132388. */
  132389. setColorWrite(enable: boolean): void;
  132390. /**
  132391. * Gets a boolean indicating if color writing is enabled
  132392. * @returns the current color writing state
  132393. */
  132394. getColorWrite(): boolean;
  132395. /**
  132396. * Sets alpha constants used by some alpha blending modes
  132397. * @param r defines the red component
  132398. * @param g defines the green component
  132399. * @param b defines the blue component
  132400. * @param a defines the alpha component
  132401. */
  132402. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  132403. /**
  132404. * Sets the current alpha mode
  132405. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  132406. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  132407. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132408. */
  132409. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  132410. /**
  132411. * Gets the current alpha mode
  132412. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132413. * @returns the current alpha mode
  132414. */
  132415. getAlphaMode(): number;
  132416. setInt(uniform: WebGLUniformLocation, int: number): void;
  132417. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  132418. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  132419. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  132420. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  132421. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  132422. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  132423. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  132424. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  132425. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  132426. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  132427. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  132428. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  132429. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  132430. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132431. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132432. setFloat(uniform: WebGLUniformLocation, value: number): void;
  132433. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  132434. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  132435. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  132436. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  132437. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  132438. wipeCaches(bruteForce?: boolean): void;
  132439. _createTexture(): WebGLTexture;
  132440. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  132441. /**
  132442. * Usually called from Texture.ts.
  132443. * Passed information to create a WebGLTexture
  132444. * @param url defines a value which contains one of the following:
  132445. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  132446. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  132447. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  132448. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  132449. * @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)
  132450. * @param scene needed for loading to the correct scene
  132451. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  132452. * @param onLoad optional callback to be called upon successful completion
  132453. * @param onError optional callback to be called upon failure
  132454. * @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
  132455. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  132456. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  132457. * @param forcedExtension defines the extension to use to pick the right loader
  132458. * @param mimeType defines an optional mime type
  132459. * @returns a InternalTexture for assignment back into BABYLON.Texture
  132460. */
  132461. 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;
  132462. /**
  132463. * Creates a cube texture
  132464. * @param rootUrl defines the url where the files to load is located
  132465. * @param scene defines the current scene
  132466. * @param files defines the list of files to load (1 per face)
  132467. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  132468. * @param onLoad defines an optional callback raised when the texture is loaded
  132469. * @param onError defines an optional callback raised if there is an issue to load the texture
  132470. * @param format defines the format of the data
  132471. * @param forcedExtension defines the extension to use to pick the right loader
  132472. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  132473. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  132474. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  132475. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  132476. * @returns the cube texture as an InternalTexture
  132477. */
  132478. 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;
  132479. private _getSamplingFilter;
  132480. private static _GetNativeTextureFormat;
  132481. createRenderTargetTexture(size: number | {
  132482. width: number;
  132483. height: number;
  132484. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  132485. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  132486. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  132487. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  132488. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  132489. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  132490. /**
  132491. * Updates a dynamic vertex buffer.
  132492. * @param vertexBuffer the vertex buffer to update
  132493. * @param data the data used to update the vertex buffer
  132494. * @param byteOffset the byte offset of the data (optional)
  132495. * @param byteLength the byte length of the data (optional)
  132496. */
  132497. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  132498. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  132499. private _updateAnisotropicLevel;
  132500. private _getAddressMode;
  132501. /** @hidden */
  132502. _bindTexture(channel: number, texture: InternalTexture): void;
  132503. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  132504. releaseEffects(): void;
  132505. /** @hidden */
  132506. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132507. /** @hidden */
  132508. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132509. /** @hidden */
  132510. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132511. /** @hidden */
  132512. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  132513. }
  132514. }
  132515. declare module BABYLON {
  132516. /**
  132517. * Gather the list of clipboard event types as constants.
  132518. */
  132519. export class ClipboardEventTypes {
  132520. /**
  132521. * The clipboard event is fired when a copy command is active (pressed).
  132522. */
  132523. static readonly COPY: number;
  132524. /**
  132525. * The clipboard event is fired when a cut command is active (pressed).
  132526. */
  132527. static readonly CUT: number;
  132528. /**
  132529. * The clipboard event is fired when a paste command is active (pressed).
  132530. */
  132531. static readonly PASTE: number;
  132532. }
  132533. /**
  132534. * This class is used to store clipboard related info for the onClipboardObservable event.
  132535. */
  132536. export class ClipboardInfo {
  132537. /**
  132538. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132539. */
  132540. type: number;
  132541. /**
  132542. * Defines the related dom event
  132543. */
  132544. event: ClipboardEvent;
  132545. /**
  132546. *Creates an instance of ClipboardInfo.
  132547. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  132548. * @param event Defines the related dom event
  132549. */
  132550. constructor(
  132551. /**
  132552. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132553. */
  132554. type: number,
  132555. /**
  132556. * Defines the related dom event
  132557. */
  132558. event: ClipboardEvent);
  132559. /**
  132560. * Get the clipboard event's type from the keycode.
  132561. * @param keyCode Defines the keyCode for the current keyboard event.
  132562. * @return {number}
  132563. */
  132564. static GetTypeFromCharacter(keyCode: number): number;
  132565. }
  132566. }
  132567. declare module BABYLON {
  132568. /**
  132569. * Google Daydream controller
  132570. */
  132571. export class DaydreamController extends WebVRController {
  132572. /**
  132573. * Base Url for the controller model.
  132574. */
  132575. static MODEL_BASE_URL: string;
  132576. /**
  132577. * File name for the controller model.
  132578. */
  132579. static MODEL_FILENAME: string;
  132580. /**
  132581. * Gamepad Id prefix used to identify Daydream Controller.
  132582. */
  132583. static readonly GAMEPAD_ID_PREFIX: string;
  132584. /**
  132585. * Creates a new DaydreamController from a gamepad
  132586. * @param vrGamepad the gamepad that the controller should be created from
  132587. */
  132588. constructor(vrGamepad: any);
  132589. /**
  132590. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132591. * @param scene scene in which to add meshes
  132592. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132593. */
  132594. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132595. /**
  132596. * Called once for each button that changed state since the last frame
  132597. * @param buttonIdx Which button index changed
  132598. * @param state New state of the button
  132599. * @param changes Which properties on the state changed since last frame
  132600. */
  132601. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132602. }
  132603. }
  132604. declare module BABYLON {
  132605. /**
  132606. * Gear VR Controller
  132607. */
  132608. export class GearVRController extends WebVRController {
  132609. /**
  132610. * Base Url for the controller model.
  132611. */
  132612. static MODEL_BASE_URL: string;
  132613. /**
  132614. * File name for the controller model.
  132615. */
  132616. static MODEL_FILENAME: string;
  132617. /**
  132618. * Gamepad Id prefix used to identify this controller.
  132619. */
  132620. static readonly GAMEPAD_ID_PREFIX: string;
  132621. private readonly _buttonIndexToObservableNameMap;
  132622. /**
  132623. * Creates a new GearVRController from a gamepad
  132624. * @param vrGamepad the gamepad that the controller should be created from
  132625. */
  132626. constructor(vrGamepad: any);
  132627. /**
  132628. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132629. * @param scene scene in which to add meshes
  132630. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132631. */
  132632. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132633. /**
  132634. * Called once for each button that changed state since the last frame
  132635. * @param buttonIdx Which button index changed
  132636. * @param state New state of the button
  132637. * @param changes Which properties on the state changed since last frame
  132638. */
  132639. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132640. }
  132641. }
  132642. declare module BABYLON {
  132643. /**
  132644. * Generic Controller
  132645. */
  132646. export class GenericController extends WebVRController {
  132647. /**
  132648. * Base Url for the controller model.
  132649. */
  132650. static readonly MODEL_BASE_URL: string;
  132651. /**
  132652. * File name for the controller model.
  132653. */
  132654. static readonly MODEL_FILENAME: string;
  132655. /**
  132656. * Creates a new GenericController from a gamepad
  132657. * @param vrGamepad the gamepad that the controller should be created from
  132658. */
  132659. constructor(vrGamepad: any);
  132660. /**
  132661. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132662. * @param scene scene in which to add meshes
  132663. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132664. */
  132665. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132666. /**
  132667. * Called once for each button that changed state since the last frame
  132668. * @param buttonIdx Which button index changed
  132669. * @param state New state of the button
  132670. * @param changes Which properties on the state changed since last frame
  132671. */
  132672. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132673. }
  132674. }
  132675. declare module BABYLON {
  132676. /**
  132677. * Oculus Touch Controller
  132678. */
  132679. export class OculusTouchController extends WebVRController {
  132680. /**
  132681. * Base Url for the controller model.
  132682. */
  132683. static MODEL_BASE_URL: string;
  132684. /**
  132685. * File name for the left controller model.
  132686. */
  132687. static MODEL_LEFT_FILENAME: string;
  132688. /**
  132689. * File name for the right controller model.
  132690. */
  132691. static MODEL_RIGHT_FILENAME: string;
  132692. /**
  132693. * Base Url for the Quest controller model.
  132694. */
  132695. static QUEST_MODEL_BASE_URL: string;
  132696. /**
  132697. * @hidden
  132698. * If the controllers are running on a device that needs the updated Quest controller models
  132699. */
  132700. static _IsQuest: boolean;
  132701. /**
  132702. * Fired when the secondary trigger on this controller is modified
  132703. */
  132704. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  132705. /**
  132706. * Fired when the thumb rest on this controller is modified
  132707. */
  132708. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  132709. /**
  132710. * Creates a new OculusTouchController from a gamepad
  132711. * @param vrGamepad the gamepad that the controller should be created from
  132712. */
  132713. constructor(vrGamepad: any);
  132714. /**
  132715. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132716. * @param scene scene in which to add meshes
  132717. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132718. */
  132719. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132720. /**
  132721. * Fired when the A button on this controller is modified
  132722. */
  132723. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132724. /**
  132725. * Fired when the B button on this controller is modified
  132726. */
  132727. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132728. /**
  132729. * Fired when the X button on this controller is modified
  132730. */
  132731. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132732. /**
  132733. * Fired when the Y button on this controller is modified
  132734. */
  132735. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132736. /**
  132737. * Called once for each button that changed state since the last frame
  132738. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  132739. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  132740. * 2) secondary trigger (same)
  132741. * 3) A (right) X (left), touch, pressed = value
  132742. * 4) B / Y
  132743. * 5) thumb rest
  132744. * @param buttonIdx Which button index changed
  132745. * @param state New state of the button
  132746. * @param changes Which properties on the state changed since last frame
  132747. */
  132748. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132749. }
  132750. }
  132751. declare module BABYLON {
  132752. /**
  132753. * Vive Controller
  132754. */
  132755. export class ViveController extends WebVRController {
  132756. /**
  132757. * Base Url for the controller model.
  132758. */
  132759. static MODEL_BASE_URL: string;
  132760. /**
  132761. * File name for the controller model.
  132762. */
  132763. static MODEL_FILENAME: string;
  132764. /**
  132765. * Creates a new ViveController from a gamepad
  132766. * @param vrGamepad the gamepad that the controller should be created from
  132767. */
  132768. constructor(vrGamepad: any);
  132769. /**
  132770. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132771. * @param scene scene in which to add meshes
  132772. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132773. */
  132774. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132775. /**
  132776. * Fired when the left button on this controller is modified
  132777. */
  132778. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132779. /**
  132780. * Fired when the right button on this controller is modified
  132781. */
  132782. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132783. /**
  132784. * Fired when the menu button on this controller is modified
  132785. */
  132786. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132787. /**
  132788. * Called once for each button that changed state since the last frame
  132789. * Vive mapping:
  132790. * 0: touchpad
  132791. * 1: trigger
  132792. * 2: left AND right buttons
  132793. * 3: menu button
  132794. * @param buttonIdx Which button index changed
  132795. * @param state New state of the button
  132796. * @param changes Which properties on the state changed since last frame
  132797. */
  132798. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132799. }
  132800. }
  132801. declare module BABYLON {
  132802. /**
  132803. * Defines the WindowsMotionController object that the state of the windows motion controller
  132804. */
  132805. export class WindowsMotionController extends WebVRController {
  132806. /**
  132807. * The base url used to load the left and right controller models
  132808. */
  132809. static MODEL_BASE_URL: string;
  132810. /**
  132811. * The name of the left controller model file
  132812. */
  132813. static MODEL_LEFT_FILENAME: string;
  132814. /**
  132815. * The name of the right controller model file
  132816. */
  132817. static MODEL_RIGHT_FILENAME: string;
  132818. /**
  132819. * The controller name prefix for this controller type
  132820. */
  132821. static readonly GAMEPAD_ID_PREFIX: string;
  132822. /**
  132823. * The controller id pattern for this controller type
  132824. */
  132825. private static readonly GAMEPAD_ID_PATTERN;
  132826. private _loadedMeshInfo;
  132827. protected readonly _mapping: {
  132828. buttons: string[];
  132829. buttonMeshNames: {
  132830. trigger: string;
  132831. menu: string;
  132832. grip: string;
  132833. thumbstick: string;
  132834. trackpad: string;
  132835. };
  132836. buttonObservableNames: {
  132837. trigger: string;
  132838. menu: string;
  132839. grip: string;
  132840. thumbstick: string;
  132841. trackpad: string;
  132842. };
  132843. axisMeshNames: string[];
  132844. pointingPoseMeshName: string;
  132845. };
  132846. /**
  132847. * Fired when the trackpad on this controller is clicked
  132848. */
  132849. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132850. /**
  132851. * Fired when the trackpad on this controller is modified
  132852. */
  132853. onTrackpadValuesChangedObservable: Observable<StickValues>;
  132854. /**
  132855. * The current x and y values of this controller's trackpad
  132856. */
  132857. trackpad: StickValues;
  132858. /**
  132859. * Creates a new WindowsMotionController from a gamepad
  132860. * @param vrGamepad the gamepad that the controller should be created from
  132861. */
  132862. constructor(vrGamepad: any);
  132863. /**
  132864. * Fired when the trigger on this controller is modified
  132865. */
  132866. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132867. /**
  132868. * Fired when the menu button on this controller is modified
  132869. */
  132870. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132871. /**
  132872. * Fired when the grip button on this controller is modified
  132873. */
  132874. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132875. /**
  132876. * Fired when the thumbstick button on this controller is modified
  132877. */
  132878. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132879. /**
  132880. * Fired when the touchpad button on this controller is modified
  132881. */
  132882. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132883. /**
  132884. * Fired when the touchpad values on this controller are modified
  132885. */
  132886. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  132887. protected _updateTrackpad(): void;
  132888. /**
  132889. * Called once per frame by the engine.
  132890. */
  132891. update(): void;
  132892. /**
  132893. * Called once for each button that changed state since the last frame
  132894. * @param buttonIdx Which button index changed
  132895. * @param state New state of the button
  132896. * @param changes Which properties on the state changed since last frame
  132897. */
  132898. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132899. /**
  132900. * Moves the buttons on the controller mesh based on their current state
  132901. * @param buttonName the name of the button to move
  132902. * @param buttonValue the value of the button which determines the buttons new position
  132903. */
  132904. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  132905. /**
  132906. * Moves the axis on the controller mesh based on its current state
  132907. * @param axis the index of the axis
  132908. * @param axisValue the value of the axis which determines the meshes new position
  132909. * @hidden
  132910. */
  132911. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  132912. /**
  132913. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132914. * @param scene scene in which to add meshes
  132915. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132916. */
  132917. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  132918. /**
  132919. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  132920. * can be transformed by button presses and axes values, based on this._mapping.
  132921. *
  132922. * @param scene scene in which the meshes exist
  132923. * @param meshes list of meshes that make up the controller model to process
  132924. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  132925. */
  132926. private processModel;
  132927. private createMeshInfo;
  132928. /**
  132929. * Gets the ray of the controller in the direction the controller is pointing
  132930. * @param length the length the resulting ray should be
  132931. * @returns a ray in the direction the controller is pointing
  132932. */
  132933. getForwardRay(length?: number): Ray;
  132934. /**
  132935. * Disposes of the controller
  132936. */
  132937. dispose(): void;
  132938. }
  132939. /**
  132940. * This class represents a new windows motion controller in XR.
  132941. */
  132942. export class XRWindowsMotionController extends WindowsMotionController {
  132943. /**
  132944. * Changing the original WIndowsMotionController mapping to fir the new mapping
  132945. */
  132946. protected readonly _mapping: {
  132947. buttons: string[];
  132948. buttonMeshNames: {
  132949. trigger: string;
  132950. menu: string;
  132951. grip: string;
  132952. thumbstick: string;
  132953. trackpad: string;
  132954. };
  132955. buttonObservableNames: {
  132956. trigger: string;
  132957. menu: string;
  132958. grip: string;
  132959. thumbstick: string;
  132960. trackpad: string;
  132961. };
  132962. axisMeshNames: string[];
  132963. pointingPoseMeshName: string;
  132964. };
  132965. /**
  132966. * Construct a new XR-Based windows motion controller
  132967. *
  132968. * @param gamepadInfo the gamepad object from the browser
  132969. */
  132970. constructor(gamepadInfo: any);
  132971. /**
  132972. * holds the thumbstick values (X,Y)
  132973. */
  132974. thumbstickValues: StickValues;
  132975. /**
  132976. * Fired when the thumbstick on this controller is clicked
  132977. */
  132978. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  132979. /**
  132980. * Fired when the thumbstick on this controller is modified
  132981. */
  132982. onThumbstickValuesChangedObservable: Observable<StickValues>;
  132983. /**
  132984. * Fired when the touchpad button on this controller is modified
  132985. */
  132986. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132987. /**
  132988. * Fired when the touchpad values on this controller are modified
  132989. */
  132990. onTrackpadValuesChangedObservable: Observable<StickValues>;
  132991. /**
  132992. * Fired when the thumbstick button on this controller is modified
  132993. * here to prevent breaking changes
  132994. */
  132995. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132996. /**
  132997. * updating the thumbstick(!) and not the trackpad.
  132998. * This is named this way due to the difference between WebVR and XR and to avoid
  132999. * changing the parent class.
  133000. */
  133001. protected _updateTrackpad(): void;
  133002. /**
  133003. * Disposes the class with joy
  133004. */
  133005. dispose(): void;
  133006. }
  133007. }
  133008. declare module BABYLON {
  133009. /**
  133010. * Class containing static functions to help procedurally build meshes
  133011. */
  133012. export class PolyhedronBuilder {
  133013. /**
  133014. * Creates a polyhedron mesh
  133015. * * 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
  133016. * * The parameter `size` (positive float, default 1) sets the polygon size
  133017. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  133018. * * 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`
  133019. * * 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
  133020. * * 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)`)
  133021. * * 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
  133022. * * 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
  133023. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  133024. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  133025. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  133026. * @param name defines the name of the mesh
  133027. * @param options defines the options used to create the mesh
  133028. * @param scene defines the hosting scene
  133029. * @returns the polyhedron mesh
  133030. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  133031. */
  133032. static CreatePolyhedron(name: string, options: {
  133033. type?: number;
  133034. size?: number;
  133035. sizeX?: number;
  133036. sizeY?: number;
  133037. sizeZ?: number;
  133038. custom?: any;
  133039. faceUV?: Vector4[];
  133040. faceColors?: Color4[];
  133041. flat?: boolean;
  133042. updatable?: boolean;
  133043. sideOrientation?: number;
  133044. frontUVs?: Vector4;
  133045. backUVs?: Vector4;
  133046. }, scene?: Nullable<Scene>): Mesh;
  133047. }
  133048. }
  133049. declare module BABYLON {
  133050. /**
  133051. * Gizmo that enables scaling a mesh along 3 axis
  133052. */
  133053. export class ScaleGizmo extends Gizmo {
  133054. /**
  133055. * Internal gizmo used for interactions on the x axis
  133056. */
  133057. xGizmo: AxisScaleGizmo;
  133058. /**
  133059. * Internal gizmo used for interactions on the y axis
  133060. */
  133061. yGizmo: AxisScaleGizmo;
  133062. /**
  133063. * Internal gizmo used for interactions on the z axis
  133064. */
  133065. zGizmo: AxisScaleGizmo;
  133066. /**
  133067. * Internal gizmo used to scale all axis equally
  133068. */
  133069. uniformScaleGizmo: AxisScaleGizmo;
  133070. private _meshAttached;
  133071. private _nodeAttached;
  133072. private _snapDistance;
  133073. private _uniformScalingMesh;
  133074. private _octahedron;
  133075. private _sensitivity;
  133076. /** Fires an event when any of it's sub gizmos are dragged */
  133077. onDragStartObservable: Observable<unknown>;
  133078. /** Fires an event when any of it's sub gizmos are released from dragging */
  133079. onDragEndObservable: Observable<unknown>;
  133080. get attachedMesh(): Nullable<AbstractMesh>;
  133081. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133082. get attachedNode(): Nullable<Node>;
  133083. set attachedNode(node: Nullable<Node>);
  133084. /**
  133085. * Creates a ScaleGizmo
  133086. * @param gizmoLayer The utility layer the gizmo will be added to
  133087. * @param thickness display gizmo axis thickness
  133088. */
  133089. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  133090. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133091. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133092. /**
  133093. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133094. */
  133095. set snapDistance(value: number);
  133096. get snapDistance(): number;
  133097. /**
  133098. * Ratio for the scale of the gizmo (Default: 1)
  133099. */
  133100. set scaleRatio(value: number);
  133101. get scaleRatio(): number;
  133102. /**
  133103. * Sensitivity factor for dragging (Default: 1)
  133104. */
  133105. set sensitivity(value: number);
  133106. get sensitivity(): number;
  133107. /**
  133108. * Disposes of the gizmo
  133109. */
  133110. dispose(): void;
  133111. }
  133112. }
  133113. declare module BABYLON {
  133114. /**
  133115. * Single axis scale gizmo
  133116. */
  133117. export class AxisScaleGizmo extends Gizmo {
  133118. /**
  133119. * Drag behavior responsible for the gizmos dragging interactions
  133120. */
  133121. dragBehavior: PointerDragBehavior;
  133122. private _pointerObserver;
  133123. /**
  133124. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133125. */
  133126. snapDistance: number;
  133127. /**
  133128. * Event that fires each time the gizmo snaps to a new location.
  133129. * * snapDistance is the the change in distance
  133130. */
  133131. onSnapObservable: Observable<{
  133132. snapDistance: number;
  133133. }>;
  133134. /**
  133135. * If the scaling operation should be done on all axis (default: false)
  133136. */
  133137. uniformScaling: boolean;
  133138. /**
  133139. * Custom sensitivity value for the drag strength
  133140. */
  133141. sensitivity: number;
  133142. private _isEnabled;
  133143. private _parent;
  133144. private _arrow;
  133145. private _coloredMaterial;
  133146. private _hoverMaterial;
  133147. /**
  133148. * Creates an AxisScaleGizmo
  133149. * @param gizmoLayer The utility layer the gizmo will be added to
  133150. * @param dragAxis The axis which the gizmo will be able to scale on
  133151. * @param color The color of the gizmo
  133152. * @param thickness display gizmo axis thickness
  133153. */
  133154. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  133155. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133156. /**
  133157. * If the gizmo is enabled
  133158. */
  133159. set isEnabled(value: boolean);
  133160. get isEnabled(): boolean;
  133161. /**
  133162. * Disposes of the gizmo
  133163. */
  133164. dispose(): void;
  133165. /**
  133166. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  133167. * @param mesh The mesh to replace the default mesh of the gizmo
  133168. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  133169. */
  133170. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  133171. }
  133172. }
  133173. declare module BABYLON {
  133174. /**
  133175. * Bounding box gizmo
  133176. */
  133177. export class BoundingBoxGizmo extends Gizmo {
  133178. private _lineBoundingBox;
  133179. private _rotateSpheresParent;
  133180. private _scaleBoxesParent;
  133181. private _boundingDimensions;
  133182. private _renderObserver;
  133183. private _pointerObserver;
  133184. private _scaleDragSpeed;
  133185. private _tmpQuaternion;
  133186. private _tmpVector;
  133187. private _tmpRotationMatrix;
  133188. /**
  133189. * 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)
  133190. */
  133191. ignoreChildren: boolean;
  133192. /**
  133193. * 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)
  133194. */
  133195. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  133196. /**
  133197. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  133198. */
  133199. rotationSphereSize: number;
  133200. /**
  133201. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  133202. */
  133203. scaleBoxSize: number;
  133204. /**
  133205. * 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)
  133206. */
  133207. fixedDragMeshScreenSize: boolean;
  133208. /**
  133209. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  133210. */
  133211. fixedDragMeshScreenSizeDistanceFactor: number;
  133212. /**
  133213. * Fired when a rotation sphere or scale box is dragged
  133214. */
  133215. onDragStartObservable: Observable<{}>;
  133216. /**
  133217. * Fired when a scale box is dragged
  133218. */
  133219. onScaleBoxDragObservable: Observable<{}>;
  133220. /**
  133221. * Fired when a scale box drag is ended
  133222. */
  133223. onScaleBoxDragEndObservable: Observable<{}>;
  133224. /**
  133225. * Fired when a rotation sphere is dragged
  133226. */
  133227. onRotationSphereDragObservable: Observable<{}>;
  133228. /**
  133229. * Fired when a rotation sphere drag is ended
  133230. */
  133231. onRotationSphereDragEndObservable: Observable<{}>;
  133232. /**
  133233. * 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)
  133234. */
  133235. scalePivot: Nullable<Vector3>;
  133236. /**
  133237. * Mesh used as a pivot to rotate the attached node
  133238. */
  133239. private _anchorMesh;
  133240. private _existingMeshScale;
  133241. private _dragMesh;
  133242. private pointerDragBehavior;
  133243. private coloredMaterial;
  133244. private hoverColoredMaterial;
  133245. /**
  133246. * Sets the color of the bounding box gizmo
  133247. * @param color the color to set
  133248. */
  133249. setColor(color: Color3): void;
  133250. /**
  133251. * Creates an BoundingBoxGizmo
  133252. * @param gizmoLayer The utility layer the gizmo will be added to
  133253. * @param color The color of the gizmo
  133254. */
  133255. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  133256. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  133257. private _selectNode;
  133258. /**
  133259. * Updates the bounding box information for the Gizmo
  133260. */
  133261. updateBoundingBox(): void;
  133262. private _updateRotationSpheres;
  133263. private _updateScaleBoxes;
  133264. /**
  133265. * Enables rotation on the specified axis and disables rotation on the others
  133266. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  133267. */
  133268. setEnabledRotationAxis(axis: string): void;
  133269. /**
  133270. * Enables/disables scaling
  133271. * @param enable if scaling should be enabled
  133272. * @param homogeneousScaling defines if scaling should only be homogeneous
  133273. */
  133274. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  133275. private _updateDummy;
  133276. /**
  133277. * Enables a pointer drag behavior on the bounding box of the gizmo
  133278. */
  133279. enableDragBehavior(): void;
  133280. /**
  133281. * Disposes of the gizmo
  133282. */
  133283. dispose(): void;
  133284. /**
  133285. * 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)
  133286. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  133287. * @returns the bounding box mesh with the passed in mesh as a child
  133288. */
  133289. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  133290. /**
  133291. * CustomMeshes are not supported by this gizmo
  133292. * @param mesh The mesh to replace the default mesh of the gizmo
  133293. */
  133294. setCustomMesh(mesh: Mesh): void;
  133295. }
  133296. }
  133297. declare module BABYLON {
  133298. /**
  133299. * Single plane rotation gizmo
  133300. */
  133301. export class PlaneRotationGizmo extends Gizmo {
  133302. /**
  133303. * Drag behavior responsible for the gizmos dragging interactions
  133304. */
  133305. dragBehavior: PointerDragBehavior;
  133306. private _pointerObserver;
  133307. /**
  133308. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  133309. */
  133310. snapDistance: number;
  133311. /**
  133312. * Event that fires each time the gizmo snaps to a new location.
  133313. * * snapDistance is the the change in distance
  133314. */
  133315. onSnapObservable: Observable<{
  133316. snapDistance: number;
  133317. }>;
  133318. private _isEnabled;
  133319. private _parent;
  133320. /**
  133321. * Creates a PlaneRotationGizmo
  133322. * @param gizmoLayer The utility layer the gizmo will be added to
  133323. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  133324. * @param color The color of the gizmo
  133325. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133326. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133327. * @param thickness display gizmo axis thickness
  133328. */
  133329. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  133330. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133331. /**
  133332. * If the gizmo is enabled
  133333. */
  133334. set isEnabled(value: boolean);
  133335. get isEnabled(): boolean;
  133336. /**
  133337. * Disposes of the gizmo
  133338. */
  133339. dispose(): void;
  133340. }
  133341. }
  133342. declare module BABYLON {
  133343. /**
  133344. * Gizmo that enables rotating a mesh along 3 axis
  133345. */
  133346. export class RotationGizmo extends Gizmo {
  133347. /**
  133348. * Internal gizmo used for interactions on the x axis
  133349. */
  133350. xGizmo: PlaneRotationGizmo;
  133351. /**
  133352. * Internal gizmo used for interactions on the y axis
  133353. */
  133354. yGizmo: PlaneRotationGizmo;
  133355. /**
  133356. * Internal gizmo used for interactions on the z axis
  133357. */
  133358. zGizmo: PlaneRotationGizmo;
  133359. /** Fires an event when any of it's sub gizmos are dragged */
  133360. onDragStartObservable: Observable<unknown>;
  133361. /** Fires an event when any of it's sub gizmos are released from dragging */
  133362. onDragEndObservable: Observable<unknown>;
  133363. private _meshAttached;
  133364. private _nodeAttached;
  133365. get attachedMesh(): Nullable<AbstractMesh>;
  133366. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133367. get attachedNode(): Nullable<Node>;
  133368. set attachedNode(node: Nullable<Node>);
  133369. /**
  133370. * Creates a RotationGizmo
  133371. * @param gizmoLayer The utility layer the gizmo will be added to
  133372. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133373. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133374. * @param thickness display gizmo axis thickness
  133375. */
  133376. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  133377. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133378. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133379. /**
  133380. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133381. */
  133382. set snapDistance(value: number);
  133383. get snapDistance(): number;
  133384. /**
  133385. * Ratio for the scale of the gizmo (Default: 1)
  133386. */
  133387. set scaleRatio(value: number);
  133388. get scaleRatio(): number;
  133389. /**
  133390. * Disposes of the gizmo
  133391. */
  133392. dispose(): void;
  133393. /**
  133394. * CustomMeshes are not supported by this gizmo
  133395. * @param mesh The mesh to replace the default mesh of the gizmo
  133396. */
  133397. setCustomMesh(mesh: Mesh): void;
  133398. }
  133399. }
  133400. declare module BABYLON {
  133401. /**
  133402. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  133403. */
  133404. export class GizmoManager implements IDisposable {
  133405. private scene;
  133406. /**
  133407. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  133408. */
  133409. gizmos: {
  133410. positionGizmo: Nullable<PositionGizmo>;
  133411. rotationGizmo: Nullable<RotationGizmo>;
  133412. scaleGizmo: Nullable<ScaleGizmo>;
  133413. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  133414. };
  133415. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  133416. clearGizmoOnEmptyPointerEvent: boolean;
  133417. /** Fires an event when the manager is attached to a mesh */
  133418. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  133419. /** Fires an event when the manager is attached to a node */
  133420. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  133421. private _gizmosEnabled;
  133422. private _pointerObserver;
  133423. private _attachedMesh;
  133424. private _attachedNode;
  133425. private _boundingBoxColor;
  133426. private _defaultUtilityLayer;
  133427. private _defaultKeepDepthUtilityLayer;
  133428. private _thickness;
  133429. /**
  133430. * When bounding box gizmo is enabled, this can be used to track drag/end events
  133431. */
  133432. boundingBoxDragBehavior: SixDofDragBehavior;
  133433. /**
  133434. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  133435. */
  133436. attachableMeshes: Nullable<Array<AbstractMesh>>;
  133437. /**
  133438. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  133439. */
  133440. attachableNodes: Nullable<Array<Node>>;
  133441. /**
  133442. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  133443. */
  133444. usePointerToAttachGizmos: boolean;
  133445. /**
  133446. * Utility layer that the bounding box gizmo belongs to
  133447. */
  133448. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  133449. /**
  133450. * Utility layer that all gizmos besides bounding box belong to
  133451. */
  133452. get utilityLayer(): UtilityLayerRenderer;
  133453. /**
  133454. * Instatiates a gizmo manager
  133455. * @param scene the scene to overlay the gizmos on top of
  133456. * @param thickness display gizmo axis thickness
  133457. */
  133458. constructor(scene: Scene, thickness?: number);
  133459. /**
  133460. * Attaches a set of gizmos to the specified mesh
  133461. * @param mesh The mesh the gizmo's should be attached to
  133462. */
  133463. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  133464. /**
  133465. * Attaches a set of gizmos to the specified node
  133466. * @param node The node the gizmo's should be attached to
  133467. */
  133468. attachToNode(node: Nullable<Node>): void;
  133469. /**
  133470. * If the position gizmo is enabled
  133471. */
  133472. set positionGizmoEnabled(value: boolean);
  133473. get positionGizmoEnabled(): boolean;
  133474. /**
  133475. * If the rotation gizmo is enabled
  133476. */
  133477. set rotationGizmoEnabled(value: boolean);
  133478. get rotationGizmoEnabled(): boolean;
  133479. /**
  133480. * If the scale gizmo is enabled
  133481. */
  133482. set scaleGizmoEnabled(value: boolean);
  133483. get scaleGizmoEnabled(): boolean;
  133484. /**
  133485. * If the boundingBox gizmo is enabled
  133486. */
  133487. set boundingBoxGizmoEnabled(value: boolean);
  133488. get boundingBoxGizmoEnabled(): boolean;
  133489. /**
  133490. * Disposes of the gizmo manager
  133491. */
  133492. dispose(): void;
  133493. }
  133494. }
  133495. declare module BABYLON {
  133496. /**
  133497. * A directional light is defined by a direction (what a surprise!).
  133498. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  133499. * 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.
  133500. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133501. */
  133502. export class DirectionalLight extends ShadowLight {
  133503. private _shadowFrustumSize;
  133504. /**
  133505. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  133506. */
  133507. get shadowFrustumSize(): number;
  133508. /**
  133509. * Specifies a fix frustum size for the shadow generation.
  133510. */
  133511. set shadowFrustumSize(value: number);
  133512. private _shadowOrthoScale;
  133513. /**
  133514. * Gets the shadow projection scale against the optimal computed one.
  133515. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133516. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133517. */
  133518. get shadowOrthoScale(): number;
  133519. /**
  133520. * Sets the shadow projection scale against the optimal computed one.
  133521. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133522. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133523. */
  133524. set shadowOrthoScale(value: number);
  133525. /**
  133526. * Automatically compute the projection matrix to best fit (including all the casters)
  133527. * on each frame.
  133528. */
  133529. autoUpdateExtends: boolean;
  133530. /**
  133531. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  133532. * on each frame. autoUpdateExtends must be set to true for this to work
  133533. */
  133534. autoCalcShadowZBounds: boolean;
  133535. private _orthoLeft;
  133536. private _orthoRight;
  133537. private _orthoTop;
  133538. private _orthoBottom;
  133539. /**
  133540. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  133541. * The directional light is emitted from everywhere in the given direction.
  133542. * It can cast shadows.
  133543. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133544. * @param name The friendly name of the light
  133545. * @param direction The direction of the light
  133546. * @param scene The scene the light belongs to
  133547. */
  133548. constructor(name: string, direction: Vector3, scene: Scene);
  133549. /**
  133550. * Returns the string "DirectionalLight".
  133551. * @return The class name
  133552. */
  133553. getClassName(): string;
  133554. /**
  133555. * Returns the integer 1.
  133556. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133557. */
  133558. getTypeID(): number;
  133559. /**
  133560. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  133561. * Returns the DirectionalLight Shadow projection matrix.
  133562. */
  133563. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133564. /**
  133565. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  133566. * Returns the DirectionalLight Shadow projection matrix.
  133567. */
  133568. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  133569. /**
  133570. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  133571. * Returns the DirectionalLight Shadow projection matrix.
  133572. */
  133573. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133574. protected _buildUniformLayout(): void;
  133575. /**
  133576. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  133577. * @param effect The effect to update
  133578. * @param lightIndex The index of the light in the effect to update
  133579. * @returns The directional light
  133580. */
  133581. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  133582. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  133583. /**
  133584. * Gets the minZ used for shadow according to both the scene and the light.
  133585. *
  133586. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133587. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133588. * @param activeCamera The camera we are returning the min for
  133589. * @returns the depth min z
  133590. */
  133591. getDepthMinZ(activeCamera: Camera): number;
  133592. /**
  133593. * Gets the maxZ 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 max for
  133598. * @returns the depth max z
  133599. */
  133600. getDepthMaxZ(activeCamera: Camera): number;
  133601. /**
  133602. * Prepares the list of defines specific to the light type.
  133603. * @param defines the list of defines
  133604. * @param lightIndex defines the index of the light for the effect
  133605. */
  133606. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133607. }
  133608. }
  133609. declare module BABYLON {
  133610. /**
  133611. * Class containing static functions to help procedurally build meshes
  133612. */
  133613. export class HemisphereBuilder {
  133614. /**
  133615. * Creates a hemisphere mesh
  133616. * @param name defines the name of the mesh
  133617. * @param options defines the options used to create the mesh
  133618. * @param scene defines the hosting scene
  133619. * @returns the hemisphere mesh
  133620. */
  133621. static CreateHemisphere(name: string, options: {
  133622. segments?: number;
  133623. diameter?: number;
  133624. sideOrientation?: number;
  133625. }, scene: any): Mesh;
  133626. }
  133627. }
  133628. declare module BABYLON {
  133629. /**
  133630. * A spot light is defined by a position, a direction, an angle, and an exponent.
  133631. * These values define a cone of light starting from the position, emitting toward the direction.
  133632. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  133633. * and the exponent defines the speed of the decay of the light with distance (reach).
  133634. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133635. */
  133636. export class SpotLight extends ShadowLight {
  133637. private _angle;
  133638. private _innerAngle;
  133639. private _cosHalfAngle;
  133640. private _lightAngleScale;
  133641. private _lightAngleOffset;
  133642. /**
  133643. * Gets the cone angle of the spot light in Radians.
  133644. */
  133645. get angle(): number;
  133646. /**
  133647. * Sets the cone angle of the spot light in Radians.
  133648. */
  133649. set angle(value: number);
  133650. /**
  133651. * Only used in gltf falloff mode, this defines the angle where
  133652. * the directional falloff will start before cutting at angle which could be seen
  133653. * as outer angle.
  133654. */
  133655. get innerAngle(): number;
  133656. /**
  133657. * Only used in gltf falloff mode, this defines the angle where
  133658. * the directional falloff will start before cutting at angle which could be seen
  133659. * as outer angle.
  133660. */
  133661. set innerAngle(value: number);
  133662. private _shadowAngleScale;
  133663. /**
  133664. * Allows scaling the angle of the light for shadow generation only.
  133665. */
  133666. get shadowAngleScale(): number;
  133667. /**
  133668. * Allows scaling the angle of the light for shadow generation only.
  133669. */
  133670. set shadowAngleScale(value: number);
  133671. /**
  133672. * The light decay speed with the distance from the emission spot.
  133673. */
  133674. exponent: number;
  133675. private _projectionTextureMatrix;
  133676. /**
  133677. * Allows reading the projecton texture
  133678. */
  133679. get projectionTextureMatrix(): Matrix;
  133680. protected _projectionTextureLightNear: number;
  133681. /**
  133682. * Gets the near clip of the Spotlight for texture projection.
  133683. */
  133684. get projectionTextureLightNear(): number;
  133685. /**
  133686. * Sets the near clip of the Spotlight for texture projection.
  133687. */
  133688. set projectionTextureLightNear(value: number);
  133689. protected _projectionTextureLightFar: number;
  133690. /**
  133691. * Gets the far clip of the Spotlight for texture projection.
  133692. */
  133693. get projectionTextureLightFar(): number;
  133694. /**
  133695. * Sets the far clip of the Spotlight for texture projection.
  133696. */
  133697. set projectionTextureLightFar(value: number);
  133698. protected _projectionTextureUpDirection: Vector3;
  133699. /**
  133700. * Gets the Up vector of the Spotlight for texture projection.
  133701. */
  133702. get projectionTextureUpDirection(): Vector3;
  133703. /**
  133704. * Sets the Up vector of the Spotlight for texture projection.
  133705. */
  133706. set projectionTextureUpDirection(value: Vector3);
  133707. private _projectionTexture;
  133708. /**
  133709. * Gets the projection texture of the light.
  133710. */
  133711. get projectionTexture(): Nullable<BaseTexture>;
  133712. /**
  133713. * Sets the projection texture of the light.
  133714. */
  133715. set projectionTexture(value: Nullable<BaseTexture>);
  133716. private _projectionTextureViewLightDirty;
  133717. private _projectionTextureProjectionLightDirty;
  133718. private _projectionTextureDirty;
  133719. private _projectionTextureViewTargetVector;
  133720. private _projectionTextureViewLightMatrix;
  133721. private _projectionTextureProjectionLightMatrix;
  133722. private _projectionTextureScalingMatrix;
  133723. /**
  133724. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  133725. * It can cast shadows.
  133726. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133727. * @param name The light friendly name
  133728. * @param position The position of the spot light in the scene
  133729. * @param direction The direction of the light in the scene
  133730. * @param angle The cone angle of the light in Radians
  133731. * @param exponent The light decay speed with the distance from the emission spot
  133732. * @param scene The scene the lights belongs to
  133733. */
  133734. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  133735. /**
  133736. * Returns the string "SpotLight".
  133737. * @returns the class name
  133738. */
  133739. getClassName(): string;
  133740. /**
  133741. * Returns the integer 2.
  133742. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133743. */
  133744. getTypeID(): number;
  133745. /**
  133746. * Overrides the direction setter to recompute the projection texture view light Matrix.
  133747. */
  133748. protected _setDirection(value: Vector3): void;
  133749. /**
  133750. * Overrides the position setter to recompute the projection texture view light Matrix.
  133751. */
  133752. protected _setPosition(value: Vector3): void;
  133753. /**
  133754. * 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.
  133755. * Returns the SpotLight.
  133756. */
  133757. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133758. protected _computeProjectionTextureViewLightMatrix(): void;
  133759. protected _computeProjectionTextureProjectionLightMatrix(): void;
  133760. /**
  133761. * Main function for light texture projection matrix computing.
  133762. */
  133763. protected _computeProjectionTextureMatrix(): void;
  133764. protected _buildUniformLayout(): void;
  133765. private _computeAngleValues;
  133766. /**
  133767. * Sets the passed Effect "effect" with the Light textures.
  133768. * @param effect The effect to update
  133769. * @param lightIndex The index of the light in the effect to update
  133770. * @returns The light
  133771. */
  133772. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  133773. /**
  133774. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  133775. * @param effect The effect to update
  133776. * @param lightIndex The index of the light in the effect to update
  133777. * @returns The spot light
  133778. */
  133779. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  133780. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  133781. /**
  133782. * Disposes the light and the associated resources.
  133783. */
  133784. dispose(): void;
  133785. /**
  133786. * Prepares the list of defines specific to the light type.
  133787. * @param defines the list of defines
  133788. * @param lightIndex defines the index of the light for the effect
  133789. */
  133790. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133791. }
  133792. }
  133793. declare module BABYLON {
  133794. /**
  133795. * Gizmo that enables viewing a light
  133796. */
  133797. export class LightGizmo extends Gizmo {
  133798. private _lightMesh;
  133799. private _material;
  133800. private _cachedPosition;
  133801. private _cachedForward;
  133802. private _attachedMeshParent;
  133803. /**
  133804. * Creates a LightGizmo
  133805. * @param gizmoLayer The utility layer the gizmo will be added to
  133806. */
  133807. constructor(gizmoLayer?: UtilityLayerRenderer);
  133808. private _light;
  133809. /**
  133810. * The light that the gizmo is attached to
  133811. */
  133812. set light(light: Nullable<Light>);
  133813. get light(): Nullable<Light>;
  133814. /**
  133815. * Gets the material used to render the light gizmo
  133816. */
  133817. get material(): StandardMaterial;
  133818. /**
  133819. * @hidden
  133820. * Updates the gizmo to match the attached mesh's position/rotation
  133821. */
  133822. protected _update(): void;
  133823. private static _Scale;
  133824. /**
  133825. * Creates the lines for a light mesh
  133826. */
  133827. private static _CreateLightLines;
  133828. /**
  133829. * Disposes of the light gizmo
  133830. */
  133831. dispose(): void;
  133832. private static _CreateHemisphericLightMesh;
  133833. private static _CreatePointLightMesh;
  133834. private static _CreateSpotLightMesh;
  133835. private static _CreateDirectionalLightMesh;
  133836. }
  133837. }
  133838. declare module BABYLON {
  133839. /**
  133840. * Gizmo that enables viewing a camera
  133841. */
  133842. export class CameraGizmo extends Gizmo {
  133843. private _cameraMesh;
  133844. private _cameraLinesMesh;
  133845. private _material;
  133846. /**
  133847. * Creates a CameraGizmo
  133848. * @param gizmoLayer The utility layer the gizmo will be added to
  133849. */
  133850. constructor(gizmoLayer?: UtilityLayerRenderer);
  133851. private _camera;
  133852. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  133853. get displayFrustum(): boolean;
  133854. set displayFrustum(value: boolean);
  133855. /**
  133856. * The camera that the gizmo is attached to
  133857. */
  133858. set camera(camera: Nullable<Camera>);
  133859. get camera(): Nullable<Camera>;
  133860. /**
  133861. * Gets the material used to render the camera gizmo
  133862. */
  133863. get material(): StandardMaterial;
  133864. /**
  133865. * @hidden
  133866. * Updates the gizmo to match the attached mesh's position/rotation
  133867. */
  133868. protected _update(): void;
  133869. private static _Scale;
  133870. private _invProjection;
  133871. /**
  133872. * Disposes of the camera gizmo
  133873. */
  133874. dispose(): void;
  133875. private static _CreateCameraMesh;
  133876. private static _CreateCameraFrustum;
  133877. }
  133878. }
  133879. declare module BABYLON {
  133880. /** @hidden */
  133881. export var backgroundFragmentDeclaration: {
  133882. name: string;
  133883. shader: string;
  133884. };
  133885. }
  133886. declare module BABYLON {
  133887. /** @hidden */
  133888. export var backgroundUboDeclaration: {
  133889. name: string;
  133890. shader: string;
  133891. };
  133892. }
  133893. declare module BABYLON {
  133894. /** @hidden */
  133895. export var backgroundPixelShader: {
  133896. name: string;
  133897. shader: string;
  133898. };
  133899. }
  133900. declare module BABYLON {
  133901. /** @hidden */
  133902. export var backgroundVertexDeclaration: {
  133903. name: string;
  133904. shader: string;
  133905. };
  133906. }
  133907. declare module BABYLON {
  133908. /** @hidden */
  133909. export var backgroundVertexShader: {
  133910. name: string;
  133911. shader: string;
  133912. };
  133913. }
  133914. declare module BABYLON {
  133915. /**
  133916. * Background material used to create an efficient environement around your scene.
  133917. */
  133918. export class BackgroundMaterial extends PushMaterial {
  133919. /**
  133920. * Standard reflectance value at parallel view angle.
  133921. */
  133922. static StandardReflectance0: number;
  133923. /**
  133924. * Standard reflectance value at grazing angle.
  133925. */
  133926. static StandardReflectance90: number;
  133927. protected _primaryColor: Color3;
  133928. /**
  133929. * Key light Color (multiply against the environement texture)
  133930. */
  133931. primaryColor: Color3;
  133932. protected __perceptualColor: Nullable<Color3>;
  133933. /**
  133934. * Experimental Internal Use Only.
  133935. *
  133936. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  133937. * This acts as a helper to set the primary color to a more "human friendly" value.
  133938. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  133939. * output color as close as possible from the chosen value.
  133940. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  133941. * part of lighting setup.)
  133942. */
  133943. get _perceptualColor(): Nullable<Color3>;
  133944. set _perceptualColor(value: Nullable<Color3>);
  133945. protected _primaryColorShadowLevel: float;
  133946. /**
  133947. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  133948. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  133949. */
  133950. get primaryColorShadowLevel(): float;
  133951. set primaryColorShadowLevel(value: float);
  133952. protected _primaryColorHighlightLevel: float;
  133953. /**
  133954. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  133955. * The primary color is used at the level chosen to define what the white area would look.
  133956. */
  133957. get primaryColorHighlightLevel(): float;
  133958. set primaryColorHighlightLevel(value: float);
  133959. protected _reflectionTexture: Nullable<BaseTexture>;
  133960. /**
  133961. * Reflection Texture used in the material.
  133962. * Should be author in a specific way for the best result (refer to the documentation).
  133963. */
  133964. reflectionTexture: Nullable<BaseTexture>;
  133965. protected _reflectionBlur: float;
  133966. /**
  133967. * Reflection Texture level of blur.
  133968. *
  133969. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  133970. * texture twice.
  133971. */
  133972. reflectionBlur: float;
  133973. protected _diffuseTexture: Nullable<BaseTexture>;
  133974. /**
  133975. * Diffuse Texture used in the material.
  133976. * Should be author in a specific way for the best result (refer to the documentation).
  133977. */
  133978. diffuseTexture: Nullable<BaseTexture>;
  133979. protected _shadowLights: Nullable<IShadowLight[]>;
  133980. /**
  133981. * Specify the list of lights casting shadow on the material.
  133982. * All scene shadow lights will be included if null.
  133983. */
  133984. shadowLights: Nullable<IShadowLight[]>;
  133985. protected _shadowLevel: float;
  133986. /**
  133987. * Helps adjusting the shadow to a softer level if required.
  133988. * 0 means black shadows and 1 means no shadows.
  133989. */
  133990. shadowLevel: float;
  133991. protected _sceneCenter: Vector3;
  133992. /**
  133993. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  133994. * It is usually zero but might be interesting to modify according to your setup.
  133995. */
  133996. sceneCenter: Vector3;
  133997. protected _opacityFresnel: boolean;
  133998. /**
  133999. * This helps specifying that the material is falling off to the sky box at grazing angle.
  134000. * This helps ensuring a nice transition when the camera goes under the ground.
  134001. */
  134002. opacityFresnel: boolean;
  134003. protected _reflectionFresnel: boolean;
  134004. /**
  134005. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  134006. * This helps adding a mirror texture on the ground.
  134007. */
  134008. reflectionFresnel: boolean;
  134009. protected _reflectionFalloffDistance: number;
  134010. /**
  134011. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  134012. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  134013. */
  134014. reflectionFalloffDistance: number;
  134015. protected _reflectionAmount: number;
  134016. /**
  134017. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  134018. */
  134019. reflectionAmount: number;
  134020. protected _reflectionReflectance0: number;
  134021. /**
  134022. * This specifies the weight of the reflection at grazing angle.
  134023. */
  134024. reflectionReflectance0: number;
  134025. protected _reflectionReflectance90: number;
  134026. /**
  134027. * This specifies the weight of the reflection at a perpendicular point of view.
  134028. */
  134029. reflectionReflectance90: number;
  134030. /**
  134031. * Sets the reflection reflectance fresnel values according to the default standard
  134032. * empirically know to work well :-)
  134033. */
  134034. set reflectionStandardFresnelWeight(value: number);
  134035. protected _useRGBColor: boolean;
  134036. /**
  134037. * Helps to directly use the maps channels instead of their level.
  134038. */
  134039. useRGBColor: boolean;
  134040. protected _enableNoise: boolean;
  134041. /**
  134042. * This helps reducing the banding effect that could occur on the background.
  134043. */
  134044. enableNoise: boolean;
  134045. /**
  134046. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134047. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  134048. * Recommended to be keep at 1.0 except for special cases.
  134049. */
  134050. get fovMultiplier(): number;
  134051. set fovMultiplier(value: number);
  134052. private _fovMultiplier;
  134053. /**
  134054. * Enable the FOV adjustment feature controlled by fovMultiplier.
  134055. */
  134056. useEquirectangularFOV: boolean;
  134057. private _maxSimultaneousLights;
  134058. /**
  134059. * Number of Simultaneous lights allowed on the material.
  134060. */
  134061. maxSimultaneousLights: int;
  134062. private _shadowOnly;
  134063. /**
  134064. * Make the material only render shadows
  134065. */
  134066. shadowOnly: boolean;
  134067. /**
  134068. * Default configuration related to image processing available in the Background Material.
  134069. */
  134070. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  134071. /**
  134072. * Keep track of the image processing observer to allow dispose and replace.
  134073. */
  134074. private _imageProcessingObserver;
  134075. /**
  134076. * Attaches a new image processing configuration to the PBR Material.
  134077. * @param configuration (if null the scene configuration will be use)
  134078. */
  134079. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  134080. /**
  134081. * Gets the image processing configuration used either in this material.
  134082. */
  134083. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  134084. /**
  134085. * Sets the Default image processing configuration used either in the this material.
  134086. *
  134087. * If sets to null, the scene one is in use.
  134088. */
  134089. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  134090. /**
  134091. * Gets wether the color curves effect is enabled.
  134092. */
  134093. get cameraColorCurvesEnabled(): boolean;
  134094. /**
  134095. * Sets wether the color curves effect is enabled.
  134096. */
  134097. set cameraColorCurvesEnabled(value: boolean);
  134098. /**
  134099. * Gets wether the color grading effect is enabled.
  134100. */
  134101. get cameraColorGradingEnabled(): boolean;
  134102. /**
  134103. * Gets wether the color grading effect is enabled.
  134104. */
  134105. set cameraColorGradingEnabled(value: boolean);
  134106. /**
  134107. * Gets wether tonemapping is enabled or not.
  134108. */
  134109. get cameraToneMappingEnabled(): boolean;
  134110. /**
  134111. * Sets wether tonemapping is enabled or not
  134112. */
  134113. set cameraToneMappingEnabled(value: boolean);
  134114. /**
  134115. * The camera exposure used on this material.
  134116. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134117. * This corresponds to a photographic exposure.
  134118. */
  134119. get cameraExposure(): float;
  134120. /**
  134121. * The camera exposure used on this material.
  134122. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134123. * This corresponds to a photographic exposure.
  134124. */
  134125. set cameraExposure(value: float);
  134126. /**
  134127. * Gets The camera contrast used on this material.
  134128. */
  134129. get cameraContrast(): float;
  134130. /**
  134131. * Sets The camera contrast used on this material.
  134132. */
  134133. set cameraContrast(value: float);
  134134. /**
  134135. * Gets the Color Grading 2D Lookup Texture.
  134136. */
  134137. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  134138. /**
  134139. * Sets the Color Grading 2D Lookup Texture.
  134140. */
  134141. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  134142. /**
  134143. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134144. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134145. * 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;
  134146. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134147. */
  134148. get cameraColorCurves(): Nullable<ColorCurves>;
  134149. /**
  134150. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134151. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134152. * 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;
  134153. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134154. */
  134155. set cameraColorCurves(value: Nullable<ColorCurves>);
  134156. /**
  134157. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  134158. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  134159. */
  134160. switchToBGR: boolean;
  134161. private _renderTargets;
  134162. private _reflectionControls;
  134163. private _white;
  134164. private _primaryShadowColor;
  134165. private _primaryHighlightColor;
  134166. /**
  134167. * Instantiates a Background Material in the given scene
  134168. * @param name The friendly name of the material
  134169. * @param scene The scene to add the material to
  134170. */
  134171. constructor(name: string, scene: Scene);
  134172. /**
  134173. * Gets a boolean indicating that current material needs to register RTT
  134174. */
  134175. get hasRenderTargetTextures(): boolean;
  134176. /**
  134177. * The entire material has been created in order to prevent overdraw.
  134178. * @returns false
  134179. */
  134180. needAlphaTesting(): boolean;
  134181. /**
  134182. * The entire material has been created in order to prevent overdraw.
  134183. * @returns true if blending is enable
  134184. */
  134185. needAlphaBlending(): boolean;
  134186. /**
  134187. * Checks wether the material is ready to be rendered for a given mesh.
  134188. * @param mesh The mesh to render
  134189. * @param subMesh The submesh to check against
  134190. * @param useInstances Specify wether or not the material is used with instances
  134191. * @returns true if all the dependencies are ready (Textures, Effects...)
  134192. */
  134193. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  134194. /**
  134195. * Compute the primary color according to the chosen perceptual color.
  134196. */
  134197. private _computePrimaryColorFromPerceptualColor;
  134198. /**
  134199. * Compute the highlights and shadow colors according to their chosen levels.
  134200. */
  134201. private _computePrimaryColors;
  134202. /**
  134203. * Build the uniform buffer used in the material.
  134204. */
  134205. buildUniformLayout(): void;
  134206. /**
  134207. * Unbind the material.
  134208. */
  134209. unbind(): void;
  134210. /**
  134211. * Bind only the world matrix to the material.
  134212. * @param world The world matrix to bind.
  134213. */
  134214. bindOnlyWorldMatrix(world: Matrix): void;
  134215. /**
  134216. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  134217. * @param world The world matrix to bind.
  134218. * @param subMesh The submesh to bind for.
  134219. */
  134220. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  134221. /**
  134222. * Checks to see if a texture is used in the material.
  134223. * @param texture - Base texture to use.
  134224. * @returns - Boolean specifying if a texture is used in the material.
  134225. */
  134226. hasTexture(texture: BaseTexture): boolean;
  134227. /**
  134228. * Dispose the material.
  134229. * @param forceDisposeEffect Force disposal of the associated effect.
  134230. * @param forceDisposeTextures Force disposal of the associated textures.
  134231. */
  134232. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  134233. /**
  134234. * Clones the material.
  134235. * @param name The cloned name.
  134236. * @returns The cloned material.
  134237. */
  134238. clone(name: string): BackgroundMaterial;
  134239. /**
  134240. * Serializes the current material to its JSON representation.
  134241. * @returns The JSON representation.
  134242. */
  134243. serialize(): any;
  134244. /**
  134245. * Gets the class name of the material
  134246. * @returns "BackgroundMaterial"
  134247. */
  134248. getClassName(): string;
  134249. /**
  134250. * Parse a JSON input to create back a background material.
  134251. * @param source The JSON data to parse
  134252. * @param scene The scene to create the parsed material in
  134253. * @param rootUrl The root url of the assets the material depends upon
  134254. * @returns the instantiated BackgroundMaterial.
  134255. */
  134256. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  134257. }
  134258. }
  134259. declare module BABYLON {
  134260. /**
  134261. * Represents the different options available during the creation of
  134262. * a Environment helper.
  134263. *
  134264. * This can control the default ground, skybox and image processing setup of your scene.
  134265. */
  134266. export interface IEnvironmentHelperOptions {
  134267. /**
  134268. * Specifies whether or not to create a ground.
  134269. * True by default.
  134270. */
  134271. createGround: boolean;
  134272. /**
  134273. * Specifies the ground size.
  134274. * 15 by default.
  134275. */
  134276. groundSize: number;
  134277. /**
  134278. * The texture used on the ground for the main color.
  134279. * Comes from the BabylonJS CDN by default.
  134280. *
  134281. * Remarks: Can be either a texture or a url.
  134282. */
  134283. groundTexture: string | BaseTexture;
  134284. /**
  134285. * The color mixed in the ground texture by default.
  134286. * BabylonJS clearColor by default.
  134287. */
  134288. groundColor: Color3;
  134289. /**
  134290. * Specifies the ground opacity.
  134291. * 1 by default.
  134292. */
  134293. groundOpacity: number;
  134294. /**
  134295. * Enables the ground to receive shadows.
  134296. * True by default.
  134297. */
  134298. enableGroundShadow: boolean;
  134299. /**
  134300. * Helps preventing the shadow to be fully black on the ground.
  134301. * 0.5 by default.
  134302. */
  134303. groundShadowLevel: number;
  134304. /**
  134305. * Creates a mirror texture attach to the ground.
  134306. * false by default.
  134307. */
  134308. enableGroundMirror: boolean;
  134309. /**
  134310. * Specifies the ground mirror size ratio.
  134311. * 0.3 by default as the default kernel is 64.
  134312. */
  134313. groundMirrorSizeRatio: number;
  134314. /**
  134315. * Specifies the ground mirror blur kernel size.
  134316. * 64 by default.
  134317. */
  134318. groundMirrorBlurKernel: number;
  134319. /**
  134320. * Specifies the ground mirror visibility amount.
  134321. * 1 by default
  134322. */
  134323. groundMirrorAmount: number;
  134324. /**
  134325. * Specifies the ground mirror reflectance weight.
  134326. * This uses the standard weight of the background material to setup the fresnel effect
  134327. * of the mirror.
  134328. * 1 by default.
  134329. */
  134330. groundMirrorFresnelWeight: number;
  134331. /**
  134332. * Specifies the ground mirror Falloff distance.
  134333. * This can helps reducing the size of the reflection.
  134334. * 0 by Default.
  134335. */
  134336. groundMirrorFallOffDistance: number;
  134337. /**
  134338. * Specifies the ground mirror texture type.
  134339. * Unsigned Int by Default.
  134340. */
  134341. groundMirrorTextureType: number;
  134342. /**
  134343. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  134344. * the shown objects.
  134345. */
  134346. groundYBias: number;
  134347. /**
  134348. * Specifies whether or not to create a skybox.
  134349. * True by default.
  134350. */
  134351. createSkybox: boolean;
  134352. /**
  134353. * Specifies the skybox size.
  134354. * 20 by default.
  134355. */
  134356. skyboxSize: number;
  134357. /**
  134358. * The texture used on the skybox for the main color.
  134359. * Comes from the BabylonJS CDN by default.
  134360. *
  134361. * Remarks: Can be either a texture or a url.
  134362. */
  134363. skyboxTexture: string | BaseTexture;
  134364. /**
  134365. * The color mixed in the skybox texture by default.
  134366. * BabylonJS clearColor by default.
  134367. */
  134368. skyboxColor: Color3;
  134369. /**
  134370. * The background rotation around the Y axis of the scene.
  134371. * This helps aligning the key lights of your scene with the background.
  134372. * 0 by default.
  134373. */
  134374. backgroundYRotation: number;
  134375. /**
  134376. * Compute automatically the size of the elements to best fit with the scene.
  134377. */
  134378. sizeAuto: boolean;
  134379. /**
  134380. * Default position of the rootMesh if autoSize is not true.
  134381. */
  134382. rootPosition: Vector3;
  134383. /**
  134384. * Sets up the image processing in the scene.
  134385. * true by default.
  134386. */
  134387. setupImageProcessing: boolean;
  134388. /**
  134389. * The texture used as your environment texture in the scene.
  134390. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  134391. *
  134392. * Remarks: Can be either a texture or a url.
  134393. */
  134394. environmentTexture: string | BaseTexture;
  134395. /**
  134396. * The value of the exposure to apply to the scene.
  134397. * 0.6 by default if setupImageProcessing is true.
  134398. */
  134399. cameraExposure: number;
  134400. /**
  134401. * The value of the contrast to apply to the scene.
  134402. * 1.6 by default if setupImageProcessing is true.
  134403. */
  134404. cameraContrast: number;
  134405. /**
  134406. * Specifies whether or not tonemapping should be enabled in the scene.
  134407. * true by default if setupImageProcessing is true.
  134408. */
  134409. toneMappingEnabled: boolean;
  134410. }
  134411. /**
  134412. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  134413. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  134414. * It also helps with the default setup of your imageProcessing configuration.
  134415. */
  134416. export class EnvironmentHelper {
  134417. /**
  134418. * Default ground texture URL.
  134419. */
  134420. private static _groundTextureCDNUrl;
  134421. /**
  134422. * Default skybox texture URL.
  134423. */
  134424. private static _skyboxTextureCDNUrl;
  134425. /**
  134426. * Default environment texture URL.
  134427. */
  134428. private static _environmentTextureCDNUrl;
  134429. /**
  134430. * Creates the default options for the helper.
  134431. */
  134432. private static _getDefaultOptions;
  134433. private _rootMesh;
  134434. /**
  134435. * Gets the root mesh created by the helper.
  134436. */
  134437. get rootMesh(): Mesh;
  134438. private _skybox;
  134439. /**
  134440. * Gets the skybox created by the helper.
  134441. */
  134442. get skybox(): Nullable<Mesh>;
  134443. private _skyboxTexture;
  134444. /**
  134445. * Gets the skybox texture created by the helper.
  134446. */
  134447. get skyboxTexture(): Nullable<BaseTexture>;
  134448. private _skyboxMaterial;
  134449. /**
  134450. * Gets the skybox material created by the helper.
  134451. */
  134452. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  134453. private _ground;
  134454. /**
  134455. * Gets the ground mesh created by the helper.
  134456. */
  134457. get ground(): Nullable<Mesh>;
  134458. private _groundTexture;
  134459. /**
  134460. * Gets the ground texture created by the helper.
  134461. */
  134462. get groundTexture(): Nullable<BaseTexture>;
  134463. private _groundMirror;
  134464. /**
  134465. * Gets the ground mirror created by the helper.
  134466. */
  134467. get groundMirror(): Nullable<MirrorTexture>;
  134468. /**
  134469. * Gets the ground mirror render list to helps pushing the meshes
  134470. * you wish in the ground reflection.
  134471. */
  134472. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  134473. private _groundMaterial;
  134474. /**
  134475. * Gets the ground material created by the helper.
  134476. */
  134477. get groundMaterial(): Nullable<BackgroundMaterial>;
  134478. /**
  134479. * Stores the creation options.
  134480. */
  134481. private readonly _scene;
  134482. private _options;
  134483. /**
  134484. * This observable will be notified with any error during the creation of the environment,
  134485. * mainly texture creation errors.
  134486. */
  134487. onErrorObservable: Observable<{
  134488. message?: string;
  134489. exception?: any;
  134490. }>;
  134491. /**
  134492. * constructor
  134493. * @param options Defines the options we want to customize the helper
  134494. * @param scene The scene to add the material to
  134495. */
  134496. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  134497. /**
  134498. * Updates the background according to the new options
  134499. * @param options
  134500. */
  134501. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  134502. /**
  134503. * Sets the primary color of all the available elements.
  134504. * @param color the main color to affect to the ground and the background
  134505. */
  134506. setMainColor(color: Color3): void;
  134507. /**
  134508. * Setup the image processing according to the specified options.
  134509. */
  134510. private _setupImageProcessing;
  134511. /**
  134512. * Setup the environment texture according to the specified options.
  134513. */
  134514. private _setupEnvironmentTexture;
  134515. /**
  134516. * Setup the background according to the specified options.
  134517. */
  134518. private _setupBackground;
  134519. /**
  134520. * Get the scene sizes according to the setup.
  134521. */
  134522. private _getSceneSize;
  134523. /**
  134524. * Setup the ground according to the specified options.
  134525. */
  134526. private _setupGround;
  134527. /**
  134528. * Setup the ground material according to the specified options.
  134529. */
  134530. private _setupGroundMaterial;
  134531. /**
  134532. * Setup the ground diffuse texture according to the specified options.
  134533. */
  134534. private _setupGroundDiffuseTexture;
  134535. /**
  134536. * Setup the ground mirror texture according to the specified options.
  134537. */
  134538. private _setupGroundMirrorTexture;
  134539. /**
  134540. * Setup the ground to receive the mirror texture.
  134541. */
  134542. private _setupMirrorInGroundMaterial;
  134543. /**
  134544. * Setup the skybox according to the specified options.
  134545. */
  134546. private _setupSkybox;
  134547. /**
  134548. * Setup the skybox material according to the specified options.
  134549. */
  134550. private _setupSkyboxMaterial;
  134551. /**
  134552. * Setup the skybox reflection texture according to the specified options.
  134553. */
  134554. private _setupSkyboxReflectionTexture;
  134555. private _errorHandler;
  134556. /**
  134557. * Dispose all the elements created by the Helper.
  134558. */
  134559. dispose(): void;
  134560. }
  134561. }
  134562. declare module BABYLON {
  134563. /**
  134564. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  134565. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  134566. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134567. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134568. */
  134569. export abstract class TextureDome<T extends Texture> extends TransformNode {
  134570. protected onError: Nullable<(message?: string, exception?: any) => void>;
  134571. /**
  134572. * Define the source as a Monoscopic panoramic 360/180.
  134573. */
  134574. static readonly MODE_MONOSCOPIC: number;
  134575. /**
  134576. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  134577. */
  134578. static readonly MODE_TOPBOTTOM: number;
  134579. /**
  134580. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  134581. */
  134582. static readonly MODE_SIDEBYSIDE: number;
  134583. private _halfDome;
  134584. protected _useDirectMapping: boolean;
  134585. /**
  134586. * The texture being displayed on the sphere
  134587. */
  134588. protected _texture: T;
  134589. /**
  134590. * Gets the texture being displayed on the sphere
  134591. */
  134592. get texture(): T;
  134593. /**
  134594. * Sets the texture being displayed on the sphere
  134595. */
  134596. set texture(newTexture: T);
  134597. /**
  134598. * The skybox material
  134599. */
  134600. protected _material: BackgroundMaterial;
  134601. /**
  134602. * The surface used for the dome
  134603. */
  134604. protected _mesh: Mesh;
  134605. /**
  134606. * Gets the mesh used for the dome.
  134607. */
  134608. get mesh(): Mesh;
  134609. /**
  134610. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  134611. */
  134612. private _halfDomeMask;
  134613. /**
  134614. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134615. * Also see the options.resolution property.
  134616. */
  134617. get fovMultiplier(): number;
  134618. set fovMultiplier(value: number);
  134619. protected _textureMode: number;
  134620. /**
  134621. * Gets or set the current texture mode for the texture. It can be:
  134622. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134623. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134624. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134625. */
  134626. get textureMode(): number;
  134627. /**
  134628. * Sets the current texture mode for the texture. It can be:
  134629. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134630. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134631. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134632. */
  134633. set textureMode(value: number);
  134634. /**
  134635. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  134636. */
  134637. get halfDome(): boolean;
  134638. /**
  134639. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  134640. */
  134641. set halfDome(enabled: boolean);
  134642. /**
  134643. * Oberserver used in Stereoscopic VR Mode.
  134644. */
  134645. private _onBeforeCameraRenderObserver;
  134646. /**
  134647. * Observable raised when an error occured while loading the 360 image
  134648. */
  134649. onLoadErrorObservable: Observable<string>;
  134650. /**
  134651. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  134652. * @param name Element's name, child elements will append suffixes for their own names.
  134653. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  134654. * @param options An object containing optional or exposed sub element properties
  134655. */
  134656. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  134657. resolution?: number;
  134658. clickToPlay?: boolean;
  134659. autoPlay?: boolean;
  134660. loop?: boolean;
  134661. size?: number;
  134662. poster?: string;
  134663. faceForward?: boolean;
  134664. useDirectMapping?: boolean;
  134665. halfDomeMode?: boolean;
  134666. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  134667. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  134668. protected _changeTextureMode(value: number): void;
  134669. /**
  134670. * Releases resources associated with this node.
  134671. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  134672. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  134673. */
  134674. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  134675. }
  134676. }
  134677. declare module BABYLON {
  134678. /**
  134679. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  134680. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  134681. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134682. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134683. */
  134684. export class PhotoDome extends TextureDome<Texture> {
  134685. /**
  134686. * Define the image as a Monoscopic panoramic 360 image.
  134687. */
  134688. static readonly MODE_MONOSCOPIC: number;
  134689. /**
  134690. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  134691. */
  134692. static readonly MODE_TOPBOTTOM: number;
  134693. /**
  134694. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  134695. */
  134696. static readonly MODE_SIDEBYSIDE: number;
  134697. /**
  134698. * Gets or sets the texture being displayed on the sphere
  134699. */
  134700. get photoTexture(): Texture;
  134701. /**
  134702. * sets the texture being displayed on the sphere
  134703. */
  134704. set photoTexture(value: Texture);
  134705. /**
  134706. * Gets the current video mode for the video. It can be:
  134707. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134708. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134709. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134710. */
  134711. get imageMode(): number;
  134712. /**
  134713. * Sets the current video mode for the video. It can be:
  134714. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134715. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134716. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134717. */
  134718. set imageMode(value: number);
  134719. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  134720. }
  134721. }
  134722. declare module BABYLON {
  134723. /**
  134724. * Class used to host RGBD texture specific utilities
  134725. */
  134726. export class RGBDTextureTools {
  134727. /**
  134728. * Expand the RGBD Texture from RGBD to Half Float if possible.
  134729. * @param texture the texture to expand.
  134730. */
  134731. static ExpandRGBDTexture(texture: Texture): void;
  134732. }
  134733. }
  134734. declare module BABYLON {
  134735. /**
  134736. * Class used to host texture specific utilities
  134737. */
  134738. export class BRDFTextureTools {
  134739. /**
  134740. * Prevents texture cache collision
  134741. */
  134742. private static _instanceNumber;
  134743. /**
  134744. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  134745. * @param scene defines the hosting scene
  134746. * @returns the environment BRDF texture
  134747. */
  134748. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  134749. private static _environmentBRDFBase64Texture;
  134750. }
  134751. }
  134752. declare module BABYLON {
  134753. /**
  134754. * @hidden
  134755. */
  134756. export interface IMaterialClearCoatDefines {
  134757. CLEARCOAT: boolean;
  134758. CLEARCOAT_DEFAULTIOR: boolean;
  134759. CLEARCOAT_TEXTURE: boolean;
  134760. CLEARCOAT_TEXTUREDIRECTUV: number;
  134761. CLEARCOAT_BUMP: boolean;
  134762. CLEARCOAT_BUMPDIRECTUV: number;
  134763. CLEARCOAT_TINT: boolean;
  134764. CLEARCOAT_TINT_TEXTURE: boolean;
  134765. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  134766. /** @hidden */
  134767. _areTexturesDirty: boolean;
  134768. }
  134769. /**
  134770. * Define the code related to the clear coat parameters of the pbr material.
  134771. */
  134772. export class PBRClearCoatConfiguration {
  134773. /**
  134774. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134775. * The default fits with a polyurethane material.
  134776. */
  134777. private static readonly _DefaultIndexOfRefraction;
  134778. private _isEnabled;
  134779. /**
  134780. * Defines if the clear coat is enabled in the material.
  134781. */
  134782. isEnabled: boolean;
  134783. /**
  134784. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  134785. */
  134786. intensity: number;
  134787. /**
  134788. * Defines the clear coat layer roughness.
  134789. */
  134790. roughness: number;
  134791. private _indexOfRefraction;
  134792. /**
  134793. * Defines the index of refraction of the clear coat.
  134794. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134795. * The default fits with a polyurethane material.
  134796. * Changing the default value is more performance intensive.
  134797. */
  134798. indexOfRefraction: number;
  134799. private _texture;
  134800. /**
  134801. * Stores the clear coat values in a texture.
  134802. */
  134803. texture: Nullable<BaseTexture>;
  134804. private _bumpTexture;
  134805. /**
  134806. * Define the clear coat specific bump texture.
  134807. */
  134808. bumpTexture: Nullable<BaseTexture>;
  134809. private _isTintEnabled;
  134810. /**
  134811. * Defines if the clear coat tint is enabled in the material.
  134812. */
  134813. isTintEnabled: boolean;
  134814. /**
  134815. * Defines the clear coat tint of the material.
  134816. * This is only use if tint is enabled
  134817. */
  134818. tintColor: Color3;
  134819. /**
  134820. * Defines the distance at which the tint color should be found in the
  134821. * clear coat media.
  134822. * This is only use if tint is enabled
  134823. */
  134824. tintColorAtDistance: number;
  134825. /**
  134826. * Defines the clear coat layer thickness.
  134827. * This is only use if tint is enabled
  134828. */
  134829. tintThickness: number;
  134830. private _tintTexture;
  134831. /**
  134832. * Stores the clear tint values in a texture.
  134833. * rgb is tint
  134834. * a is a thickness factor
  134835. */
  134836. tintTexture: Nullable<BaseTexture>;
  134837. /** @hidden */
  134838. private _internalMarkAllSubMeshesAsTexturesDirty;
  134839. /** @hidden */
  134840. _markAllSubMeshesAsTexturesDirty(): void;
  134841. /**
  134842. * Instantiate a new istance of clear coat configuration.
  134843. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134844. */
  134845. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134846. /**
  134847. * Gets wehter the submesh is ready to be used or not.
  134848. * @param defines the list of "defines" to update.
  134849. * @param scene defines the scene the material belongs to.
  134850. * @param engine defines the engine the material belongs to.
  134851. * @param disableBumpMap defines wether the material disables bump or not.
  134852. * @returns - boolean indicating that the submesh is ready or not.
  134853. */
  134854. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  134855. /**
  134856. * Checks to see if a texture is used in the material.
  134857. * @param defines the list of "defines" to update.
  134858. * @param scene defines the scene to the material belongs to.
  134859. */
  134860. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  134861. /**
  134862. * Binds the material data.
  134863. * @param uniformBuffer defines the Uniform buffer to fill in.
  134864. * @param scene defines the scene the material belongs to.
  134865. * @param engine defines the engine the material belongs to.
  134866. * @param disableBumpMap defines wether the material disables bump or not.
  134867. * @param isFrozen defines wether the material is frozen or not.
  134868. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  134869. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  134870. */
  134871. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  134872. /**
  134873. * Checks to see if a texture is used in the material.
  134874. * @param texture - Base texture to use.
  134875. * @returns - Boolean specifying if a texture is used in the material.
  134876. */
  134877. hasTexture(texture: BaseTexture): boolean;
  134878. /**
  134879. * Returns an array of the actively used textures.
  134880. * @param activeTextures Array of BaseTextures
  134881. */
  134882. getActiveTextures(activeTextures: BaseTexture[]): void;
  134883. /**
  134884. * Returns the animatable textures.
  134885. * @param animatables Array of animatable textures.
  134886. */
  134887. getAnimatables(animatables: IAnimatable[]): void;
  134888. /**
  134889. * Disposes the resources of the material.
  134890. * @param forceDisposeTextures - Forces the disposal of all textures.
  134891. */
  134892. dispose(forceDisposeTextures?: boolean): void;
  134893. /**
  134894. * Get the current class name of the texture useful for serialization or dynamic coding.
  134895. * @returns "PBRClearCoatConfiguration"
  134896. */
  134897. getClassName(): string;
  134898. /**
  134899. * Add fallbacks to the effect fallbacks list.
  134900. * @param defines defines the Base texture to use.
  134901. * @param fallbacks defines the current fallback list.
  134902. * @param currentRank defines the current fallback rank.
  134903. * @returns the new fallback rank.
  134904. */
  134905. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  134906. /**
  134907. * Add the required uniforms to the current list.
  134908. * @param uniforms defines the current uniform list.
  134909. */
  134910. static AddUniforms(uniforms: string[]): void;
  134911. /**
  134912. * Add the required samplers to the current list.
  134913. * @param samplers defines the current sampler list.
  134914. */
  134915. static AddSamplers(samplers: string[]): void;
  134916. /**
  134917. * Add the required uniforms to the current buffer.
  134918. * @param uniformBuffer defines the current uniform buffer.
  134919. */
  134920. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  134921. /**
  134922. * Makes a duplicate of the current configuration into another one.
  134923. * @param clearCoatConfiguration define the config where to copy the info
  134924. */
  134925. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  134926. /**
  134927. * Serializes this clear coat configuration.
  134928. * @returns - An object with the serialized config.
  134929. */
  134930. serialize(): any;
  134931. /**
  134932. * Parses a anisotropy Configuration from a serialized object.
  134933. * @param source - Serialized object.
  134934. * @param scene Defines the scene we are parsing for
  134935. * @param rootUrl Defines the rootUrl to load from
  134936. */
  134937. parse(source: any, scene: Scene, rootUrl: string): void;
  134938. }
  134939. }
  134940. declare module BABYLON {
  134941. /**
  134942. * @hidden
  134943. */
  134944. export interface IMaterialAnisotropicDefines {
  134945. ANISOTROPIC: boolean;
  134946. ANISOTROPIC_TEXTURE: boolean;
  134947. ANISOTROPIC_TEXTUREDIRECTUV: number;
  134948. MAINUV1: boolean;
  134949. _areTexturesDirty: boolean;
  134950. _needUVs: boolean;
  134951. }
  134952. /**
  134953. * Define the code related to the anisotropic parameters of the pbr material.
  134954. */
  134955. export class PBRAnisotropicConfiguration {
  134956. private _isEnabled;
  134957. /**
  134958. * Defines if the anisotropy is enabled in the material.
  134959. */
  134960. isEnabled: boolean;
  134961. /**
  134962. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  134963. */
  134964. intensity: number;
  134965. /**
  134966. * Defines if the effect is along the tangents, bitangents or in between.
  134967. * By default, the effect is "strectching" the highlights along the tangents.
  134968. */
  134969. direction: Vector2;
  134970. private _texture;
  134971. /**
  134972. * Stores the anisotropy values in a texture.
  134973. * rg is direction (like normal from -1 to 1)
  134974. * b is a intensity
  134975. */
  134976. texture: Nullable<BaseTexture>;
  134977. /** @hidden */
  134978. private _internalMarkAllSubMeshesAsTexturesDirty;
  134979. /** @hidden */
  134980. _markAllSubMeshesAsTexturesDirty(): void;
  134981. /**
  134982. * Instantiate a new istance of anisotropy configuration.
  134983. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134984. */
  134985. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134986. /**
  134987. * Specifies that the submesh is ready to be used.
  134988. * @param defines the list of "defines" to update.
  134989. * @param scene defines the scene the material belongs to.
  134990. * @returns - boolean indicating that the submesh is ready or not.
  134991. */
  134992. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  134993. /**
  134994. * Checks to see if a texture is used in the material.
  134995. * @param defines the list of "defines" to update.
  134996. * @param mesh the mesh we are preparing the defines for.
  134997. * @param scene defines the scene the material belongs to.
  134998. */
  134999. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  135000. /**
  135001. * Binds the material data.
  135002. * @param uniformBuffer defines the Uniform buffer to fill in.
  135003. * @param scene defines the scene the material belongs to.
  135004. * @param isFrozen defines wether the material is frozen or not.
  135005. */
  135006. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135007. /**
  135008. * Checks to see if a texture is used in the material.
  135009. * @param texture - Base texture to use.
  135010. * @returns - Boolean specifying if a texture is used in the material.
  135011. */
  135012. hasTexture(texture: BaseTexture): boolean;
  135013. /**
  135014. * Returns an array of the actively used textures.
  135015. * @param activeTextures Array of BaseTextures
  135016. */
  135017. getActiveTextures(activeTextures: BaseTexture[]): void;
  135018. /**
  135019. * Returns the animatable textures.
  135020. * @param animatables Array of animatable textures.
  135021. */
  135022. getAnimatables(animatables: IAnimatable[]): void;
  135023. /**
  135024. * Disposes the resources of the material.
  135025. * @param forceDisposeTextures - Forces the disposal of all textures.
  135026. */
  135027. dispose(forceDisposeTextures?: boolean): void;
  135028. /**
  135029. * Get the current class name of the texture useful for serialization or dynamic coding.
  135030. * @returns "PBRAnisotropicConfiguration"
  135031. */
  135032. getClassName(): string;
  135033. /**
  135034. * Add fallbacks to the effect fallbacks list.
  135035. * @param defines defines the Base texture to use.
  135036. * @param fallbacks defines the current fallback list.
  135037. * @param currentRank defines the current fallback rank.
  135038. * @returns the new fallback rank.
  135039. */
  135040. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135041. /**
  135042. * Add the required uniforms to the current list.
  135043. * @param uniforms defines the current uniform list.
  135044. */
  135045. static AddUniforms(uniforms: string[]): void;
  135046. /**
  135047. * Add the required uniforms to the current buffer.
  135048. * @param uniformBuffer defines the current uniform buffer.
  135049. */
  135050. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135051. /**
  135052. * Add the required samplers to the current list.
  135053. * @param samplers defines the current sampler list.
  135054. */
  135055. static AddSamplers(samplers: string[]): void;
  135056. /**
  135057. * Makes a duplicate of the current configuration into another one.
  135058. * @param anisotropicConfiguration define the config where to copy the info
  135059. */
  135060. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  135061. /**
  135062. * Serializes this anisotropy configuration.
  135063. * @returns - An object with the serialized config.
  135064. */
  135065. serialize(): any;
  135066. /**
  135067. * Parses a anisotropy Configuration from a serialized object.
  135068. * @param source - Serialized object.
  135069. * @param scene Defines the scene we are parsing for
  135070. * @param rootUrl Defines the rootUrl to load from
  135071. */
  135072. parse(source: any, scene: Scene, rootUrl: string): void;
  135073. }
  135074. }
  135075. declare module BABYLON {
  135076. /**
  135077. * @hidden
  135078. */
  135079. export interface IMaterialBRDFDefines {
  135080. BRDF_V_HEIGHT_CORRELATED: boolean;
  135081. MS_BRDF_ENERGY_CONSERVATION: boolean;
  135082. SPHERICAL_HARMONICS: boolean;
  135083. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  135084. /** @hidden */
  135085. _areMiscDirty: boolean;
  135086. }
  135087. /**
  135088. * Define the code related to the BRDF parameters of the pbr material.
  135089. */
  135090. export class PBRBRDFConfiguration {
  135091. /**
  135092. * Default value used for the energy conservation.
  135093. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135094. */
  135095. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  135096. /**
  135097. * Default value used for the Smith Visibility Height Correlated mode.
  135098. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135099. */
  135100. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  135101. /**
  135102. * Default value used for the IBL diffuse part.
  135103. * This can help switching back to the polynomials mode globally which is a tiny bit
  135104. * less GPU intensive at the drawback of a lower quality.
  135105. */
  135106. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  135107. /**
  135108. * Default value used for activating energy conservation for the specular workflow.
  135109. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135110. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135111. */
  135112. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  135113. private _useEnergyConservation;
  135114. /**
  135115. * Defines if the material uses energy conservation.
  135116. */
  135117. useEnergyConservation: boolean;
  135118. private _useSmithVisibilityHeightCorrelated;
  135119. /**
  135120. * LEGACY Mode set to false
  135121. * Defines if the material uses height smith correlated visibility term.
  135122. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  135123. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  135124. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  135125. * Not relying on height correlated will also disable energy conservation.
  135126. */
  135127. useSmithVisibilityHeightCorrelated: boolean;
  135128. private _useSphericalHarmonics;
  135129. /**
  135130. * LEGACY Mode set to false
  135131. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  135132. * diffuse part of the IBL.
  135133. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  135134. * to the ground truth.
  135135. */
  135136. useSphericalHarmonics: boolean;
  135137. private _useSpecularGlossinessInputEnergyConservation;
  135138. /**
  135139. * Defines if the material uses energy conservation, when the specular workflow is active.
  135140. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135141. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135142. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  135143. */
  135144. useSpecularGlossinessInputEnergyConservation: boolean;
  135145. /** @hidden */
  135146. private _internalMarkAllSubMeshesAsMiscDirty;
  135147. /** @hidden */
  135148. _markAllSubMeshesAsMiscDirty(): void;
  135149. /**
  135150. * Instantiate a new istance of clear coat configuration.
  135151. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  135152. */
  135153. constructor(markAllSubMeshesAsMiscDirty: () => void);
  135154. /**
  135155. * Checks to see if a texture is used in the material.
  135156. * @param defines the list of "defines" to update.
  135157. */
  135158. prepareDefines(defines: IMaterialBRDFDefines): void;
  135159. /**
  135160. * Get the current class name of the texture useful for serialization or dynamic coding.
  135161. * @returns "PBRClearCoatConfiguration"
  135162. */
  135163. getClassName(): string;
  135164. /**
  135165. * Makes a duplicate of the current configuration into another one.
  135166. * @param brdfConfiguration define the config where to copy the info
  135167. */
  135168. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  135169. /**
  135170. * Serializes this BRDF configuration.
  135171. * @returns - An object with the serialized config.
  135172. */
  135173. serialize(): any;
  135174. /**
  135175. * Parses a anisotropy Configuration from a serialized object.
  135176. * @param source - Serialized object.
  135177. * @param scene Defines the scene we are parsing for
  135178. * @param rootUrl Defines the rootUrl to load from
  135179. */
  135180. parse(source: any, scene: Scene, rootUrl: string): void;
  135181. }
  135182. }
  135183. declare module BABYLON {
  135184. /**
  135185. * @hidden
  135186. */
  135187. export interface IMaterialSheenDefines {
  135188. SHEEN: boolean;
  135189. SHEEN_TEXTURE: boolean;
  135190. SHEEN_TEXTUREDIRECTUV: number;
  135191. SHEEN_LINKWITHALBEDO: boolean;
  135192. SHEEN_ROUGHNESS: boolean;
  135193. SHEEN_ALBEDOSCALING: boolean;
  135194. /** @hidden */
  135195. _areTexturesDirty: boolean;
  135196. }
  135197. /**
  135198. * Define the code related to the Sheen parameters of the pbr material.
  135199. */
  135200. export class PBRSheenConfiguration {
  135201. private _isEnabled;
  135202. /**
  135203. * Defines if the material uses sheen.
  135204. */
  135205. isEnabled: boolean;
  135206. private _linkSheenWithAlbedo;
  135207. /**
  135208. * Defines if the sheen is linked to the sheen color.
  135209. */
  135210. linkSheenWithAlbedo: boolean;
  135211. /**
  135212. * Defines the sheen intensity.
  135213. */
  135214. intensity: number;
  135215. /**
  135216. * Defines the sheen color.
  135217. */
  135218. color: Color3;
  135219. private _texture;
  135220. /**
  135221. * Stores the sheen tint values in a texture.
  135222. * rgb is tint
  135223. * a is a intensity or roughness if roughness has been defined
  135224. */
  135225. texture: Nullable<BaseTexture>;
  135226. private _roughness;
  135227. /**
  135228. * Defines the sheen roughness.
  135229. * It is not taken into account if linkSheenWithAlbedo is true.
  135230. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  135231. */
  135232. roughness: Nullable<number>;
  135233. private _albedoScaling;
  135234. /**
  135235. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  135236. * It allows the strength of the sheen effect to not depend on the base color of the material,
  135237. * making it easier to setup and tweak the effect
  135238. */
  135239. albedoScaling: boolean;
  135240. /** @hidden */
  135241. private _internalMarkAllSubMeshesAsTexturesDirty;
  135242. /** @hidden */
  135243. _markAllSubMeshesAsTexturesDirty(): void;
  135244. /**
  135245. * Instantiate a new istance of clear coat configuration.
  135246. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135247. */
  135248. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135249. /**
  135250. * Specifies that the submesh is ready to be used.
  135251. * @param defines the list of "defines" to update.
  135252. * @param scene defines the scene the material belongs to.
  135253. * @returns - boolean indicating that the submesh is ready or not.
  135254. */
  135255. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  135256. /**
  135257. * Checks to see if a texture is used in the material.
  135258. * @param defines the list of "defines" to update.
  135259. * @param scene defines the scene the material belongs to.
  135260. */
  135261. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  135262. /**
  135263. * Binds the material data.
  135264. * @param uniformBuffer defines the Uniform buffer to fill in.
  135265. * @param scene defines the scene the material belongs to.
  135266. * @param isFrozen defines wether the material is frozen or not.
  135267. */
  135268. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135269. /**
  135270. * Checks to see if a texture is used in the material.
  135271. * @param texture - Base texture to use.
  135272. * @returns - Boolean specifying if a texture is used in the material.
  135273. */
  135274. hasTexture(texture: BaseTexture): boolean;
  135275. /**
  135276. * Returns an array of the actively used textures.
  135277. * @param activeTextures Array of BaseTextures
  135278. */
  135279. getActiveTextures(activeTextures: BaseTexture[]): void;
  135280. /**
  135281. * Returns the animatable textures.
  135282. * @param animatables Array of animatable textures.
  135283. */
  135284. getAnimatables(animatables: IAnimatable[]): void;
  135285. /**
  135286. * Disposes the resources of the material.
  135287. * @param forceDisposeTextures - Forces the disposal of all textures.
  135288. */
  135289. dispose(forceDisposeTextures?: boolean): void;
  135290. /**
  135291. * Get the current class name of the texture useful for serialization or dynamic coding.
  135292. * @returns "PBRSheenConfiguration"
  135293. */
  135294. getClassName(): string;
  135295. /**
  135296. * Add fallbacks to the effect fallbacks list.
  135297. * @param defines defines the Base texture to use.
  135298. * @param fallbacks defines the current fallback list.
  135299. * @param currentRank defines the current fallback rank.
  135300. * @returns the new fallback rank.
  135301. */
  135302. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135303. /**
  135304. * Add the required uniforms to the current list.
  135305. * @param uniforms defines the current uniform list.
  135306. */
  135307. static AddUniforms(uniforms: string[]): void;
  135308. /**
  135309. * Add the required uniforms to the current buffer.
  135310. * @param uniformBuffer defines the current uniform buffer.
  135311. */
  135312. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135313. /**
  135314. * Add the required samplers to the current list.
  135315. * @param samplers defines the current sampler list.
  135316. */
  135317. static AddSamplers(samplers: string[]): void;
  135318. /**
  135319. * Makes a duplicate of the current configuration into another one.
  135320. * @param sheenConfiguration define the config where to copy the info
  135321. */
  135322. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  135323. /**
  135324. * Serializes this BRDF configuration.
  135325. * @returns - An object with the serialized config.
  135326. */
  135327. serialize(): any;
  135328. /**
  135329. * Parses a anisotropy Configuration from a serialized object.
  135330. * @param source - Serialized object.
  135331. * @param scene Defines the scene we are parsing for
  135332. * @param rootUrl Defines the rootUrl to load from
  135333. */
  135334. parse(source: any, scene: Scene, rootUrl: string): void;
  135335. }
  135336. }
  135337. declare module BABYLON {
  135338. /**
  135339. * @hidden
  135340. */
  135341. export interface IMaterialSubSurfaceDefines {
  135342. SUBSURFACE: boolean;
  135343. SS_REFRACTION: boolean;
  135344. SS_TRANSLUCENCY: boolean;
  135345. SS_SCATTERING: boolean;
  135346. SS_THICKNESSANDMASK_TEXTURE: boolean;
  135347. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  135348. SS_REFRACTIONMAP_3D: boolean;
  135349. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  135350. SS_LODINREFRACTIONALPHA: boolean;
  135351. SS_GAMMAREFRACTION: boolean;
  135352. SS_RGBDREFRACTION: boolean;
  135353. SS_LINEARSPECULARREFRACTION: boolean;
  135354. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  135355. SS_ALBEDOFORREFRACTIONTINT: boolean;
  135356. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  135357. /** @hidden */
  135358. _areTexturesDirty: boolean;
  135359. }
  135360. /**
  135361. * Define the code related to the sub surface parameters of the pbr material.
  135362. */
  135363. export class PBRSubSurfaceConfiguration {
  135364. private _isRefractionEnabled;
  135365. /**
  135366. * Defines if the refraction is enabled in the material.
  135367. */
  135368. isRefractionEnabled: boolean;
  135369. private _isTranslucencyEnabled;
  135370. /**
  135371. * Defines if the translucency is enabled in the material.
  135372. */
  135373. isTranslucencyEnabled: boolean;
  135374. private _isScatteringEnabled;
  135375. /**
  135376. * Defines if the sub surface scattering is enabled in the material.
  135377. */
  135378. isScatteringEnabled: boolean;
  135379. private _scatteringDiffusionProfileIndex;
  135380. /**
  135381. * Diffusion profile for subsurface scattering.
  135382. * Useful for better scattering in the skins or foliages.
  135383. */
  135384. get scatteringDiffusionProfile(): Nullable<Color3>;
  135385. set scatteringDiffusionProfile(c: Nullable<Color3>);
  135386. /**
  135387. * Defines the refraction intensity of the material.
  135388. * The refraction when enabled replaces the Diffuse part of the material.
  135389. * The intensity helps transitionning between diffuse and refraction.
  135390. */
  135391. refractionIntensity: number;
  135392. /**
  135393. * Defines the translucency intensity of the material.
  135394. * When translucency has been enabled, this defines how much of the "translucency"
  135395. * is addded to the diffuse part of the material.
  135396. */
  135397. translucencyIntensity: number;
  135398. /**
  135399. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  135400. */
  135401. useAlbedoToTintRefraction: boolean;
  135402. private _thicknessTexture;
  135403. /**
  135404. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  135405. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  135406. * 0 would mean minimumThickness
  135407. * 1 would mean maximumThickness
  135408. * The other channels might be use as a mask to vary the different effects intensity.
  135409. */
  135410. thicknessTexture: Nullable<BaseTexture>;
  135411. private _refractionTexture;
  135412. /**
  135413. * Defines the texture to use for refraction.
  135414. */
  135415. refractionTexture: Nullable<BaseTexture>;
  135416. private _indexOfRefraction;
  135417. /**
  135418. * Index of refraction of the material base layer.
  135419. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135420. *
  135421. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  135422. *
  135423. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  135424. */
  135425. indexOfRefraction: number;
  135426. private _volumeIndexOfRefraction;
  135427. /**
  135428. * Index of refraction of the material's volume.
  135429. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135430. *
  135431. * This ONLY impacts refraction. If not provided or given a non-valid value,
  135432. * the volume will use the same IOR as the surface.
  135433. */
  135434. get volumeIndexOfRefraction(): number;
  135435. set volumeIndexOfRefraction(value: number);
  135436. private _invertRefractionY;
  135437. /**
  135438. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  135439. */
  135440. invertRefractionY: boolean;
  135441. private _linkRefractionWithTransparency;
  135442. /**
  135443. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  135444. * Materials half opaque for instance using refraction could benefit from this control.
  135445. */
  135446. linkRefractionWithTransparency: boolean;
  135447. /**
  135448. * Defines the minimum thickness stored in the thickness map.
  135449. * If no thickness map is defined, this value will be used to simulate thickness.
  135450. */
  135451. minimumThickness: number;
  135452. /**
  135453. * Defines the maximum thickness stored in the thickness map.
  135454. */
  135455. maximumThickness: number;
  135456. /**
  135457. * Defines the volume tint of the material.
  135458. * This is used for both translucency and scattering.
  135459. */
  135460. tintColor: Color3;
  135461. /**
  135462. * Defines the distance at which the tint color should be found in the media.
  135463. * This is used for refraction only.
  135464. */
  135465. tintColorAtDistance: number;
  135466. /**
  135467. * Defines how far each channel transmit through the media.
  135468. * It is defined as a color to simplify it selection.
  135469. */
  135470. diffusionDistance: Color3;
  135471. private _useMaskFromThicknessTexture;
  135472. /**
  135473. * Stores the intensity of the different subsurface effects in the thickness texture.
  135474. * * the green channel is the translucency intensity.
  135475. * * the blue channel is the scattering intensity.
  135476. * * the alpha channel is the refraction intensity.
  135477. */
  135478. useMaskFromThicknessTexture: boolean;
  135479. private _scene;
  135480. /** @hidden */
  135481. private _internalMarkAllSubMeshesAsTexturesDirty;
  135482. private _internalMarkScenePrePassDirty;
  135483. /** @hidden */
  135484. _markAllSubMeshesAsTexturesDirty(): void;
  135485. /** @hidden */
  135486. _markScenePrePassDirty(): void;
  135487. /**
  135488. * Instantiate a new istance of sub surface configuration.
  135489. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135490. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  135491. * @param scene The scene
  135492. */
  135493. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  135494. /**
  135495. * Gets wehter the submesh is ready to be used or not.
  135496. * @param defines the list of "defines" to update.
  135497. * @param scene defines the scene the material belongs to.
  135498. * @returns - boolean indicating that the submesh is ready or not.
  135499. */
  135500. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  135501. /**
  135502. * Checks to see if a texture is used in the material.
  135503. * @param defines the list of "defines" to update.
  135504. * @param scene defines the scene to the material belongs to.
  135505. */
  135506. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  135507. /**
  135508. * Binds the material data.
  135509. * @param uniformBuffer defines the Uniform buffer to fill in.
  135510. * @param scene defines the scene the material belongs to.
  135511. * @param engine defines the engine the material belongs to.
  135512. * @param isFrozen defines whether the material is frozen or not.
  135513. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  135514. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  135515. */
  135516. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  135517. /**
  135518. * Unbinds the material from the mesh.
  135519. * @param activeEffect defines the effect that should be unbound from.
  135520. * @returns true if unbound, otherwise false
  135521. */
  135522. unbind(activeEffect: Effect): boolean;
  135523. /**
  135524. * Returns the texture used for refraction or null if none is used.
  135525. * @param scene defines the scene the material belongs to.
  135526. * @returns - Refraction texture if present. If no refraction texture and refraction
  135527. * is linked with transparency, returns environment texture. Otherwise, returns null.
  135528. */
  135529. private _getRefractionTexture;
  135530. /**
  135531. * Returns true if alpha blending should be disabled.
  135532. */
  135533. get disableAlphaBlending(): boolean;
  135534. /**
  135535. * Fills the list of render target textures.
  135536. * @param renderTargets the list of render targets to update
  135537. */
  135538. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  135539. /**
  135540. * Checks to see if a texture is used in the material.
  135541. * @param texture - Base texture to use.
  135542. * @returns - Boolean specifying if a texture is used in the material.
  135543. */
  135544. hasTexture(texture: BaseTexture): boolean;
  135545. /**
  135546. * Gets a boolean indicating that current material needs to register RTT
  135547. * @returns true if this uses a render target otherwise false.
  135548. */
  135549. hasRenderTargetTextures(): boolean;
  135550. /**
  135551. * Returns an array of the actively used textures.
  135552. * @param activeTextures Array of BaseTextures
  135553. */
  135554. getActiveTextures(activeTextures: BaseTexture[]): void;
  135555. /**
  135556. * Returns the animatable textures.
  135557. * @param animatables Array of animatable textures.
  135558. */
  135559. getAnimatables(animatables: IAnimatable[]): void;
  135560. /**
  135561. * Disposes the resources of the material.
  135562. * @param forceDisposeTextures - Forces the disposal of all textures.
  135563. */
  135564. dispose(forceDisposeTextures?: boolean): void;
  135565. /**
  135566. * Get the current class name of the texture useful for serialization or dynamic coding.
  135567. * @returns "PBRSubSurfaceConfiguration"
  135568. */
  135569. getClassName(): string;
  135570. /**
  135571. * Add fallbacks to the effect fallbacks list.
  135572. * @param defines defines the Base texture to use.
  135573. * @param fallbacks defines the current fallback list.
  135574. * @param currentRank defines the current fallback rank.
  135575. * @returns the new fallback rank.
  135576. */
  135577. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135578. /**
  135579. * Add the required uniforms to the current list.
  135580. * @param uniforms defines the current uniform list.
  135581. */
  135582. static AddUniforms(uniforms: string[]): void;
  135583. /**
  135584. * Add the required samplers to the current list.
  135585. * @param samplers defines the current sampler list.
  135586. */
  135587. static AddSamplers(samplers: string[]): void;
  135588. /**
  135589. * Add the required uniforms to the current buffer.
  135590. * @param uniformBuffer defines the current uniform buffer.
  135591. */
  135592. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135593. /**
  135594. * Makes a duplicate of the current configuration into another one.
  135595. * @param configuration define the config where to copy the info
  135596. */
  135597. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  135598. /**
  135599. * Serializes this Sub Surface configuration.
  135600. * @returns - An object with the serialized config.
  135601. */
  135602. serialize(): any;
  135603. /**
  135604. * Parses a anisotropy Configuration from a serialized object.
  135605. * @param source - Serialized object.
  135606. * @param scene Defines the scene we are parsing for
  135607. * @param rootUrl Defines the rootUrl to load from
  135608. */
  135609. parse(source: any, scene: Scene, rootUrl: string): void;
  135610. }
  135611. }
  135612. declare module BABYLON {
  135613. /** @hidden */
  135614. export var pbrFragmentDeclaration: {
  135615. name: string;
  135616. shader: string;
  135617. };
  135618. }
  135619. declare module BABYLON {
  135620. /** @hidden */
  135621. export var pbrUboDeclaration: {
  135622. name: string;
  135623. shader: string;
  135624. };
  135625. }
  135626. declare module BABYLON {
  135627. /** @hidden */
  135628. export var pbrFragmentExtraDeclaration: {
  135629. name: string;
  135630. shader: string;
  135631. };
  135632. }
  135633. declare module BABYLON {
  135634. /** @hidden */
  135635. export var pbrFragmentSamplersDeclaration: {
  135636. name: string;
  135637. shader: string;
  135638. };
  135639. }
  135640. declare module BABYLON {
  135641. /** @hidden */
  135642. export var importanceSampling: {
  135643. name: string;
  135644. shader: string;
  135645. };
  135646. }
  135647. declare module BABYLON {
  135648. /** @hidden */
  135649. export var pbrHelperFunctions: {
  135650. name: string;
  135651. shader: string;
  135652. };
  135653. }
  135654. declare module BABYLON {
  135655. /** @hidden */
  135656. export var harmonicsFunctions: {
  135657. name: string;
  135658. shader: string;
  135659. };
  135660. }
  135661. declare module BABYLON {
  135662. /** @hidden */
  135663. export var pbrDirectLightingSetupFunctions: {
  135664. name: string;
  135665. shader: string;
  135666. };
  135667. }
  135668. declare module BABYLON {
  135669. /** @hidden */
  135670. export var pbrDirectLightingFalloffFunctions: {
  135671. name: string;
  135672. shader: string;
  135673. };
  135674. }
  135675. declare module BABYLON {
  135676. /** @hidden */
  135677. export var pbrBRDFFunctions: {
  135678. name: string;
  135679. shader: string;
  135680. };
  135681. }
  135682. declare module BABYLON {
  135683. /** @hidden */
  135684. export var hdrFilteringFunctions: {
  135685. name: string;
  135686. shader: string;
  135687. };
  135688. }
  135689. declare module BABYLON {
  135690. /** @hidden */
  135691. export var pbrDirectLightingFunctions: {
  135692. name: string;
  135693. shader: string;
  135694. };
  135695. }
  135696. declare module BABYLON {
  135697. /** @hidden */
  135698. export var pbrIBLFunctions: {
  135699. name: string;
  135700. shader: string;
  135701. };
  135702. }
  135703. declare module BABYLON {
  135704. /** @hidden */
  135705. export var pbrBlockAlbedoOpacity: {
  135706. name: string;
  135707. shader: string;
  135708. };
  135709. }
  135710. declare module BABYLON {
  135711. /** @hidden */
  135712. export var pbrBlockReflectivity: {
  135713. name: string;
  135714. shader: string;
  135715. };
  135716. }
  135717. declare module BABYLON {
  135718. /** @hidden */
  135719. export var pbrBlockAmbientOcclusion: {
  135720. name: string;
  135721. shader: string;
  135722. };
  135723. }
  135724. declare module BABYLON {
  135725. /** @hidden */
  135726. export var pbrBlockAlphaFresnel: {
  135727. name: string;
  135728. shader: string;
  135729. };
  135730. }
  135731. declare module BABYLON {
  135732. /** @hidden */
  135733. export var pbrBlockAnisotropic: {
  135734. name: string;
  135735. shader: string;
  135736. };
  135737. }
  135738. declare module BABYLON {
  135739. /** @hidden */
  135740. export var pbrBlockReflection: {
  135741. name: string;
  135742. shader: string;
  135743. };
  135744. }
  135745. declare module BABYLON {
  135746. /** @hidden */
  135747. export var pbrBlockSheen: {
  135748. name: string;
  135749. shader: string;
  135750. };
  135751. }
  135752. declare module BABYLON {
  135753. /** @hidden */
  135754. export var pbrBlockClearcoat: {
  135755. name: string;
  135756. shader: string;
  135757. };
  135758. }
  135759. declare module BABYLON {
  135760. /** @hidden */
  135761. export var pbrBlockSubSurface: {
  135762. name: string;
  135763. shader: string;
  135764. };
  135765. }
  135766. declare module BABYLON {
  135767. /** @hidden */
  135768. export var pbrBlockNormalGeometric: {
  135769. name: string;
  135770. shader: string;
  135771. };
  135772. }
  135773. declare module BABYLON {
  135774. /** @hidden */
  135775. export var pbrBlockNormalFinal: {
  135776. name: string;
  135777. shader: string;
  135778. };
  135779. }
  135780. declare module BABYLON {
  135781. /** @hidden */
  135782. export var pbrBlockLightmapInit: {
  135783. name: string;
  135784. shader: string;
  135785. };
  135786. }
  135787. declare module BABYLON {
  135788. /** @hidden */
  135789. export var pbrBlockGeometryInfo: {
  135790. name: string;
  135791. shader: string;
  135792. };
  135793. }
  135794. declare module BABYLON {
  135795. /** @hidden */
  135796. export var pbrBlockReflectance0: {
  135797. name: string;
  135798. shader: string;
  135799. };
  135800. }
  135801. declare module BABYLON {
  135802. /** @hidden */
  135803. export var pbrBlockReflectance: {
  135804. name: string;
  135805. shader: string;
  135806. };
  135807. }
  135808. declare module BABYLON {
  135809. /** @hidden */
  135810. export var pbrBlockDirectLighting: {
  135811. name: string;
  135812. shader: string;
  135813. };
  135814. }
  135815. declare module BABYLON {
  135816. /** @hidden */
  135817. export var pbrBlockFinalLitComponents: {
  135818. name: string;
  135819. shader: string;
  135820. };
  135821. }
  135822. declare module BABYLON {
  135823. /** @hidden */
  135824. export var pbrBlockFinalUnlitComponents: {
  135825. name: string;
  135826. shader: string;
  135827. };
  135828. }
  135829. declare module BABYLON {
  135830. /** @hidden */
  135831. export var pbrBlockFinalColorComposition: {
  135832. name: string;
  135833. shader: string;
  135834. };
  135835. }
  135836. declare module BABYLON {
  135837. /** @hidden */
  135838. export var pbrBlockImageProcessing: {
  135839. name: string;
  135840. shader: string;
  135841. };
  135842. }
  135843. declare module BABYLON {
  135844. /** @hidden */
  135845. export var pbrDebug: {
  135846. name: string;
  135847. shader: string;
  135848. };
  135849. }
  135850. declare module BABYLON {
  135851. /** @hidden */
  135852. export var pbrPixelShader: {
  135853. name: string;
  135854. shader: string;
  135855. };
  135856. }
  135857. declare module BABYLON {
  135858. /** @hidden */
  135859. export var pbrVertexDeclaration: {
  135860. name: string;
  135861. shader: string;
  135862. };
  135863. }
  135864. declare module BABYLON {
  135865. /** @hidden */
  135866. export var pbrVertexShader: {
  135867. name: string;
  135868. shader: string;
  135869. };
  135870. }
  135871. declare module BABYLON {
  135872. /**
  135873. * Manages the defines for the PBR Material.
  135874. * @hidden
  135875. */
  135876. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  135877. PBR: boolean;
  135878. NUM_SAMPLES: string;
  135879. REALTIME_FILTERING: boolean;
  135880. MAINUV1: boolean;
  135881. MAINUV2: boolean;
  135882. UV1: boolean;
  135883. UV2: boolean;
  135884. ALBEDO: boolean;
  135885. GAMMAALBEDO: boolean;
  135886. ALBEDODIRECTUV: number;
  135887. VERTEXCOLOR: boolean;
  135888. DETAIL: boolean;
  135889. DETAILDIRECTUV: number;
  135890. DETAIL_NORMALBLENDMETHOD: number;
  135891. AMBIENT: boolean;
  135892. AMBIENTDIRECTUV: number;
  135893. AMBIENTINGRAYSCALE: boolean;
  135894. OPACITY: boolean;
  135895. VERTEXALPHA: boolean;
  135896. OPACITYDIRECTUV: number;
  135897. OPACITYRGB: boolean;
  135898. ALPHATEST: boolean;
  135899. DEPTHPREPASS: boolean;
  135900. ALPHABLEND: boolean;
  135901. ALPHAFROMALBEDO: boolean;
  135902. ALPHATESTVALUE: string;
  135903. SPECULAROVERALPHA: boolean;
  135904. RADIANCEOVERALPHA: boolean;
  135905. ALPHAFRESNEL: boolean;
  135906. LINEARALPHAFRESNEL: boolean;
  135907. PREMULTIPLYALPHA: boolean;
  135908. EMISSIVE: boolean;
  135909. EMISSIVEDIRECTUV: number;
  135910. REFLECTIVITY: boolean;
  135911. REFLECTIVITYDIRECTUV: number;
  135912. SPECULARTERM: boolean;
  135913. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  135914. MICROSURFACEAUTOMATIC: boolean;
  135915. LODBASEDMICROSFURACE: boolean;
  135916. MICROSURFACEMAP: boolean;
  135917. MICROSURFACEMAPDIRECTUV: number;
  135918. METALLICWORKFLOW: boolean;
  135919. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  135920. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  135921. METALLNESSSTOREINMETALMAPBLUE: boolean;
  135922. AOSTOREINMETALMAPRED: boolean;
  135923. METALLIC_REFLECTANCE: boolean;
  135924. METALLIC_REFLECTANCEDIRECTUV: number;
  135925. ENVIRONMENTBRDF: boolean;
  135926. ENVIRONMENTBRDF_RGBD: boolean;
  135927. NORMAL: boolean;
  135928. TANGENT: boolean;
  135929. BUMP: boolean;
  135930. BUMPDIRECTUV: number;
  135931. OBJECTSPACE_NORMALMAP: boolean;
  135932. PARALLAX: boolean;
  135933. PARALLAXOCCLUSION: boolean;
  135934. NORMALXYSCALE: boolean;
  135935. LIGHTMAP: boolean;
  135936. LIGHTMAPDIRECTUV: number;
  135937. USELIGHTMAPASSHADOWMAP: boolean;
  135938. GAMMALIGHTMAP: boolean;
  135939. RGBDLIGHTMAP: boolean;
  135940. REFLECTION: boolean;
  135941. REFLECTIONMAP_3D: boolean;
  135942. REFLECTIONMAP_SPHERICAL: boolean;
  135943. REFLECTIONMAP_PLANAR: boolean;
  135944. REFLECTIONMAP_CUBIC: boolean;
  135945. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  135946. REFLECTIONMAP_PROJECTION: boolean;
  135947. REFLECTIONMAP_SKYBOX: boolean;
  135948. REFLECTIONMAP_EXPLICIT: boolean;
  135949. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  135950. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  135951. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  135952. INVERTCUBICMAP: boolean;
  135953. USESPHERICALFROMREFLECTIONMAP: boolean;
  135954. USEIRRADIANCEMAP: boolean;
  135955. SPHERICAL_HARMONICS: boolean;
  135956. USESPHERICALINVERTEX: boolean;
  135957. REFLECTIONMAP_OPPOSITEZ: boolean;
  135958. LODINREFLECTIONALPHA: boolean;
  135959. GAMMAREFLECTION: boolean;
  135960. RGBDREFLECTION: boolean;
  135961. LINEARSPECULARREFLECTION: boolean;
  135962. RADIANCEOCCLUSION: boolean;
  135963. HORIZONOCCLUSION: boolean;
  135964. INSTANCES: boolean;
  135965. THIN_INSTANCES: boolean;
  135966. PREPASS: boolean;
  135967. SCENE_MRT_COUNT: number;
  135968. NUM_BONE_INFLUENCERS: number;
  135969. BonesPerMesh: number;
  135970. BONETEXTURE: boolean;
  135971. NONUNIFORMSCALING: boolean;
  135972. MORPHTARGETS: boolean;
  135973. MORPHTARGETS_NORMAL: boolean;
  135974. MORPHTARGETS_TANGENT: boolean;
  135975. MORPHTARGETS_UV: boolean;
  135976. NUM_MORPH_INFLUENCERS: number;
  135977. IMAGEPROCESSING: boolean;
  135978. VIGNETTE: boolean;
  135979. VIGNETTEBLENDMODEMULTIPLY: boolean;
  135980. VIGNETTEBLENDMODEOPAQUE: boolean;
  135981. TONEMAPPING: boolean;
  135982. TONEMAPPING_ACES: boolean;
  135983. CONTRAST: boolean;
  135984. COLORCURVES: boolean;
  135985. COLORGRADING: boolean;
  135986. COLORGRADING3D: boolean;
  135987. SAMPLER3DGREENDEPTH: boolean;
  135988. SAMPLER3DBGRMAP: boolean;
  135989. IMAGEPROCESSINGPOSTPROCESS: boolean;
  135990. EXPOSURE: boolean;
  135991. MULTIVIEW: boolean;
  135992. USEPHYSICALLIGHTFALLOFF: boolean;
  135993. USEGLTFLIGHTFALLOFF: boolean;
  135994. TWOSIDEDLIGHTING: boolean;
  135995. SHADOWFLOAT: boolean;
  135996. CLIPPLANE: boolean;
  135997. CLIPPLANE2: boolean;
  135998. CLIPPLANE3: boolean;
  135999. CLIPPLANE4: boolean;
  136000. CLIPPLANE5: boolean;
  136001. CLIPPLANE6: boolean;
  136002. POINTSIZE: boolean;
  136003. FOG: boolean;
  136004. LOGARITHMICDEPTH: boolean;
  136005. FORCENORMALFORWARD: boolean;
  136006. SPECULARAA: boolean;
  136007. CLEARCOAT: boolean;
  136008. CLEARCOAT_DEFAULTIOR: boolean;
  136009. CLEARCOAT_TEXTURE: boolean;
  136010. CLEARCOAT_TEXTUREDIRECTUV: number;
  136011. CLEARCOAT_BUMP: boolean;
  136012. CLEARCOAT_BUMPDIRECTUV: number;
  136013. CLEARCOAT_TINT: boolean;
  136014. CLEARCOAT_TINT_TEXTURE: boolean;
  136015. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  136016. ANISOTROPIC: boolean;
  136017. ANISOTROPIC_TEXTURE: boolean;
  136018. ANISOTROPIC_TEXTUREDIRECTUV: number;
  136019. BRDF_V_HEIGHT_CORRELATED: boolean;
  136020. MS_BRDF_ENERGY_CONSERVATION: boolean;
  136021. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  136022. SHEEN: boolean;
  136023. SHEEN_TEXTURE: boolean;
  136024. SHEEN_TEXTUREDIRECTUV: number;
  136025. SHEEN_LINKWITHALBEDO: boolean;
  136026. SHEEN_ROUGHNESS: boolean;
  136027. SHEEN_ALBEDOSCALING: boolean;
  136028. SUBSURFACE: boolean;
  136029. SS_REFRACTION: boolean;
  136030. SS_TRANSLUCENCY: boolean;
  136031. SS_SCATTERING: boolean;
  136032. SS_THICKNESSANDMASK_TEXTURE: boolean;
  136033. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  136034. SS_REFRACTIONMAP_3D: boolean;
  136035. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  136036. SS_LODINREFRACTIONALPHA: boolean;
  136037. SS_GAMMAREFRACTION: boolean;
  136038. SS_RGBDREFRACTION: boolean;
  136039. SS_LINEARSPECULARREFRACTION: boolean;
  136040. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  136041. SS_ALBEDOFORREFRACTIONTINT: boolean;
  136042. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  136043. UNLIT: boolean;
  136044. DEBUGMODE: number;
  136045. /**
  136046. * Initializes the PBR Material defines.
  136047. */
  136048. constructor();
  136049. /**
  136050. * Resets the PBR Material defines.
  136051. */
  136052. reset(): void;
  136053. }
  136054. /**
  136055. * The Physically based material base class of BJS.
  136056. *
  136057. * This offers the main features of a standard PBR material.
  136058. * For more information, please refer to the documentation :
  136059. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136060. */
  136061. export abstract class PBRBaseMaterial extends PushMaterial {
  136062. /**
  136063. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136064. */
  136065. static readonly PBRMATERIAL_OPAQUE: number;
  136066. /**
  136067. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136068. */
  136069. static readonly PBRMATERIAL_ALPHATEST: number;
  136070. /**
  136071. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136072. */
  136073. static readonly PBRMATERIAL_ALPHABLEND: number;
  136074. /**
  136075. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136076. * They are also discarded below the alpha cutoff threshold to improve performances.
  136077. */
  136078. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136079. /**
  136080. * Defines the default value of how much AO map is occluding the analytical lights
  136081. * (point spot...).
  136082. */
  136083. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136084. /**
  136085. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  136086. */
  136087. static readonly LIGHTFALLOFF_PHYSICAL: number;
  136088. /**
  136089. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  136090. * to enhance interoperability with other engines.
  136091. */
  136092. static readonly LIGHTFALLOFF_GLTF: number;
  136093. /**
  136094. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  136095. * to enhance interoperability with other materials.
  136096. */
  136097. static readonly LIGHTFALLOFF_STANDARD: number;
  136098. /**
  136099. * Intensity of the direct lights e.g. the four lights available in your scene.
  136100. * This impacts both the direct diffuse and specular highlights.
  136101. */
  136102. protected _directIntensity: number;
  136103. /**
  136104. * Intensity of the emissive part of the material.
  136105. * This helps controlling the emissive effect without modifying the emissive color.
  136106. */
  136107. protected _emissiveIntensity: number;
  136108. /**
  136109. * Intensity of the environment e.g. how much the environment will light the object
  136110. * either through harmonics for rough material or through the refelction for shiny ones.
  136111. */
  136112. protected _environmentIntensity: number;
  136113. /**
  136114. * This is a special control allowing the reduction of the specular highlights coming from the
  136115. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136116. */
  136117. protected _specularIntensity: number;
  136118. /**
  136119. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  136120. */
  136121. private _lightingInfos;
  136122. /**
  136123. * Debug Control allowing disabling the bump map on this material.
  136124. */
  136125. protected _disableBumpMap: boolean;
  136126. /**
  136127. * AKA Diffuse Texture in standard nomenclature.
  136128. */
  136129. protected _albedoTexture: Nullable<BaseTexture>;
  136130. /**
  136131. * AKA Occlusion Texture in other nomenclature.
  136132. */
  136133. protected _ambientTexture: Nullable<BaseTexture>;
  136134. /**
  136135. * AKA Occlusion Texture Intensity in other nomenclature.
  136136. */
  136137. protected _ambientTextureStrength: number;
  136138. /**
  136139. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136140. * 1 means it completely occludes it
  136141. * 0 mean it has no impact
  136142. */
  136143. protected _ambientTextureImpactOnAnalyticalLights: number;
  136144. /**
  136145. * Stores the alpha values in a texture.
  136146. */
  136147. protected _opacityTexture: Nullable<BaseTexture>;
  136148. /**
  136149. * Stores the reflection values in a texture.
  136150. */
  136151. protected _reflectionTexture: Nullable<BaseTexture>;
  136152. /**
  136153. * Stores the emissive values in a texture.
  136154. */
  136155. protected _emissiveTexture: Nullable<BaseTexture>;
  136156. /**
  136157. * AKA Specular texture in other nomenclature.
  136158. */
  136159. protected _reflectivityTexture: Nullable<BaseTexture>;
  136160. /**
  136161. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136162. */
  136163. protected _metallicTexture: Nullable<BaseTexture>;
  136164. /**
  136165. * Specifies the metallic scalar of the metallic/roughness workflow.
  136166. * Can also be used to scale the metalness values of the metallic texture.
  136167. */
  136168. protected _metallic: Nullable<number>;
  136169. /**
  136170. * Specifies the roughness scalar of the metallic/roughness workflow.
  136171. * Can also be used to scale the roughness values of the metallic texture.
  136172. */
  136173. protected _roughness: Nullable<number>;
  136174. /**
  136175. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136176. * By default the indexOfrefraction is used to compute F0;
  136177. *
  136178. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136179. *
  136180. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136181. * F90 = metallicReflectanceColor;
  136182. */
  136183. protected _metallicF0Factor: number;
  136184. /**
  136185. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136186. * By default the F90 is always 1;
  136187. *
  136188. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136189. *
  136190. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136191. * F90 = metallicReflectanceColor;
  136192. */
  136193. protected _metallicReflectanceColor: Color3;
  136194. /**
  136195. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136196. * This is multiply against the scalar values defined in the material.
  136197. */
  136198. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  136199. /**
  136200. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136201. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136202. */
  136203. protected _microSurfaceTexture: Nullable<BaseTexture>;
  136204. /**
  136205. * Stores surface normal data used to displace a mesh in a texture.
  136206. */
  136207. protected _bumpTexture: Nullable<BaseTexture>;
  136208. /**
  136209. * Stores the pre-calculated light information of a mesh in a texture.
  136210. */
  136211. protected _lightmapTexture: Nullable<BaseTexture>;
  136212. /**
  136213. * The color of a material in ambient lighting.
  136214. */
  136215. protected _ambientColor: Color3;
  136216. /**
  136217. * AKA Diffuse Color in other nomenclature.
  136218. */
  136219. protected _albedoColor: Color3;
  136220. /**
  136221. * AKA Specular Color in other nomenclature.
  136222. */
  136223. protected _reflectivityColor: Color3;
  136224. /**
  136225. * The color applied when light is reflected from a material.
  136226. */
  136227. protected _reflectionColor: Color3;
  136228. /**
  136229. * The color applied when light is emitted from a material.
  136230. */
  136231. protected _emissiveColor: Color3;
  136232. /**
  136233. * AKA Glossiness in other nomenclature.
  136234. */
  136235. protected _microSurface: number;
  136236. /**
  136237. * Specifies that the material will use the light map as a show map.
  136238. */
  136239. protected _useLightmapAsShadowmap: boolean;
  136240. /**
  136241. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136242. * makes the reflect vector face the model (under horizon).
  136243. */
  136244. protected _useHorizonOcclusion: boolean;
  136245. /**
  136246. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136247. * too much the area relying on ambient texture to define their ambient occlusion.
  136248. */
  136249. protected _useRadianceOcclusion: boolean;
  136250. /**
  136251. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136252. */
  136253. protected _useAlphaFromAlbedoTexture: boolean;
  136254. /**
  136255. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  136256. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136257. */
  136258. protected _useSpecularOverAlpha: boolean;
  136259. /**
  136260. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136261. */
  136262. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136263. /**
  136264. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136265. */
  136266. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  136267. /**
  136268. * Specifies if the metallic texture contains the roughness information in its green channel.
  136269. */
  136270. protected _useRoughnessFromMetallicTextureGreen: boolean;
  136271. /**
  136272. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136273. */
  136274. protected _useMetallnessFromMetallicTextureBlue: boolean;
  136275. /**
  136276. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136277. */
  136278. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  136279. /**
  136280. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136281. */
  136282. protected _useAmbientInGrayScale: boolean;
  136283. /**
  136284. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136285. * The material will try to infer what glossiness each pixel should be.
  136286. */
  136287. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  136288. /**
  136289. * Defines the falloff type used in this material.
  136290. * It by default is Physical.
  136291. */
  136292. protected _lightFalloff: number;
  136293. /**
  136294. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136295. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136296. */
  136297. protected _useRadianceOverAlpha: boolean;
  136298. /**
  136299. * Allows using an object space normal map (instead of tangent space).
  136300. */
  136301. protected _useObjectSpaceNormalMap: boolean;
  136302. /**
  136303. * Allows using the bump map in parallax mode.
  136304. */
  136305. protected _useParallax: boolean;
  136306. /**
  136307. * Allows using the bump map in parallax occlusion mode.
  136308. */
  136309. protected _useParallaxOcclusion: boolean;
  136310. /**
  136311. * Controls the scale bias of the parallax mode.
  136312. */
  136313. protected _parallaxScaleBias: number;
  136314. /**
  136315. * If sets to true, disables all the lights affecting the material.
  136316. */
  136317. protected _disableLighting: boolean;
  136318. /**
  136319. * Number of Simultaneous lights allowed on the material.
  136320. */
  136321. protected _maxSimultaneousLights: number;
  136322. /**
  136323. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  136324. */
  136325. protected _invertNormalMapX: boolean;
  136326. /**
  136327. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  136328. */
  136329. protected _invertNormalMapY: boolean;
  136330. /**
  136331. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136332. */
  136333. protected _twoSidedLighting: boolean;
  136334. /**
  136335. * Defines the alpha limits in alpha test mode.
  136336. */
  136337. protected _alphaCutOff: number;
  136338. /**
  136339. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136340. */
  136341. protected _forceAlphaTest: boolean;
  136342. /**
  136343. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136344. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136345. */
  136346. protected _useAlphaFresnel: boolean;
  136347. /**
  136348. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136349. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136350. */
  136351. protected _useLinearAlphaFresnel: boolean;
  136352. /**
  136353. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  136354. * from cos thetav and roughness:
  136355. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  136356. */
  136357. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  136358. /**
  136359. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136360. */
  136361. protected _forceIrradianceInFragment: boolean;
  136362. private _realTimeFiltering;
  136363. /**
  136364. * Enables realtime filtering on the texture.
  136365. */
  136366. get realTimeFiltering(): boolean;
  136367. set realTimeFiltering(b: boolean);
  136368. private _realTimeFilteringQuality;
  136369. /**
  136370. * Quality switch for realtime filtering
  136371. */
  136372. get realTimeFilteringQuality(): number;
  136373. set realTimeFilteringQuality(n: number);
  136374. /**
  136375. * Can this material render to several textures at once
  136376. */
  136377. get canRenderToMRT(): boolean;
  136378. /**
  136379. * Force normal to face away from face.
  136380. */
  136381. protected _forceNormalForward: boolean;
  136382. /**
  136383. * Enables specular anti aliasing in the PBR shader.
  136384. * It will both interacts on the Geometry for analytical and IBL lighting.
  136385. * It also prefilter the roughness map based on the bump values.
  136386. */
  136387. protected _enableSpecularAntiAliasing: boolean;
  136388. /**
  136389. * Default configuration related to image processing available in the PBR Material.
  136390. */
  136391. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  136392. /**
  136393. * Keep track of the image processing observer to allow dispose and replace.
  136394. */
  136395. private _imageProcessingObserver;
  136396. /**
  136397. * Attaches a new image processing configuration to the PBR Material.
  136398. * @param configuration
  136399. */
  136400. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  136401. /**
  136402. * Stores the available render targets.
  136403. */
  136404. private _renderTargets;
  136405. /**
  136406. * Sets the global ambient color for the material used in lighting calculations.
  136407. */
  136408. private _globalAmbientColor;
  136409. /**
  136410. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  136411. */
  136412. private _useLogarithmicDepth;
  136413. /**
  136414. * If set to true, no lighting calculations will be applied.
  136415. */
  136416. private _unlit;
  136417. private _debugMode;
  136418. /**
  136419. * @hidden
  136420. * This is reserved for the inspector.
  136421. * Defines the material debug mode.
  136422. * It helps seeing only some components of the material while troubleshooting.
  136423. */
  136424. debugMode: number;
  136425. /**
  136426. * @hidden
  136427. * This is reserved for the inspector.
  136428. * Specify from where on screen the debug mode should start.
  136429. * The value goes from -1 (full screen) to 1 (not visible)
  136430. * It helps with side by side comparison against the final render
  136431. * This defaults to -1
  136432. */
  136433. private debugLimit;
  136434. /**
  136435. * @hidden
  136436. * This is reserved for the inspector.
  136437. * As the default viewing range might not be enough (if the ambient is really small for instance)
  136438. * You can use the factor to better multiply the final value.
  136439. */
  136440. private debugFactor;
  136441. /**
  136442. * Defines the clear coat layer parameters for the material.
  136443. */
  136444. readonly clearCoat: PBRClearCoatConfiguration;
  136445. /**
  136446. * Defines the anisotropic parameters for the material.
  136447. */
  136448. readonly anisotropy: PBRAnisotropicConfiguration;
  136449. /**
  136450. * Defines the BRDF parameters for the material.
  136451. */
  136452. readonly brdf: PBRBRDFConfiguration;
  136453. /**
  136454. * Defines the Sheen parameters for the material.
  136455. */
  136456. readonly sheen: PBRSheenConfiguration;
  136457. /**
  136458. * Defines the SubSurface parameters for the material.
  136459. */
  136460. readonly subSurface: PBRSubSurfaceConfiguration;
  136461. /**
  136462. * Defines the detail map parameters for the material.
  136463. */
  136464. readonly detailMap: DetailMapConfiguration;
  136465. protected _rebuildInParallel: boolean;
  136466. /**
  136467. * Instantiates a new PBRMaterial instance.
  136468. *
  136469. * @param name The material name
  136470. * @param scene The scene the material will be use in.
  136471. */
  136472. constructor(name: string, scene: Scene);
  136473. /**
  136474. * Gets a boolean indicating that current material needs to register RTT
  136475. */
  136476. get hasRenderTargetTextures(): boolean;
  136477. /**
  136478. * Gets the name of the material class.
  136479. */
  136480. getClassName(): string;
  136481. /**
  136482. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136483. */
  136484. get useLogarithmicDepth(): boolean;
  136485. /**
  136486. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136487. */
  136488. set useLogarithmicDepth(value: boolean);
  136489. /**
  136490. * Returns true if alpha blending should be disabled.
  136491. */
  136492. protected get _disableAlphaBlending(): boolean;
  136493. /**
  136494. * Specifies whether or not this material should be rendered in alpha blend mode.
  136495. */
  136496. needAlphaBlending(): boolean;
  136497. /**
  136498. * Specifies whether or not this material should be rendered in alpha test mode.
  136499. */
  136500. needAlphaTesting(): boolean;
  136501. /**
  136502. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  136503. */
  136504. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  136505. /**
  136506. * Gets the texture used for the alpha test.
  136507. */
  136508. getAlphaTestTexture(): Nullable<BaseTexture>;
  136509. /**
  136510. * Specifies that the submesh is ready to be used.
  136511. * @param mesh - BJS mesh.
  136512. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  136513. * @param useInstances - Specifies that instances should be used.
  136514. * @returns - boolean indicating that the submesh is ready or not.
  136515. */
  136516. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  136517. /**
  136518. * Specifies if the material uses metallic roughness workflow.
  136519. * @returns boolean specifiying if the material uses metallic roughness workflow.
  136520. */
  136521. isMetallicWorkflow(): boolean;
  136522. private _prepareEffect;
  136523. private _prepareDefines;
  136524. /**
  136525. * Force shader compilation
  136526. */
  136527. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  136528. /**
  136529. * Initializes the uniform buffer layout for the shader.
  136530. */
  136531. buildUniformLayout(): void;
  136532. /**
  136533. * Unbinds the material from the mesh
  136534. */
  136535. unbind(): void;
  136536. /**
  136537. * Binds the submesh data.
  136538. * @param world - The world matrix.
  136539. * @param mesh - The BJS mesh.
  136540. * @param subMesh - A submesh of the BJS mesh.
  136541. */
  136542. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  136543. /**
  136544. * Returns the animatable textures.
  136545. * @returns - Array of animatable textures.
  136546. */
  136547. getAnimatables(): IAnimatable[];
  136548. /**
  136549. * Returns the texture used for reflections.
  136550. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  136551. */
  136552. private _getReflectionTexture;
  136553. /**
  136554. * Returns an array of the actively used textures.
  136555. * @returns - Array of BaseTextures
  136556. */
  136557. getActiveTextures(): BaseTexture[];
  136558. /**
  136559. * Checks to see if a texture is used in the material.
  136560. * @param texture - Base texture to use.
  136561. * @returns - Boolean specifying if a texture is used in the material.
  136562. */
  136563. hasTexture(texture: BaseTexture): boolean;
  136564. /**
  136565. * Sets the required values to the prepass renderer.
  136566. * @param prePassRenderer defines the prepass renderer to setup
  136567. */
  136568. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  136569. /**
  136570. * Disposes the resources of the material.
  136571. * @param forceDisposeEffect - Forces the disposal of effects.
  136572. * @param forceDisposeTextures - Forces the disposal of all textures.
  136573. */
  136574. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  136575. }
  136576. }
  136577. declare module BABYLON {
  136578. /**
  136579. * The Physically based material of BJS.
  136580. *
  136581. * This offers the main features of a standard PBR material.
  136582. * For more information, please refer to the documentation :
  136583. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136584. */
  136585. export class PBRMaterial extends PBRBaseMaterial {
  136586. /**
  136587. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136588. */
  136589. static readonly PBRMATERIAL_OPAQUE: number;
  136590. /**
  136591. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136592. */
  136593. static readonly PBRMATERIAL_ALPHATEST: number;
  136594. /**
  136595. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136596. */
  136597. static readonly PBRMATERIAL_ALPHABLEND: number;
  136598. /**
  136599. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136600. * They are also discarded below the alpha cutoff threshold to improve performances.
  136601. */
  136602. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136603. /**
  136604. * Defines the default value of how much AO map is occluding the analytical lights
  136605. * (point spot...).
  136606. */
  136607. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136608. /**
  136609. * Intensity of the direct lights e.g. the four lights available in your scene.
  136610. * This impacts both the direct diffuse and specular highlights.
  136611. */
  136612. directIntensity: number;
  136613. /**
  136614. * Intensity of the emissive part of the material.
  136615. * This helps controlling the emissive effect without modifying the emissive color.
  136616. */
  136617. emissiveIntensity: number;
  136618. /**
  136619. * Intensity of the environment e.g. how much the environment will light the object
  136620. * either through harmonics for rough material or through the refelction for shiny ones.
  136621. */
  136622. environmentIntensity: number;
  136623. /**
  136624. * This is a special control allowing the reduction of the specular highlights coming from the
  136625. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136626. */
  136627. specularIntensity: number;
  136628. /**
  136629. * Debug Control allowing disabling the bump map on this material.
  136630. */
  136631. disableBumpMap: boolean;
  136632. /**
  136633. * AKA Diffuse Texture in standard nomenclature.
  136634. */
  136635. albedoTexture: BaseTexture;
  136636. /**
  136637. * AKA Occlusion Texture in other nomenclature.
  136638. */
  136639. ambientTexture: BaseTexture;
  136640. /**
  136641. * AKA Occlusion Texture Intensity in other nomenclature.
  136642. */
  136643. ambientTextureStrength: number;
  136644. /**
  136645. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136646. * 1 means it completely occludes it
  136647. * 0 mean it has no impact
  136648. */
  136649. ambientTextureImpactOnAnalyticalLights: number;
  136650. /**
  136651. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  136652. */
  136653. opacityTexture: BaseTexture;
  136654. /**
  136655. * Stores the reflection values in a texture.
  136656. */
  136657. reflectionTexture: Nullable<BaseTexture>;
  136658. /**
  136659. * Stores the emissive values in a texture.
  136660. */
  136661. emissiveTexture: BaseTexture;
  136662. /**
  136663. * AKA Specular texture in other nomenclature.
  136664. */
  136665. reflectivityTexture: BaseTexture;
  136666. /**
  136667. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136668. */
  136669. metallicTexture: BaseTexture;
  136670. /**
  136671. * Specifies the metallic scalar of the metallic/roughness workflow.
  136672. * Can also be used to scale the metalness values of the metallic texture.
  136673. */
  136674. metallic: Nullable<number>;
  136675. /**
  136676. * Specifies the roughness scalar of the metallic/roughness workflow.
  136677. * Can also be used to scale the roughness values of the metallic texture.
  136678. */
  136679. roughness: Nullable<number>;
  136680. /**
  136681. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136682. * By default the indexOfrefraction is used to compute F0;
  136683. *
  136684. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136685. *
  136686. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136687. * F90 = metallicReflectanceColor;
  136688. */
  136689. metallicF0Factor: number;
  136690. /**
  136691. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136692. * By default the F90 is always 1;
  136693. *
  136694. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136695. *
  136696. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136697. * F90 = metallicReflectanceColor;
  136698. */
  136699. metallicReflectanceColor: Color3;
  136700. /**
  136701. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136702. * This is multiply against the scalar values defined in the material.
  136703. */
  136704. metallicReflectanceTexture: Nullable<BaseTexture>;
  136705. /**
  136706. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136707. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136708. */
  136709. microSurfaceTexture: BaseTexture;
  136710. /**
  136711. * Stores surface normal data used to displace a mesh in a texture.
  136712. */
  136713. bumpTexture: BaseTexture;
  136714. /**
  136715. * Stores the pre-calculated light information of a mesh in a texture.
  136716. */
  136717. lightmapTexture: BaseTexture;
  136718. /**
  136719. * Stores the refracted light information in a texture.
  136720. */
  136721. get refractionTexture(): Nullable<BaseTexture>;
  136722. set refractionTexture(value: Nullable<BaseTexture>);
  136723. /**
  136724. * The color of a material in ambient lighting.
  136725. */
  136726. ambientColor: Color3;
  136727. /**
  136728. * AKA Diffuse Color in other nomenclature.
  136729. */
  136730. albedoColor: Color3;
  136731. /**
  136732. * AKA Specular Color in other nomenclature.
  136733. */
  136734. reflectivityColor: Color3;
  136735. /**
  136736. * The color reflected from the material.
  136737. */
  136738. reflectionColor: Color3;
  136739. /**
  136740. * The color emitted from the material.
  136741. */
  136742. emissiveColor: Color3;
  136743. /**
  136744. * AKA Glossiness in other nomenclature.
  136745. */
  136746. microSurface: number;
  136747. /**
  136748. * Index of refraction of the material base layer.
  136749. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  136750. *
  136751. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  136752. *
  136753. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  136754. */
  136755. get indexOfRefraction(): number;
  136756. set indexOfRefraction(value: number);
  136757. /**
  136758. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  136759. */
  136760. get invertRefractionY(): boolean;
  136761. set invertRefractionY(value: boolean);
  136762. /**
  136763. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  136764. * Materials half opaque for instance using refraction could benefit from this control.
  136765. */
  136766. get linkRefractionWithTransparency(): boolean;
  136767. set linkRefractionWithTransparency(value: boolean);
  136768. /**
  136769. * If true, the light map contains occlusion information instead of lighting info.
  136770. */
  136771. useLightmapAsShadowmap: boolean;
  136772. /**
  136773. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136774. */
  136775. useAlphaFromAlbedoTexture: boolean;
  136776. /**
  136777. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136778. */
  136779. forceAlphaTest: boolean;
  136780. /**
  136781. * Defines the alpha limits in alpha test mode.
  136782. */
  136783. alphaCutOff: number;
  136784. /**
  136785. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  136786. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136787. */
  136788. useSpecularOverAlpha: boolean;
  136789. /**
  136790. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136791. */
  136792. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136793. /**
  136794. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136795. */
  136796. useRoughnessFromMetallicTextureAlpha: boolean;
  136797. /**
  136798. * Specifies if the metallic texture contains the roughness information in its green channel.
  136799. */
  136800. useRoughnessFromMetallicTextureGreen: boolean;
  136801. /**
  136802. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136803. */
  136804. useMetallnessFromMetallicTextureBlue: boolean;
  136805. /**
  136806. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136807. */
  136808. useAmbientOcclusionFromMetallicTextureRed: boolean;
  136809. /**
  136810. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136811. */
  136812. useAmbientInGrayScale: boolean;
  136813. /**
  136814. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136815. * The material will try to infer what glossiness each pixel should be.
  136816. */
  136817. useAutoMicroSurfaceFromReflectivityMap: boolean;
  136818. /**
  136819. * BJS is using an harcoded light falloff based on a manually sets up range.
  136820. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136821. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136822. */
  136823. get usePhysicalLightFalloff(): boolean;
  136824. /**
  136825. * BJS is using an harcoded light falloff based on a manually sets up range.
  136826. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136827. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136828. */
  136829. set usePhysicalLightFalloff(value: boolean);
  136830. /**
  136831. * In order to support the falloff compatibility with gltf, a special mode has been added
  136832. * to reproduce the gltf light falloff.
  136833. */
  136834. get useGLTFLightFalloff(): boolean;
  136835. /**
  136836. * In order to support the falloff compatibility with gltf, a special mode has been added
  136837. * to reproduce the gltf light falloff.
  136838. */
  136839. set useGLTFLightFalloff(value: boolean);
  136840. /**
  136841. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136842. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136843. */
  136844. useRadianceOverAlpha: boolean;
  136845. /**
  136846. * Allows using an object space normal map (instead of tangent space).
  136847. */
  136848. useObjectSpaceNormalMap: boolean;
  136849. /**
  136850. * Allows using the bump map in parallax mode.
  136851. */
  136852. useParallax: boolean;
  136853. /**
  136854. * Allows using the bump map in parallax occlusion mode.
  136855. */
  136856. useParallaxOcclusion: boolean;
  136857. /**
  136858. * Controls the scale bias of the parallax mode.
  136859. */
  136860. parallaxScaleBias: number;
  136861. /**
  136862. * If sets to true, disables all the lights affecting the material.
  136863. */
  136864. disableLighting: boolean;
  136865. /**
  136866. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136867. */
  136868. forceIrradianceInFragment: boolean;
  136869. /**
  136870. * Number of Simultaneous lights allowed on the material.
  136871. */
  136872. maxSimultaneousLights: number;
  136873. /**
  136874. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  136875. */
  136876. invertNormalMapX: boolean;
  136877. /**
  136878. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  136879. */
  136880. invertNormalMapY: boolean;
  136881. /**
  136882. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136883. */
  136884. twoSidedLighting: boolean;
  136885. /**
  136886. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136887. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136888. */
  136889. useAlphaFresnel: boolean;
  136890. /**
  136891. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136892. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136893. */
  136894. useLinearAlphaFresnel: boolean;
  136895. /**
  136896. * Let user defines the brdf lookup texture used for IBL.
  136897. * A default 8bit version is embedded but you could point at :
  136898. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  136899. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  136900. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  136901. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  136902. */
  136903. environmentBRDFTexture: Nullable<BaseTexture>;
  136904. /**
  136905. * Force normal to face away from face.
  136906. */
  136907. forceNormalForward: boolean;
  136908. /**
  136909. * Enables specular anti aliasing in the PBR shader.
  136910. * It will both interacts on the Geometry for analytical and IBL lighting.
  136911. * It also prefilter the roughness map based on the bump values.
  136912. */
  136913. enableSpecularAntiAliasing: boolean;
  136914. /**
  136915. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136916. * makes the reflect vector face the model (under horizon).
  136917. */
  136918. useHorizonOcclusion: boolean;
  136919. /**
  136920. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136921. * too much the area relying on ambient texture to define their ambient occlusion.
  136922. */
  136923. useRadianceOcclusion: boolean;
  136924. /**
  136925. * If set to true, no lighting calculations will be applied.
  136926. */
  136927. unlit: boolean;
  136928. /**
  136929. * Gets the image processing configuration used either in this material.
  136930. */
  136931. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  136932. /**
  136933. * Sets the Default image processing configuration used either in the this material.
  136934. *
  136935. * If sets to null, the scene one is in use.
  136936. */
  136937. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  136938. /**
  136939. * Gets wether the color curves effect is enabled.
  136940. */
  136941. get cameraColorCurvesEnabled(): boolean;
  136942. /**
  136943. * Sets wether the color curves effect is enabled.
  136944. */
  136945. set cameraColorCurvesEnabled(value: boolean);
  136946. /**
  136947. * Gets wether the color grading effect is enabled.
  136948. */
  136949. get cameraColorGradingEnabled(): boolean;
  136950. /**
  136951. * Gets wether the color grading effect is enabled.
  136952. */
  136953. set cameraColorGradingEnabled(value: boolean);
  136954. /**
  136955. * Gets wether tonemapping is enabled or not.
  136956. */
  136957. get cameraToneMappingEnabled(): boolean;
  136958. /**
  136959. * Sets wether tonemapping is enabled or not
  136960. */
  136961. set cameraToneMappingEnabled(value: boolean);
  136962. /**
  136963. * The camera exposure used on this material.
  136964. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136965. * This corresponds to a photographic exposure.
  136966. */
  136967. get cameraExposure(): number;
  136968. /**
  136969. * The camera exposure used on this material.
  136970. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136971. * This corresponds to a photographic exposure.
  136972. */
  136973. set cameraExposure(value: number);
  136974. /**
  136975. * Gets The camera contrast used on this material.
  136976. */
  136977. get cameraContrast(): number;
  136978. /**
  136979. * Sets The camera contrast used on this material.
  136980. */
  136981. set cameraContrast(value: number);
  136982. /**
  136983. * Gets the Color Grading 2D Lookup Texture.
  136984. */
  136985. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  136986. /**
  136987. * Sets the Color Grading 2D Lookup Texture.
  136988. */
  136989. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  136990. /**
  136991. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  136992. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  136993. * 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;
  136994. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  136995. */
  136996. get cameraColorCurves(): Nullable<ColorCurves>;
  136997. /**
  136998. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  136999. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  137000. * 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;
  137001. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  137002. */
  137003. set cameraColorCurves(value: Nullable<ColorCurves>);
  137004. /**
  137005. * Instantiates a new PBRMaterial instance.
  137006. *
  137007. * @param name The material name
  137008. * @param scene The scene the material will be use in.
  137009. */
  137010. constructor(name: string, scene: Scene);
  137011. /**
  137012. * Returns the name of this material class.
  137013. */
  137014. getClassName(): string;
  137015. /**
  137016. * Makes a duplicate of the current material.
  137017. * @param name - name to use for the new material.
  137018. */
  137019. clone(name: string): PBRMaterial;
  137020. /**
  137021. * Serializes this PBR Material.
  137022. * @returns - An object with the serialized material.
  137023. */
  137024. serialize(): any;
  137025. /**
  137026. * Parses a PBR Material from a serialized object.
  137027. * @param source - Serialized object.
  137028. * @param scene - BJS scene instance.
  137029. * @param rootUrl - url for the scene object
  137030. * @returns - PBRMaterial
  137031. */
  137032. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  137033. }
  137034. }
  137035. declare module BABYLON {
  137036. /**
  137037. * Direct draw surface info
  137038. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  137039. */
  137040. export interface DDSInfo {
  137041. /**
  137042. * Width of the texture
  137043. */
  137044. width: number;
  137045. /**
  137046. * Width of the texture
  137047. */
  137048. height: number;
  137049. /**
  137050. * Number of Mipmaps for the texture
  137051. * @see https://en.wikipedia.org/wiki/Mipmap
  137052. */
  137053. mipmapCount: number;
  137054. /**
  137055. * If the textures format is a known fourCC format
  137056. * @see https://www.fourcc.org/
  137057. */
  137058. isFourCC: boolean;
  137059. /**
  137060. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  137061. */
  137062. isRGB: boolean;
  137063. /**
  137064. * If the texture is a lumincance format
  137065. */
  137066. isLuminance: boolean;
  137067. /**
  137068. * If this is a cube texture
  137069. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  137070. */
  137071. isCube: boolean;
  137072. /**
  137073. * If the texture is a compressed format eg. FOURCC_DXT1
  137074. */
  137075. isCompressed: boolean;
  137076. /**
  137077. * The dxgiFormat of the texture
  137078. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  137079. */
  137080. dxgiFormat: number;
  137081. /**
  137082. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  137083. */
  137084. textureType: number;
  137085. /**
  137086. * Sphericle polynomial created for the dds texture
  137087. */
  137088. sphericalPolynomial?: SphericalPolynomial;
  137089. }
  137090. /**
  137091. * Class used to provide DDS decompression tools
  137092. */
  137093. export class DDSTools {
  137094. /**
  137095. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  137096. */
  137097. static StoreLODInAlphaChannel: boolean;
  137098. /**
  137099. * Gets DDS information from an array buffer
  137100. * @param data defines the array buffer view to read data from
  137101. * @returns the DDS information
  137102. */
  137103. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  137104. private static _FloatView;
  137105. private static _Int32View;
  137106. private static _ToHalfFloat;
  137107. private static _FromHalfFloat;
  137108. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  137109. private static _GetHalfFloatRGBAArrayBuffer;
  137110. private static _GetFloatRGBAArrayBuffer;
  137111. private static _GetFloatAsUIntRGBAArrayBuffer;
  137112. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  137113. private static _GetRGBAArrayBuffer;
  137114. private static _ExtractLongWordOrder;
  137115. private static _GetRGBArrayBuffer;
  137116. private static _GetLuminanceArrayBuffer;
  137117. /**
  137118. * Uploads DDS Levels to a Babylon Texture
  137119. * @hidden
  137120. */
  137121. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  137122. }
  137123. interface ThinEngine {
  137124. /**
  137125. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  137126. * @param rootUrl defines the url where the file to load is located
  137127. * @param scene defines the current scene
  137128. * @param lodScale defines scale to apply to the mip map selection
  137129. * @param lodOffset defines offset to apply to the mip map selection
  137130. * @param onLoad defines an optional callback raised when the texture is loaded
  137131. * @param onError defines an optional callback raised if there is an issue to load the texture
  137132. * @param format defines the format of the data
  137133. * @param forcedExtension defines the extension to use to pick the right loader
  137134. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  137135. * @returns the cube texture as an InternalTexture
  137136. */
  137137. 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;
  137138. }
  137139. }
  137140. declare module BABYLON {
  137141. /**
  137142. * Implementation of the DDS Texture Loader.
  137143. * @hidden
  137144. */
  137145. export class _DDSTextureLoader implements IInternalTextureLoader {
  137146. /**
  137147. * Defines wether the loader supports cascade loading the different faces.
  137148. */
  137149. readonly supportCascades: boolean;
  137150. /**
  137151. * This returns if the loader support the current file information.
  137152. * @param extension defines the file extension of the file being loaded
  137153. * @returns true if the loader can load the specified file
  137154. */
  137155. canLoad(extension: string): boolean;
  137156. /**
  137157. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137158. * @param data contains the texture data
  137159. * @param texture defines the BabylonJS internal texture
  137160. * @param createPolynomials will be true if polynomials have been requested
  137161. * @param onLoad defines the callback to trigger once the texture is ready
  137162. * @param onError defines the callback to trigger in case of error
  137163. */
  137164. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137165. /**
  137166. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137167. * @param data contains the texture data
  137168. * @param texture defines the BabylonJS internal texture
  137169. * @param callback defines the method to call once ready to upload
  137170. */
  137171. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137172. }
  137173. }
  137174. declare module BABYLON {
  137175. /**
  137176. * Implementation of the ENV Texture Loader.
  137177. * @hidden
  137178. */
  137179. export class _ENVTextureLoader implements IInternalTextureLoader {
  137180. /**
  137181. * Defines wether the loader supports cascade loading the different faces.
  137182. */
  137183. readonly supportCascades: boolean;
  137184. /**
  137185. * This returns if the loader support the current file information.
  137186. * @param extension defines the file extension of the file being loaded
  137187. * @returns true if the loader can load the specified file
  137188. */
  137189. canLoad(extension: string): boolean;
  137190. /**
  137191. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137192. * @param data contains the texture data
  137193. * @param texture defines the BabylonJS internal texture
  137194. * @param createPolynomials will be true if polynomials have been requested
  137195. * @param onLoad defines the callback to trigger once the texture is ready
  137196. * @param onError defines the callback to trigger in case of error
  137197. */
  137198. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137199. /**
  137200. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137201. * @param data contains the texture data
  137202. * @param texture defines the BabylonJS internal texture
  137203. * @param callback defines the method to call once ready to upload
  137204. */
  137205. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137206. }
  137207. }
  137208. declare module BABYLON {
  137209. /**
  137210. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  137211. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  137212. */
  137213. export class KhronosTextureContainer {
  137214. /** contents of the KTX container file */
  137215. data: ArrayBufferView;
  137216. private static HEADER_LEN;
  137217. private static COMPRESSED_2D;
  137218. private static COMPRESSED_3D;
  137219. private static TEX_2D;
  137220. private static TEX_3D;
  137221. /**
  137222. * Gets the openGL type
  137223. */
  137224. glType: number;
  137225. /**
  137226. * Gets the openGL type size
  137227. */
  137228. glTypeSize: number;
  137229. /**
  137230. * Gets the openGL format
  137231. */
  137232. glFormat: number;
  137233. /**
  137234. * Gets the openGL internal format
  137235. */
  137236. glInternalFormat: number;
  137237. /**
  137238. * Gets the base internal format
  137239. */
  137240. glBaseInternalFormat: number;
  137241. /**
  137242. * Gets image width in pixel
  137243. */
  137244. pixelWidth: number;
  137245. /**
  137246. * Gets image height in pixel
  137247. */
  137248. pixelHeight: number;
  137249. /**
  137250. * Gets image depth in pixels
  137251. */
  137252. pixelDepth: number;
  137253. /**
  137254. * Gets the number of array elements
  137255. */
  137256. numberOfArrayElements: number;
  137257. /**
  137258. * Gets the number of faces
  137259. */
  137260. numberOfFaces: number;
  137261. /**
  137262. * Gets the number of mipmap levels
  137263. */
  137264. numberOfMipmapLevels: number;
  137265. /**
  137266. * Gets the bytes of key value data
  137267. */
  137268. bytesOfKeyValueData: number;
  137269. /**
  137270. * Gets the load type
  137271. */
  137272. loadType: number;
  137273. /**
  137274. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  137275. */
  137276. isInvalid: boolean;
  137277. /**
  137278. * Creates a new KhronosTextureContainer
  137279. * @param data contents of the KTX container file
  137280. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  137281. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  137282. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  137283. */
  137284. constructor(
  137285. /** contents of the KTX container file */
  137286. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  137287. /**
  137288. * Uploads KTX content to a Babylon Texture.
  137289. * It is assumed that the texture has already been created & is currently bound
  137290. * @hidden
  137291. */
  137292. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  137293. private _upload2DCompressedLevels;
  137294. /**
  137295. * Checks if the given data starts with a KTX file identifier.
  137296. * @param data the data to check
  137297. * @returns true if the data is a KTX file or false otherwise
  137298. */
  137299. static IsValid(data: ArrayBufferView): boolean;
  137300. }
  137301. }
  137302. declare module BABYLON {
  137303. /**
  137304. * Class for loading KTX2 files
  137305. * !!! Experimental Extension Subject to Changes !!!
  137306. * @hidden
  137307. */
  137308. export class KhronosTextureContainer2 {
  137309. private static _ModulePromise;
  137310. private static _TranscodeFormat;
  137311. constructor(engine: ThinEngine);
  137312. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  137313. private _determineTranscodeFormat;
  137314. /**
  137315. * Checks if the given data starts with a KTX2 file identifier.
  137316. * @param data the data to check
  137317. * @returns true if the data is a KTX2 file or false otherwise
  137318. */
  137319. static IsValid(data: ArrayBufferView): boolean;
  137320. }
  137321. }
  137322. declare module BABYLON {
  137323. /**
  137324. * Implementation of the KTX Texture Loader.
  137325. * @hidden
  137326. */
  137327. export class _KTXTextureLoader implements IInternalTextureLoader {
  137328. /**
  137329. * Defines wether the loader supports cascade loading the different faces.
  137330. */
  137331. readonly supportCascades: boolean;
  137332. /**
  137333. * This returns if the loader support the current file information.
  137334. * @param extension defines the file extension of the file being loaded
  137335. * @param mimeType defines the optional mime type of the file being loaded
  137336. * @returns true if the loader can load the specified file
  137337. */
  137338. canLoad(extension: string, mimeType?: string): boolean;
  137339. /**
  137340. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137341. * @param data contains the texture data
  137342. * @param texture defines the BabylonJS internal texture
  137343. * @param createPolynomials will be true if polynomials have been requested
  137344. * @param onLoad defines the callback to trigger once the texture is ready
  137345. * @param onError defines the callback to trigger in case of error
  137346. */
  137347. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137348. /**
  137349. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137350. * @param data contains the texture data
  137351. * @param texture defines the BabylonJS internal texture
  137352. * @param callback defines the method to call once ready to upload
  137353. */
  137354. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  137355. }
  137356. }
  137357. declare module BABYLON {
  137358. /** @hidden */
  137359. export var _forceSceneHelpersToBundle: boolean;
  137360. interface Scene {
  137361. /**
  137362. * Creates a default light for the scene.
  137363. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  137364. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  137365. */
  137366. createDefaultLight(replace?: boolean): void;
  137367. /**
  137368. * Creates a default camera for the scene.
  137369. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  137370. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137371. * @param replace has default false, when true replaces the active camera in the scene
  137372. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  137373. */
  137374. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137375. /**
  137376. * Creates a default camera and a default light.
  137377. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  137378. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137379. * @param replace has the default false, when true replaces the active camera/light in the scene
  137380. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  137381. */
  137382. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137383. /**
  137384. * Creates a new sky box
  137385. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  137386. * @param environmentTexture defines the texture to use as environment texture
  137387. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  137388. * @param scale defines the overall scale of the skybox
  137389. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  137390. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  137391. * @returns a new mesh holding the sky box
  137392. */
  137393. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  137394. /**
  137395. * Creates a new environment
  137396. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  137397. * @param options defines the options you can use to configure the environment
  137398. * @returns the new EnvironmentHelper
  137399. */
  137400. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  137401. /**
  137402. * Creates a new VREXperienceHelper
  137403. * @see https://doc.babylonjs.com/how_to/webvr_helper
  137404. * @param webVROptions defines the options used to create the new VREXperienceHelper
  137405. * @returns a new VREXperienceHelper
  137406. */
  137407. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  137408. /**
  137409. * Creates a new WebXRDefaultExperience
  137410. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  137411. * @param options experience options
  137412. * @returns a promise for a new WebXRDefaultExperience
  137413. */
  137414. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  137415. }
  137416. }
  137417. declare module BABYLON {
  137418. /**
  137419. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  137420. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  137421. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  137422. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  137423. */
  137424. export class VideoDome extends TextureDome<VideoTexture> {
  137425. /**
  137426. * Define the video source as a Monoscopic panoramic 360 video.
  137427. */
  137428. static readonly MODE_MONOSCOPIC: number;
  137429. /**
  137430. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  137431. */
  137432. static readonly MODE_TOPBOTTOM: number;
  137433. /**
  137434. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  137435. */
  137436. static readonly MODE_SIDEBYSIDE: number;
  137437. /**
  137438. * Get the video texture associated with this video dome
  137439. */
  137440. get videoTexture(): VideoTexture;
  137441. /**
  137442. * Get the video mode of this dome
  137443. */
  137444. get videoMode(): number;
  137445. /**
  137446. * Set the video mode of this dome.
  137447. * @see textureMode
  137448. */
  137449. set videoMode(value: number);
  137450. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  137451. }
  137452. }
  137453. declare module BABYLON {
  137454. /**
  137455. * This class can be used to get instrumentation data from a Babylon engine
  137456. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137457. */
  137458. export class EngineInstrumentation implements IDisposable {
  137459. /**
  137460. * Define the instrumented engine.
  137461. */
  137462. engine: Engine;
  137463. private _captureGPUFrameTime;
  137464. private _gpuFrameTimeToken;
  137465. private _gpuFrameTime;
  137466. private _captureShaderCompilationTime;
  137467. private _shaderCompilationTime;
  137468. private _onBeginFrameObserver;
  137469. private _onEndFrameObserver;
  137470. private _onBeforeShaderCompilationObserver;
  137471. private _onAfterShaderCompilationObserver;
  137472. /**
  137473. * Gets the perf counter used for GPU frame time
  137474. */
  137475. get gpuFrameTimeCounter(): PerfCounter;
  137476. /**
  137477. * Gets the GPU frame time capture status
  137478. */
  137479. get captureGPUFrameTime(): boolean;
  137480. /**
  137481. * Enable or disable the GPU frame time capture
  137482. */
  137483. set captureGPUFrameTime(value: boolean);
  137484. /**
  137485. * Gets the perf counter used for shader compilation time
  137486. */
  137487. get shaderCompilationTimeCounter(): PerfCounter;
  137488. /**
  137489. * Gets the shader compilation time capture status
  137490. */
  137491. get captureShaderCompilationTime(): boolean;
  137492. /**
  137493. * Enable or disable the shader compilation time capture
  137494. */
  137495. set captureShaderCompilationTime(value: boolean);
  137496. /**
  137497. * Instantiates a new engine instrumentation.
  137498. * This class can be used to get instrumentation data from a Babylon engine
  137499. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137500. * @param engine Defines the engine to instrument
  137501. */
  137502. constructor(
  137503. /**
  137504. * Define the instrumented engine.
  137505. */
  137506. engine: Engine);
  137507. /**
  137508. * Dispose and release associated resources.
  137509. */
  137510. dispose(): void;
  137511. }
  137512. }
  137513. declare module BABYLON {
  137514. /**
  137515. * This class can be used to get instrumentation data from a Babylon engine
  137516. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137517. */
  137518. export class SceneInstrumentation implements IDisposable {
  137519. /**
  137520. * Defines the scene to instrument
  137521. */
  137522. scene: Scene;
  137523. private _captureActiveMeshesEvaluationTime;
  137524. private _activeMeshesEvaluationTime;
  137525. private _captureRenderTargetsRenderTime;
  137526. private _renderTargetsRenderTime;
  137527. private _captureFrameTime;
  137528. private _frameTime;
  137529. private _captureRenderTime;
  137530. private _renderTime;
  137531. private _captureInterFrameTime;
  137532. private _interFrameTime;
  137533. private _captureParticlesRenderTime;
  137534. private _particlesRenderTime;
  137535. private _captureSpritesRenderTime;
  137536. private _spritesRenderTime;
  137537. private _capturePhysicsTime;
  137538. private _physicsTime;
  137539. private _captureAnimationsTime;
  137540. private _animationsTime;
  137541. private _captureCameraRenderTime;
  137542. private _cameraRenderTime;
  137543. private _onBeforeActiveMeshesEvaluationObserver;
  137544. private _onAfterActiveMeshesEvaluationObserver;
  137545. private _onBeforeRenderTargetsRenderObserver;
  137546. private _onAfterRenderTargetsRenderObserver;
  137547. private _onAfterRenderObserver;
  137548. private _onBeforeDrawPhaseObserver;
  137549. private _onAfterDrawPhaseObserver;
  137550. private _onBeforeAnimationsObserver;
  137551. private _onBeforeParticlesRenderingObserver;
  137552. private _onAfterParticlesRenderingObserver;
  137553. private _onBeforeSpritesRenderingObserver;
  137554. private _onAfterSpritesRenderingObserver;
  137555. private _onBeforePhysicsObserver;
  137556. private _onAfterPhysicsObserver;
  137557. private _onAfterAnimationsObserver;
  137558. private _onBeforeCameraRenderObserver;
  137559. private _onAfterCameraRenderObserver;
  137560. /**
  137561. * Gets the perf counter used for active meshes evaluation time
  137562. */
  137563. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  137564. /**
  137565. * Gets the active meshes evaluation time capture status
  137566. */
  137567. get captureActiveMeshesEvaluationTime(): boolean;
  137568. /**
  137569. * Enable or disable the active meshes evaluation time capture
  137570. */
  137571. set captureActiveMeshesEvaluationTime(value: boolean);
  137572. /**
  137573. * Gets the perf counter used for render targets render time
  137574. */
  137575. get renderTargetsRenderTimeCounter(): PerfCounter;
  137576. /**
  137577. * Gets the render targets render time capture status
  137578. */
  137579. get captureRenderTargetsRenderTime(): boolean;
  137580. /**
  137581. * Enable or disable the render targets render time capture
  137582. */
  137583. set captureRenderTargetsRenderTime(value: boolean);
  137584. /**
  137585. * Gets the perf counter used for particles render time
  137586. */
  137587. get particlesRenderTimeCounter(): PerfCounter;
  137588. /**
  137589. * Gets the particles render time capture status
  137590. */
  137591. get captureParticlesRenderTime(): boolean;
  137592. /**
  137593. * Enable or disable the particles render time capture
  137594. */
  137595. set captureParticlesRenderTime(value: boolean);
  137596. /**
  137597. * Gets the perf counter used for sprites render time
  137598. */
  137599. get spritesRenderTimeCounter(): PerfCounter;
  137600. /**
  137601. * Gets the sprites render time capture status
  137602. */
  137603. get captureSpritesRenderTime(): boolean;
  137604. /**
  137605. * Enable or disable the sprites render time capture
  137606. */
  137607. set captureSpritesRenderTime(value: boolean);
  137608. /**
  137609. * Gets the perf counter used for physics time
  137610. */
  137611. get physicsTimeCounter(): PerfCounter;
  137612. /**
  137613. * Gets the physics time capture status
  137614. */
  137615. get capturePhysicsTime(): boolean;
  137616. /**
  137617. * Enable or disable the physics time capture
  137618. */
  137619. set capturePhysicsTime(value: boolean);
  137620. /**
  137621. * Gets the perf counter used for animations time
  137622. */
  137623. get animationsTimeCounter(): PerfCounter;
  137624. /**
  137625. * Gets the animations time capture status
  137626. */
  137627. get captureAnimationsTime(): boolean;
  137628. /**
  137629. * Enable or disable the animations time capture
  137630. */
  137631. set captureAnimationsTime(value: boolean);
  137632. /**
  137633. * Gets the perf counter used for frame time capture
  137634. */
  137635. get frameTimeCounter(): PerfCounter;
  137636. /**
  137637. * Gets the frame time capture status
  137638. */
  137639. get captureFrameTime(): boolean;
  137640. /**
  137641. * Enable or disable the frame time capture
  137642. */
  137643. set captureFrameTime(value: boolean);
  137644. /**
  137645. * Gets the perf counter used for inter-frames time capture
  137646. */
  137647. get interFrameTimeCounter(): PerfCounter;
  137648. /**
  137649. * Gets the inter-frames time capture status
  137650. */
  137651. get captureInterFrameTime(): boolean;
  137652. /**
  137653. * Enable or disable the inter-frames time capture
  137654. */
  137655. set captureInterFrameTime(value: boolean);
  137656. /**
  137657. * Gets the perf counter used for render time capture
  137658. */
  137659. get renderTimeCounter(): PerfCounter;
  137660. /**
  137661. * Gets the render time capture status
  137662. */
  137663. get captureRenderTime(): boolean;
  137664. /**
  137665. * Enable or disable the render time capture
  137666. */
  137667. set captureRenderTime(value: boolean);
  137668. /**
  137669. * Gets the perf counter used for camera render time capture
  137670. */
  137671. get cameraRenderTimeCounter(): PerfCounter;
  137672. /**
  137673. * Gets the camera render time capture status
  137674. */
  137675. get captureCameraRenderTime(): boolean;
  137676. /**
  137677. * Enable or disable the camera render time capture
  137678. */
  137679. set captureCameraRenderTime(value: boolean);
  137680. /**
  137681. * Gets the perf counter used for draw calls
  137682. */
  137683. get drawCallsCounter(): PerfCounter;
  137684. /**
  137685. * Instantiates a new scene instrumentation.
  137686. * This class can be used to get instrumentation data from a Babylon engine
  137687. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137688. * @param scene Defines the scene to instrument
  137689. */
  137690. constructor(
  137691. /**
  137692. * Defines the scene to instrument
  137693. */
  137694. scene: Scene);
  137695. /**
  137696. * Dispose and release associated resources.
  137697. */
  137698. dispose(): void;
  137699. }
  137700. }
  137701. declare module BABYLON {
  137702. /** @hidden */
  137703. export var glowMapGenerationPixelShader: {
  137704. name: string;
  137705. shader: string;
  137706. };
  137707. }
  137708. declare module BABYLON {
  137709. /** @hidden */
  137710. export var glowMapGenerationVertexShader: {
  137711. name: string;
  137712. shader: string;
  137713. };
  137714. }
  137715. declare module BABYLON {
  137716. /**
  137717. * Effect layer options. This helps customizing the behaviour
  137718. * of the effect layer.
  137719. */
  137720. export interface IEffectLayerOptions {
  137721. /**
  137722. * Multiplication factor apply to the canvas size to compute the render target size
  137723. * used to generated the objects (the smaller the faster).
  137724. */
  137725. mainTextureRatio: number;
  137726. /**
  137727. * Enforces a fixed size texture to ensure effect stability across devices.
  137728. */
  137729. mainTextureFixedSize?: number;
  137730. /**
  137731. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  137732. */
  137733. alphaBlendingMode: number;
  137734. /**
  137735. * The camera attached to the layer.
  137736. */
  137737. camera: Nullable<Camera>;
  137738. /**
  137739. * The rendering group to draw the layer in.
  137740. */
  137741. renderingGroupId: number;
  137742. }
  137743. /**
  137744. * The effect layer Helps adding post process effect blended with the main pass.
  137745. *
  137746. * This can be for instance use to generate glow or higlight effects on the scene.
  137747. *
  137748. * The effect layer class can not be used directly and is intented to inherited from to be
  137749. * customized per effects.
  137750. */
  137751. export abstract class EffectLayer {
  137752. private _vertexBuffers;
  137753. private _indexBuffer;
  137754. private _cachedDefines;
  137755. private _effectLayerMapGenerationEffect;
  137756. private _effectLayerOptions;
  137757. private _mergeEffect;
  137758. protected _scene: Scene;
  137759. protected _engine: Engine;
  137760. protected _maxSize: number;
  137761. protected _mainTextureDesiredSize: ISize;
  137762. protected _mainTexture: RenderTargetTexture;
  137763. protected _shouldRender: boolean;
  137764. protected _postProcesses: PostProcess[];
  137765. protected _textures: BaseTexture[];
  137766. protected _emissiveTextureAndColor: {
  137767. texture: Nullable<BaseTexture>;
  137768. color: Color4;
  137769. };
  137770. /**
  137771. * The name of the layer
  137772. */
  137773. name: string;
  137774. /**
  137775. * The clear color of the texture used to generate the glow map.
  137776. */
  137777. neutralColor: Color4;
  137778. /**
  137779. * Specifies whether the highlight layer is enabled or not.
  137780. */
  137781. isEnabled: boolean;
  137782. /**
  137783. * Gets the camera attached to the layer.
  137784. */
  137785. get camera(): Nullable<Camera>;
  137786. /**
  137787. * Gets the rendering group id the layer should render in.
  137788. */
  137789. get renderingGroupId(): number;
  137790. set renderingGroupId(renderingGroupId: number);
  137791. /**
  137792. * An event triggered when the effect layer has been disposed.
  137793. */
  137794. onDisposeObservable: Observable<EffectLayer>;
  137795. /**
  137796. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  137797. */
  137798. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  137799. /**
  137800. * An event triggered when the generated texture is being merged in the scene.
  137801. */
  137802. onBeforeComposeObservable: Observable<EffectLayer>;
  137803. /**
  137804. * An event triggered when the mesh is rendered into the effect render target.
  137805. */
  137806. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  137807. /**
  137808. * An event triggered after the mesh has been rendered into the effect render target.
  137809. */
  137810. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  137811. /**
  137812. * An event triggered when the generated texture has been merged in the scene.
  137813. */
  137814. onAfterComposeObservable: Observable<EffectLayer>;
  137815. /**
  137816. * An event triggered when the efffect layer changes its size.
  137817. */
  137818. onSizeChangedObservable: Observable<EffectLayer>;
  137819. /** @hidden */
  137820. static _SceneComponentInitialization: (scene: Scene) => void;
  137821. /**
  137822. * Instantiates a new effect Layer and references it in the scene.
  137823. * @param name The name of the layer
  137824. * @param scene The scene to use the layer in
  137825. */
  137826. constructor(
  137827. /** The Friendly of the effect in the scene */
  137828. name: string, scene: Scene);
  137829. /**
  137830. * Get the effect name of the layer.
  137831. * @return The effect name
  137832. */
  137833. abstract getEffectName(): string;
  137834. /**
  137835. * Checks for the readiness of the element composing the layer.
  137836. * @param subMesh the mesh to check for
  137837. * @param useInstances specify whether or not to use instances to render the mesh
  137838. * @return true if ready otherwise, false
  137839. */
  137840. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  137841. /**
  137842. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  137843. * @returns true if the effect requires stencil during the main canvas render pass.
  137844. */
  137845. abstract needStencil(): boolean;
  137846. /**
  137847. * Create the merge effect. This is the shader use to blit the information back
  137848. * to the main canvas at the end of the scene rendering.
  137849. * @returns The effect containing the shader used to merge the effect on the main canvas
  137850. */
  137851. protected abstract _createMergeEffect(): Effect;
  137852. /**
  137853. * Creates the render target textures and post processes used in the effect layer.
  137854. */
  137855. protected abstract _createTextureAndPostProcesses(): void;
  137856. /**
  137857. * Implementation specific of rendering the generating effect on the main canvas.
  137858. * @param effect The effect used to render through
  137859. */
  137860. protected abstract _internalRender(effect: Effect): void;
  137861. /**
  137862. * Sets the required values for both the emissive texture and and the main color.
  137863. */
  137864. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  137865. /**
  137866. * Free any resources and references associated to a mesh.
  137867. * Internal use
  137868. * @param mesh The mesh to free.
  137869. */
  137870. abstract _disposeMesh(mesh: Mesh): void;
  137871. /**
  137872. * Serializes this layer (Glow or Highlight for example)
  137873. * @returns a serialized layer object
  137874. */
  137875. abstract serialize?(): any;
  137876. /**
  137877. * Initializes the effect layer with the required options.
  137878. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  137879. */
  137880. protected _init(options: Partial<IEffectLayerOptions>): void;
  137881. /**
  137882. * Generates the index buffer of the full screen quad blending to the main canvas.
  137883. */
  137884. private _generateIndexBuffer;
  137885. /**
  137886. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  137887. */
  137888. private _generateVertexBuffer;
  137889. /**
  137890. * Sets the main texture desired size which is the closest power of two
  137891. * of the engine canvas size.
  137892. */
  137893. private _setMainTextureSize;
  137894. /**
  137895. * Creates the main texture for the effect layer.
  137896. */
  137897. protected _createMainTexture(): void;
  137898. /**
  137899. * Adds specific effects defines.
  137900. * @param defines The defines to add specifics to.
  137901. */
  137902. protected _addCustomEffectDefines(defines: string[]): void;
  137903. /**
  137904. * Checks for the readiness of the element composing the layer.
  137905. * @param subMesh the mesh to check for
  137906. * @param useInstances specify whether or not to use instances to render the mesh
  137907. * @param emissiveTexture the associated emissive texture used to generate the glow
  137908. * @return true if ready otherwise, false
  137909. */
  137910. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  137911. /**
  137912. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  137913. */
  137914. render(): void;
  137915. /**
  137916. * Determine if a given mesh will be used in the current effect.
  137917. * @param mesh mesh to test
  137918. * @returns true if the mesh will be used
  137919. */
  137920. hasMesh(mesh: AbstractMesh): boolean;
  137921. /**
  137922. * Returns true if the layer contains information to display, otherwise false.
  137923. * @returns true if the glow layer should be rendered
  137924. */
  137925. shouldRender(): boolean;
  137926. /**
  137927. * Returns true if the mesh should render, otherwise false.
  137928. * @param mesh The mesh to render
  137929. * @returns true if it should render otherwise false
  137930. */
  137931. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  137932. /**
  137933. * Returns true if the mesh can be rendered, otherwise false.
  137934. * @param mesh The mesh to render
  137935. * @param material The material used on the mesh
  137936. * @returns true if it can be rendered otherwise false
  137937. */
  137938. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  137939. /**
  137940. * Returns true if the mesh should render, otherwise false.
  137941. * @param mesh The mesh to render
  137942. * @returns true if it should render otherwise false
  137943. */
  137944. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  137945. /**
  137946. * Renders the submesh passed in parameter to the generation map.
  137947. */
  137948. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  137949. /**
  137950. * Defines whether the current material of the mesh should be use to render the effect.
  137951. * @param mesh defines the current mesh to render
  137952. */
  137953. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  137954. /**
  137955. * Rebuild the required buffers.
  137956. * @hidden Internal use only.
  137957. */
  137958. _rebuild(): void;
  137959. /**
  137960. * Dispose only the render target textures and post process.
  137961. */
  137962. private _disposeTextureAndPostProcesses;
  137963. /**
  137964. * Dispose the highlight layer and free resources.
  137965. */
  137966. dispose(): void;
  137967. /**
  137968. * Gets the class name of the effect layer
  137969. * @returns the string with the class name of the effect layer
  137970. */
  137971. getClassName(): string;
  137972. /**
  137973. * Creates an effect layer from parsed effect layer data
  137974. * @param parsedEffectLayer defines effect layer data
  137975. * @param scene defines the current scene
  137976. * @param rootUrl defines the root URL containing the effect layer information
  137977. * @returns a parsed effect Layer
  137978. */
  137979. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  137980. }
  137981. }
  137982. declare module BABYLON {
  137983. interface AbstractScene {
  137984. /**
  137985. * The list of effect layers (highlights/glow) added to the scene
  137986. * @see https://doc.babylonjs.com/how_to/highlight_layer
  137987. * @see https://doc.babylonjs.com/how_to/glow_layer
  137988. */
  137989. effectLayers: Array<EffectLayer>;
  137990. /**
  137991. * Removes the given effect layer from this scene.
  137992. * @param toRemove defines the effect layer to remove
  137993. * @returns the index of the removed effect layer
  137994. */
  137995. removeEffectLayer(toRemove: EffectLayer): number;
  137996. /**
  137997. * Adds the given effect layer to this scene
  137998. * @param newEffectLayer defines the effect layer to add
  137999. */
  138000. addEffectLayer(newEffectLayer: EffectLayer): void;
  138001. }
  138002. /**
  138003. * Defines the layer scene component responsible to manage any effect layers
  138004. * in a given scene.
  138005. */
  138006. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  138007. /**
  138008. * The component name helpfull to identify the component in the list of scene components.
  138009. */
  138010. readonly name: string;
  138011. /**
  138012. * The scene the component belongs to.
  138013. */
  138014. scene: Scene;
  138015. private _engine;
  138016. private _renderEffects;
  138017. private _needStencil;
  138018. private _previousStencilState;
  138019. /**
  138020. * Creates a new instance of the component for the given scene
  138021. * @param scene Defines the scene to register the component in
  138022. */
  138023. constructor(scene: Scene);
  138024. /**
  138025. * Registers the component in a given scene
  138026. */
  138027. register(): void;
  138028. /**
  138029. * Rebuilds the elements related to this component in case of
  138030. * context lost for instance.
  138031. */
  138032. rebuild(): void;
  138033. /**
  138034. * Serializes the component data to the specified json object
  138035. * @param serializationObject The object to serialize to
  138036. */
  138037. serialize(serializationObject: any): void;
  138038. /**
  138039. * Adds all the elements from the container to the scene
  138040. * @param container the container holding the elements
  138041. */
  138042. addFromContainer(container: AbstractScene): void;
  138043. /**
  138044. * Removes all the elements in the container from the scene
  138045. * @param container contains the elements to remove
  138046. * @param dispose if the removed element should be disposed (default: false)
  138047. */
  138048. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138049. /**
  138050. * Disposes the component and the associated ressources.
  138051. */
  138052. dispose(): void;
  138053. private _isReadyForMesh;
  138054. private _renderMainTexture;
  138055. private _setStencil;
  138056. private _setStencilBack;
  138057. private _draw;
  138058. private _drawCamera;
  138059. private _drawRenderingGroup;
  138060. }
  138061. }
  138062. declare module BABYLON {
  138063. /** @hidden */
  138064. export var glowMapMergePixelShader: {
  138065. name: string;
  138066. shader: string;
  138067. };
  138068. }
  138069. declare module BABYLON {
  138070. /** @hidden */
  138071. export var glowMapMergeVertexShader: {
  138072. name: string;
  138073. shader: string;
  138074. };
  138075. }
  138076. declare module BABYLON {
  138077. interface AbstractScene {
  138078. /**
  138079. * Return a the first highlight layer of the scene with a given name.
  138080. * @param name The name of the highlight layer to look for.
  138081. * @return The highlight layer if found otherwise null.
  138082. */
  138083. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  138084. }
  138085. /**
  138086. * Glow layer options. This helps customizing the behaviour
  138087. * of the glow layer.
  138088. */
  138089. export interface IGlowLayerOptions {
  138090. /**
  138091. * Multiplication factor apply to the canvas size to compute the render target size
  138092. * used to generated the glowing objects (the smaller the faster).
  138093. */
  138094. mainTextureRatio: number;
  138095. /**
  138096. * Enforces a fixed size texture to ensure resize independant blur.
  138097. */
  138098. mainTextureFixedSize?: number;
  138099. /**
  138100. * How big is the kernel of the blur texture.
  138101. */
  138102. blurKernelSize: number;
  138103. /**
  138104. * The camera attached to the layer.
  138105. */
  138106. camera: Nullable<Camera>;
  138107. /**
  138108. * Enable MSAA by chosing the number of samples.
  138109. */
  138110. mainTextureSamples?: number;
  138111. /**
  138112. * The rendering group to draw the layer in.
  138113. */
  138114. renderingGroupId: number;
  138115. }
  138116. /**
  138117. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  138118. *
  138119. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  138120. *
  138121. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  138122. */
  138123. export class GlowLayer extends EffectLayer {
  138124. /**
  138125. * Effect Name of the layer.
  138126. */
  138127. static readonly EffectName: string;
  138128. /**
  138129. * The default blur kernel size used for the glow.
  138130. */
  138131. static DefaultBlurKernelSize: number;
  138132. /**
  138133. * The default texture size ratio used for the glow.
  138134. */
  138135. static DefaultTextureRatio: number;
  138136. /**
  138137. * Sets the kernel size of the blur.
  138138. */
  138139. set blurKernelSize(value: number);
  138140. /**
  138141. * Gets the kernel size of the blur.
  138142. */
  138143. get blurKernelSize(): number;
  138144. /**
  138145. * Sets the glow intensity.
  138146. */
  138147. set intensity(value: number);
  138148. /**
  138149. * Gets the glow intensity.
  138150. */
  138151. get intensity(): number;
  138152. private _options;
  138153. private _intensity;
  138154. private _horizontalBlurPostprocess1;
  138155. private _verticalBlurPostprocess1;
  138156. private _horizontalBlurPostprocess2;
  138157. private _verticalBlurPostprocess2;
  138158. private _blurTexture1;
  138159. private _blurTexture2;
  138160. private _postProcesses1;
  138161. private _postProcesses2;
  138162. private _includedOnlyMeshes;
  138163. private _excludedMeshes;
  138164. private _meshesUsingTheirOwnMaterials;
  138165. /**
  138166. * Callback used to let the user override the color selection on a per mesh basis
  138167. */
  138168. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  138169. /**
  138170. * Callback used to let the user override the texture selection on a per mesh basis
  138171. */
  138172. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  138173. /**
  138174. * Instantiates a new glow Layer and references it to the scene.
  138175. * @param name The name of the layer
  138176. * @param scene The scene to use the layer in
  138177. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  138178. */
  138179. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  138180. /**
  138181. * Get the effect name of the layer.
  138182. * @return The effect name
  138183. */
  138184. getEffectName(): string;
  138185. /**
  138186. * Create the merge effect. This is the shader use to blit the information back
  138187. * to the main canvas at the end of the scene rendering.
  138188. */
  138189. protected _createMergeEffect(): Effect;
  138190. /**
  138191. * Creates the render target textures and post processes used in the glow layer.
  138192. */
  138193. protected _createTextureAndPostProcesses(): void;
  138194. /**
  138195. * Checks for the readiness of the element composing the layer.
  138196. * @param subMesh the mesh to check for
  138197. * @param useInstances specify wether or not to use instances to render the mesh
  138198. * @param emissiveTexture the associated emissive texture used to generate the glow
  138199. * @return true if ready otherwise, false
  138200. */
  138201. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138202. /**
  138203. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  138204. */
  138205. needStencil(): boolean;
  138206. /**
  138207. * Returns true if the mesh can be rendered, otherwise false.
  138208. * @param mesh The mesh to render
  138209. * @param material The material used on the mesh
  138210. * @returns true if it can be rendered otherwise false
  138211. */
  138212. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138213. /**
  138214. * Implementation specific of rendering the generating effect on the main canvas.
  138215. * @param effect The effect used to render through
  138216. */
  138217. protected _internalRender(effect: Effect): void;
  138218. /**
  138219. * Sets the required values for both the emissive texture and and the main color.
  138220. */
  138221. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138222. /**
  138223. * Returns true if the mesh should render, otherwise false.
  138224. * @param mesh The mesh to render
  138225. * @returns true if it should render otherwise false
  138226. */
  138227. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138228. /**
  138229. * Adds specific effects defines.
  138230. * @param defines The defines to add specifics to.
  138231. */
  138232. protected _addCustomEffectDefines(defines: string[]): void;
  138233. /**
  138234. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  138235. * @param mesh The mesh to exclude from the glow layer
  138236. */
  138237. addExcludedMesh(mesh: Mesh): void;
  138238. /**
  138239. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  138240. * @param mesh The mesh to remove
  138241. */
  138242. removeExcludedMesh(mesh: Mesh): void;
  138243. /**
  138244. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  138245. * @param mesh The mesh to include in the glow layer
  138246. */
  138247. addIncludedOnlyMesh(mesh: Mesh): void;
  138248. /**
  138249. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  138250. * @param mesh The mesh to remove
  138251. */
  138252. removeIncludedOnlyMesh(mesh: Mesh): void;
  138253. /**
  138254. * Determine if a given mesh will be used in the glow layer
  138255. * @param mesh The mesh to test
  138256. * @returns true if the mesh will be highlighted by the current glow layer
  138257. */
  138258. hasMesh(mesh: AbstractMesh): boolean;
  138259. /**
  138260. * Defines whether the current material of the mesh should be use to render the effect.
  138261. * @param mesh defines the current mesh to render
  138262. */
  138263. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  138264. /**
  138265. * Add a mesh to be rendered through its own material and not with emissive only.
  138266. * @param mesh The mesh for which we need to use its material
  138267. */
  138268. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  138269. /**
  138270. * Remove a mesh from being rendered through its own material and not with emissive only.
  138271. * @param mesh The mesh for which we need to not use its material
  138272. */
  138273. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  138274. /**
  138275. * Free any resources and references associated to a mesh.
  138276. * Internal use
  138277. * @param mesh The mesh to free.
  138278. * @hidden
  138279. */
  138280. _disposeMesh(mesh: Mesh): void;
  138281. /**
  138282. * Gets the class name of the effect layer
  138283. * @returns the string with the class name of the effect layer
  138284. */
  138285. getClassName(): string;
  138286. /**
  138287. * Serializes this glow layer
  138288. * @returns a serialized glow layer object
  138289. */
  138290. serialize(): any;
  138291. /**
  138292. * Creates a Glow Layer from parsed glow layer data
  138293. * @param parsedGlowLayer defines glow layer data
  138294. * @param scene defines the current scene
  138295. * @param rootUrl defines the root URL containing the glow layer information
  138296. * @returns a parsed Glow Layer
  138297. */
  138298. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  138299. }
  138300. }
  138301. declare module BABYLON {
  138302. /** @hidden */
  138303. export var glowBlurPostProcessPixelShader: {
  138304. name: string;
  138305. shader: string;
  138306. };
  138307. }
  138308. declare module BABYLON {
  138309. interface AbstractScene {
  138310. /**
  138311. * Return a the first highlight layer of the scene with a given name.
  138312. * @param name The name of the highlight layer to look for.
  138313. * @return The highlight layer if found otherwise null.
  138314. */
  138315. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  138316. }
  138317. /**
  138318. * Highlight layer options. This helps customizing the behaviour
  138319. * of the highlight layer.
  138320. */
  138321. export interface IHighlightLayerOptions {
  138322. /**
  138323. * Multiplication factor apply to the canvas size to compute the render target size
  138324. * used to generated the glowing objects (the smaller the faster).
  138325. */
  138326. mainTextureRatio: number;
  138327. /**
  138328. * Enforces a fixed size texture to ensure resize independant blur.
  138329. */
  138330. mainTextureFixedSize?: number;
  138331. /**
  138332. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  138333. * of the picture to blur (the smaller the faster).
  138334. */
  138335. blurTextureSizeRatio: number;
  138336. /**
  138337. * How big in texel of the blur texture is the vertical blur.
  138338. */
  138339. blurVerticalSize: number;
  138340. /**
  138341. * How big in texel of the blur texture is the horizontal blur.
  138342. */
  138343. blurHorizontalSize: number;
  138344. /**
  138345. * Alpha blending mode used to apply the blur. Default is combine.
  138346. */
  138347. alphaBlendingMode: number;
  138348. /**
  138349. * The camera attached to the layer.
  138350. */
  138351. camera: Nullable<Camera>;
  138352. /**
  138353. * Should we display highlight as a solid stroke?
  138354. */
  138355. isStroke?: boolean;
  138356. /**
  138357. * The rendering group to draw the layer in.
  138358. */
  138359. renderingGroupId: number;
  138360. }
  138361. /**
  138362. * The highlight layer Helps adding a glow effect around a mesh.
  138363. *
  138364. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  138365. * glowy meshes to your scene.
  138366. *
  138367. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  138368. */
  138369. export class HighlightLayer extends EffectLayer {
  138370. name: string;
  138371. /**
  138372. * Effect Name of the highlight layer.
  138373. */
  138374. static readonly EffectName: string;
  138375. /**
  138376. * The neutral color used during the preparation of the glow effect.
  138377. * This is black by default as the blend operation is a blend operation.
  138378. */
  138379. static NeutralColor: Color4;
  138380. /**
  138381. * Stencil value used for glowing meshes.
  138382. */
  138383. static GlowingMeshStencilReference: number;
  138384. /**
  138385. * Stencil value used for the other meshes in the scene.
  138386. */
  138387. static NormalMeshStencilReference: number;
  138388. /**
  138389. * Specifies whether or not the inner glow is ACTIVE in the layer.
  138390. */
  138391. innerGlow: boolean;
  138392. /**
  138393. * Specifies whether or not the outer glow is ACTIVE in the layer.
  138394. */
  138395. outerGlow: boolean;
  138396. /**
  138397. * Specifies the horizontal size of the blur.
  138398. */
  138399. set blurHorizontalSize(value: number);
  138400. /**
  138401. * Specifies the vertical size of the blur.
  138402. */
  138403. set blurVerticalSize(value: number);
  138404. /**
  138405. * Gets the horizontal size of the blur.
  138406. */
  138407. get blurHorizontalSize(): number;
  138408. /**
  138409. * Gets the vertical size of the blur.
  138410. */
  138411. get blurVerticalSize(): number;
  138412. /**
  138413. * An event triggered when the highlight layer is being blurred.
  138414. */
  138415. onBeforeBlurObservable: Observable<HighlightLayer>;
  138416. /**
  138417. * An event triggered when the highlight layer has been blurred.
  138418. */
  138419. onAfterBlurObservable: Observable<HighlightLayer>;
  138420. private _instanceGlowingMeshStencilReference;
  138421. private _options;
  138422. private _downSamplePostprocess;
  138423. private _horizontalBlurPostprocess;
  138424. private _verticalBlurPostprocess;
  138425. private _blurTexture;
  138426. private _meshes;
  138427. private _excludedMeshes;
  138428. /**
  138429. * Instantiates a new highlight Layer and references it to the scene..
  138430. * @param name The name of the layer
  138431. * @param scene The scene to use the layer in
  138432. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  138433. */
  138434. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  138435. /**
  138436. * Get the effect name of the layer.
  138437. * @return The effect name
  138438. */
  138439. getEffectName(): string;
  138440. /**
  138441. * Create the merge effect. This is the shader use to blit the information back
  138442. * to the main canvas at the end of the scene rendering.
  138443. */
  138444. protected _createMergeEffect(): Effect;
  138445. /**
  138446. * Creates the render target textures and post processes used in the highlight layer.
  138447. */
  138448. protected _createTextureAndPostProcesses(): void;
  138449. /**
  138450. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  138451. */
  138452. needStencil(): boolean;
  138453. /**
  138454. * Checks for the readiness of the element composing the layer.
  138455. * @param subMesh the mesh to check for
  138456. * @param useInstances specify wether or not to use instances to render the mesh
  138457. * @param emissiveTexture the associated emissive texture used to generate the glow
  138458. * @return true if ready otherwise, false
  138459. */
  138460. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138461. /**
  138462. * Implementation specific of rendering the generating effect on the main canvas.
  138463. * @param effect The effect used to render through
  138464. */
  138465. protected _internalRender(effect: Effect): void;
  138466. /**
  138467. * Returns true if the layer contains information to display, otherwise false.
  138468. */
  138469. shouldRender(): boolean;
  138470. /**
  138471. * Returns true if the mesh should render, otherwise false.
  138472. * @param mesh The mesh to render
  138473. * @returns true if it should render otherwise false
  138474. */
  138475. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138476. /**
  138477. * Returns true if the mesh can be rendered, otherwise false.
  138478. * @param mesh The mesh to render
  138479. * @param material The material used on the mesh
  138480. * @returns true if it can be rendered otherwise false
  138481. */
  138482. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138483. /**
  138484. * Adds specific effects defines.
  138485. * @param defines The defines to add specifics to.
  138486. */
  138487. protected _addCustomEffectDefines(defines: string[]): void;
  138488. /**
  138489. * Sets the required values for both the emissive texture and and the main color.
  138490. */
  138491. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138492. /**
  138493. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  138494. * @param mesh The mesh to exclude from the highlight layer
  138495. */
  138496. addExcludedMesh(mesh: Mesh): void;
  138497. /**
  138498. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  138499. * @param mesh The mesh to highlight
  138500. */
  138501. removeExcludedMesh(mesh: Mesh): void;
  138502. /**
  138503. * Determine if a given mesh will be highlighted by the current HighlightLayer
  138504. * @param mesh mesh to test
  138505. * @returns true if the mesh will be highlighted by the current HighlightLayer
  138506. */
  138507. hasMesh(mesh: AbstractMesh): boolean;
  138508. /**
  138509. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  138510. * @param mesh The mesh to highlight
  138511. * @param color The color of the highlight
  138512. * @param glowEmissiveOnly Extract the glow from the emissive texture
  138513. */
  138514. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  138515. /**
  138516. * Remove a mesh from the highlight layer in order to make it stop glowing.
  138517. * @param mesh The mesh to highlight
  138518. */
  138519. removeMesh(mesh: Mesh): void;
  138520. /**
  138521. * Remove all the meshes currently referenced in the highlight layer
  138522. */
  138523. removeAllMeshes(): void;
  138524. /**
  138525. * Force the stencil to the normal expected value for none glowing parts
  138526. */
  138527. private _defaultStencilReference;
  138528. /**
  138529. * Free any resources and references associated to a mesh.
  138530. * Internal use
  138531. * @param mesh The mesh to free.
  138532. * @hidden
  138533. */
  138534. _disposeMesh(mesh: Mesh): void;
  138535. /**
  138536. * Dispose the highlight layer and free resources.
  138537. */
  138538. dispose(): void;
  138539. /**
  138540. * Gets the class name of the effect layer
  138541. * @returns the string with the class name of the effect layer
  138542. */
  138543. getClassName(): string;
  138544. /**
  138545. * Serializes this Highlight layer
  138546. * @returns a serialized Highlight layer object
  138547. */
  138548. serialize(): any;
  138549. /**
  138550. * Creates a Highlight layer from parsed Highlight layer data
  138551. * @param parsedHightlightLayer defines the Highlight layer data
  138552. * @param scene defines the current scene
  138553. * @param rootUrl defines the root URL containing the Highlight layer information
  138554. * @returns a parsed Highlight layer
  138555. */
  138556. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  138557. }
  138558. }
  138559. declare module BABYLON {
  138560. interface AbstractScene {
  138561. /**
  138562. * The list of layers (background and foreground) of the scene
  138563. */
  138564. layers: Array<Layer>;
  138565. }
  138566. /**
  138567. * Defines the layer scene component responsible to manage any layers
  138568. * in a given scene.
  138569. */
  138570. export class LayerSceneComponent implements ISceneComponent {
  138571. /**
  138572. * The component name helpfull to identify the component in the list of scene components.
  138573. */
  138574. readonly name: string;
  138575. /**
  138576. * The scene the component belongs to.
  138577. */
  138578. scene: Scene;
  138579. private _engine;
  138580. /**
  138581. * Creates a new instance of the component for the given scene
  138582. * @param scene Defines the scene to register the component in
  138583. */
  138584. constructor(scene: Scene);
  138585. /**
  138586. * Registers the component in a given scene
  138587. */
  138588. register(): void;
  138589. /**
  138590. * Rebuilds the elements related to this component in case of
  138591. * context lost for instance.
  138592. */
  138593. rebuild(): void;
  138594. /**
  138595. * Disposes the component and the associated ressources.
  138596. */
  138597. dispose(): void;
  138598. private _draw;
  138599. private _drawCameraPredicate;
  138600. private _drawCameraBackground;
  138601. private _drawCameraForeground;
  138602. private _drawRenderTargetPredicate;
  138603. private _drawRenderTargetBackground;
  138604. private _drawRenderTargetForeground;
  138605. /**
  138606. * Adds all the elements from the container to the scene
  138607. * @param container the container holding the elements
  138608. */
  138609. addFromContainer(container: AbstractScene): void;
  138610. /**
  138611. * Removes all the elements in the container from the scene
  138612. * @param container contains the elements to remove
  138613. * @param dispose if the removed element should be disposed (default: false)
  138614. */
  138615. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138616. }
  138617. }
  138618. declare module BABYLON {
  138619. /** @hidden */
  138620. export var layerPixelShader: {
  138621. name: string;
  138622. shader: string;
  138623. };
  138624. }
  138625. declare module BABYLON {
  138626. /** @hidden */
  138627. export var layerVertexShader: {
  138628. name: string;
  138629. shader: string;
  138630. };
  138631. }
  138632. declare module BABYLON {
  138633. /**
  138634. * This represents a full screen 2d layer.
  138635. * This can be useful to display a picture in the background of your scene for instance.
  138636. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138637. */
  138638. export class Layer {
  138639. /**
  138640. * Define the name of the layer.
  138641. */
  138642. name: string;
  138643. /**
  138644. * Define the texture the layer should display.
  138645. */
  138646. texture: Nullable<Texture>;
  138647. /**
  138648. * Is the layer in background or foreground.
  138649. */
  138650. isBackground: boolean;
  138651. /**
  138652. * Define the color of the layer (instead of texture).
  138653. */
  138654. color: Color4;
  138655. /**
  138656. * Define the scale of the layer in order to zoom in out of the texture.
  138657. */
  138658. scale: Vector2;
  138659. /**
  138660. * Define an offset for the layer in order to shift the texture.
  138661. */
  138662. offset: Vector2;
  138663. /**
  138664. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  138665. */
  138666. alphaBlendingMode: number;
  138667. /**
  138668. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  138669. * Alpha test will not mix with the background color in case of transparency.
  138670. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  138671. */
  138672. alphaTest: boolean;
  138673. /**
  138674. * Define a mask to restrict the layer to only some of the scene cameras.
  138675. */
  138676. layerMask: number;
  138677. /**
  138678. * Define the list of render target the layer is visible into.
  138679. */
  138680. renderTargetTextures: RenderTargetTexture[];
  138681. /**
  138682. * Define if the layer is only used in renderTarget or if it also
  138683. * renders in the main frame buffer of the canvas.
  138684. */
  138685. renderOnlyInRenderTargetTextures: boolean;
  138686. private _scene;
  138687. private _vertexBuffers;
  138688. private _indexBuffer;
  138689. private _effect;
  138690. private _previousDefines;
  138691. /**
  138692. * An event triggered when the layer is disposed.
  138693. */
  138694. onDisposeObservable: Observable<Layer>;
  138695. private _onDisposeObserver;
  138696. /**
  138697. * Back compatibility with callback before the onDisposeObservable existed.
  138698. * The set callback will be triggered when the layer has been disposed.
  138699. */
  138700. set onDispose(callback: () => void);
  138701. /**
  138702. * An event triggered before rendering the scene
  138703. */
  138704. onBeforeRenderObservable: Observable<Layer>;
  138705. private _onBeforeRenderObserver;
  138706. /**
  138707. * Back compatibility with callback before the onBeforeRenderObservable existed.
  138708. * The set callback will be triggered just before rendering the layer.
  138709. */
  138710. set onBeforeRender(callback: () => void);
  138711. /**
  138712. * An event triggered after rendering the scene
  138713. */
  138714. onAfterRenderObservable: Observable<Layer>;
  138715. private _onAfterRenderObserver;
  138716. /**
  138717. * Back compatibility with callback before the onAfterRenderObservable existed.
  138718. * The set callback will be triggered just after rendering the layer.
  138719. */
  138720. set onAfterRender(callback: () => void);
  138721. /**
  138722. * Instantiates a new layer.
  138723. * This represents a full screen 2d layer.
  138724. * This can be useful to display a picture in the background of your scene for instance.
  138725. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138726. * @param name Define the name of the layer in the scene
  138727. * @param imgUrl Define the url of the texture to display in the layer
  138728. * @param scene Define the scene the layer belongs to
  138729. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  138730. * @param color Defines a color for the layer
  138731. */
  138732. constructor(
  138733. /**
  138734. * Define the name of the layer.
  138735. */
  138736. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  138737. private _createIndexBuffer;
  138738. /** @hidden */
  138739. _rebuild(): void;
  138740. /**
  138741. * Renders the layer in the scene.
  138742. */
  138743. render(): void;
  138744. /**
  138745. * Disposes and releases the associated ressources.
  138746. */
  138747. dispose(): void;
  138748. }
  138749. }
  138750. declare module BABYLON {
  138751. /** @hidden */
  138752. export var lensFlarePixelShader: {
  138753. name: string;
  138754. shader: string;
  138755. };
  138756. }
  138757. declare module BABYLON {
  138758. /** @hidden */
  138759. export var lensFlareVertexShader: {
  138760. name: string;
  138761. shader: string;
  138762. };
  138763. }
  138764. declare module BABYLON {
  138765. /**
  138766. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138767. * It is usually composed of several `lensFlare`.
  138768. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138769. */
  138770. export class LensFlareSystem {
  138771. /**
  138772. * Define the name of the lens flare system
  138773. */
  138774. name: string;
  138775. /**
  138776. * List of lens flares used in this system.
  138777. */
  138778. lensFlares: LensFlare[];
  138779. /**
  138780. * Define a limit from the border the lens flare can be visible.
  138781. */
  138782. borderLimit: number;
  138783. /**
  138784. * Define a viewport border we do not want to see the lens flare in.
  138785. */
  138786. viewportBorder: number;
  138787. /**
  138788. * Define a predicate which could limit the list of meshes able to occlude the effect.
  138789. */
  138790. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  138791. /**
  138792. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  138793. */
  138794. layerMask: number;
  138795. /**
  138796. * Define the id of the lens flare system in the scene.
  138797. * (equal to name by default)
  138798. */
  138799. id: string;
  138800. private _scene;
  138801. private _emitter;
  138802. private _vertexBuffers;
  138803. private _indexBuffer;
  138804. private _effect;
  138805. private _positionX;
  138806. private _positionY;
  138807. private _isEnabled;
  138808. /** @hidden */
  138809. static _SceneComponentInitialization: (scene: Scene) => void;
  138810. /**
  138811. * Instantiates a lens flare system.
  138812. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138813. * It is usually composed of several `lensFlare`.
  138814. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138815. * @param name Define the name of the lens flare system in the scene
  138816. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  138817. * @param scene Define the scene the lens flare system belongs to
  138818. */
  138819. constructor(
  138820. /**
  138821. * Define the name of the lens flare system
  138822. */
  138823. name: string, emitter: any, scene: Scene);
  138824. /**
  138825. * Define if the lens flare system is enabled.
  138826. */
  138827. get isEnabled(): boolean;
  138828. set isEnabled(value: boolean);
  138829. /**
  138830. * Get the scene the effects belongs to.
  138831. * @returns the scene holding the lens flare system
  138832. */
  138833. getScene(): Scene;
  138834. /**
  138835. * Get the emitter of the lens flare system.
  138836. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138837. * @returns the emitter of the lens flare system
  138838. */
  138839. getEmitter(): any;
  138840. /**
  138841. * Set the emitter of the lens flare system.
  138842. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138843. * @param newEmitter Define the new emitter of the system
  138844. */
  138845. setEmitter(newEmitter: any): void;
  138846. /**
  138847. * Get the lens flare system emitter position.
  138848. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  138849. * @returns the position
  138850. */
  138851. getEmitterPosition(): Vector3;
  138852. /**
  138853. * @hidden
  138854. */
  138855. computeEffectivePosition(globalViewport: Viewport): boolean;
  138856. /** @hidden */
  138857. _isVisible(): boolean;
  138858. /**
  138859. * @hidden
  138860. */
  138861. render(): boolean;
  138862. /**
  138863. * Dispose and release the lens flare with its associated resources.
  138864. */
  138865. dispose(): void;
  138866. /**
  138867. * Parse a lens flare system from a JSON repressentation
  138868. * @param parsedLensFlareSystem Define the JSON to parse
  138869. * @param scene Define the scene the parsed system should be instantiated in
  138870. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  138871. * @returns the parsed system
  138872. */
  138873. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  138874. /**
  138875. * Serialize the current Lens Flare System into a JSON representation.
  138876. * @returns the serialized JSON
  138877. */
  138878. serialize(): any;
  138879. }
  138880. }
  138881. declare module BABYLON {
  138882. /**
  138883. * This represents one of the lens effect in a `lensFlareSystem`.
  138884. * It controls one of the indiviual texture used in the effect.
  138885. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138886. */
  138887. export class LensFlare {
  138888. /**
  138889. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138890. */
  138891. size: number;
  138892. /**
  138893. * 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.
  138894. */
  138895. position: number;
  138896. /**
  138897. * Define the lens color.
  138898. */
  138899. color: Color3;
  138900. /**
  138901. * Define the lens texture.
  138902. */
  138903. texture: Nullable<Texture>;
  138904. /**
  138905. * Define the alpha mode to render this particular lens.
  138906. */
  138907. alphaMode: number;
  138908. private _system;
  138909. /**
  138910. * Creates a new Lens Flare.
  138911. * This represents one of the lens effect in a `lensFlareSystem`.
  138912. * It controls one of the indiviual texture used in the effect.
  138913. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138914. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  138915. * @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.
  138916. * @param color Define the lens color
  138917. * @param imgUrl Define the lens texture url
  138918. * @param system Define the `lensFlareSystem` this flare is part of
  138919. * @returns The newly created Lens Flare
  138920. */
  138921. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  138922. /**
  138923. * Instantiates a new Lens Flare.
  138924. * This represents one of the lens effect in a `lensFlareSystem`.
  138925. * It controls one of the indiviual texture used in the effect.
  138926. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138927. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  138928. * @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.
  138929. * @param color Define the lens color
  138930. * @param imgUrl Define the lens texture url
  138931. * @param system Define the `lensFlareSystem` this flare is part of
  138932. */
  138933. constructor(
  138934. /**
  138935. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138936. */
  138937. size: number,
  138938. /**
  138939. * 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.
  138940. */
  138941. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  138942. /**
  138943. * Dispose and release the lens flare with its associated resources.
  138944. */
  138945. dispose(): void;
  138946. }
  138947. }
  138948. declare module BABYLON {
  138949. interface AbstractScene {
  138950. /**
  138951. * The list of lens flare system added to the scene
  138952. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138953. */
  138954. lensFlareSystems: Array<LensFlareSystem>;
  138955. /**
  138956. * Removes the given lens flare system from this scene.
  138957. * @param toRemove The lens flare system to remove
  138958. * @returns The index of the removed lens flare system
  138959. */
  138960. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  138961. /**
  138962. * Adds the given lens flare system to this scene
  138963. * @param newLensFlareSystem The lens flare system to add
  138964. */
  138965. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  138966. /**
  138967. * Gets a lens flare system using its name
  138968. * @param name defines the name to look for
  138969. * @returns the lens flare system or null if not found
  138970. */
  138971. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  138972. /**
  138973. * Gets a lens flare system using its id
  138974. * @param id defines the id to look for
  138975. * @returns the lens flare system or null if not found
  138976. */
  138977. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  138978. }
  138979. /**
  138980. * Defines the lens flare scene component responsible to manage any lens flares
  138981. * in a given scene.
  138982. */
  138983. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  138984. /**
  138985. * The component name helpfull to identify the component in the list of scene components.
  138986. */
  138987. readonly name: string;
  138988. /**
  138989. * The scene the component belongs to.
  138990. */
  138991. scene: Scene;
  138992. /**
  138993. * Creates a new instance of the component for the given scene
  138994. * @param scene Defines the scene to register the component in
  138995. */
  138996. constructor(scene: Scene);
  138997. /**
  138998. * Registers the component in a given scene
  138999. */
  139000. register(): void;
  139001. /**
  139002. * Rebuilds the elements related to this component in case of
  139003. * context lost for instance.
  139004. */
  139005. rebuild(): void;
  139006. /**
  139007. * Adds all the elements from the container to the scene
  139008. * @param container the container holding the elements
  139009. */
  139010. addFromContainer(container: AbstractScene): void;
  139011. /**
  139012. * Removes all the elements in the container from the scene
  139013. * @param container contains the elements to remove
  139014. * @param dispose if the removed element should be disposed (default: false)
  139015. */
  139016. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139017. /**
  139018. * Serializes the component data to the specified json object
  139019. * @param serializationObject The object to serialize to
  139020. */
  139021. serialize(serializationObject: any): void;
  139022. /**
  139023. * Disposes the component and the associated ressources.
  139024. */
  139025. dispose(): void;
  139026. private _draw;
  139027. }
  139028. }
  139029. declare module BABYLON {
  139030. /** @hidden */
  139031. export var depthPixelShader: {
  139032. name: string;
  139033. shader: string;
  139034. };
  139035. }
  139036. declare module BABYLON {
  139037. /** @hidden */
  139038. export var depthVertexShader: {
  139039. name: string;
  139040. shader: string;
  139041. };
  139042. }
  139043. declare module BABYLON {
  139044. /**
  139045. * This represents a depth renderer in Babylon.
  139046. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  139047. */
  139048. export class DepthRenderer {
  139049. private _scene;
  139050. private _depthMap;
  139051. private _effect;
  139052. private readonly _storeNonLinearDepth;
  139053. private readonly _clearColor;
  139054. /** Get if the depth renderer is using packed depth or not */
  139055. readonly isPacked: boolean;
  139056. private _cachedDefines;
  139057. private _camera;
  139058. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  139059. enabled: boolean;
  139060. /**
  139061. * Specifiess that the depth renderer will only be used within
  139062. * the camera it is created for.
  139063. * This can help forcing its rendering during the camera processing.
  139064. */
  139065. useOnlyInActiveCamera: boolean;
  139066. /** @hidden */
  139067. static _SceneComponentInitialization: (scene: Scene) => void;
  139068. /**
  139069. * Instantiates a depth renderer
  139070. * @param scene The scene the renderer belongs to
  139071. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  139072. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  139073. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  139074. */
  139075. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  139076. /**
  139077. * Creates the depth rendering effect and checks if the effect is ready.
  139078. * @param subMesh The submesh to be used to render the depth map of
  139079. * @param useInstances If multiple world instances should be used
  139080. * @returns if the depth renderer is ready to render the depth map
  139081. */
  139082. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  139083. /**
  139084. * Gets the texture which the depth map will be written to.
  139085. * @returns The depth map texture
  139086. */
  139087. getDepthMap(): RenderTargetTexture;
  139088. /**
  139089. * Disposes of the depth renderer.
  139090. */
  139091. dispose(): void;
  139092. }
  139093. }
  139094. declare module BABYLON {
  139095. /** @hidden */
  139096. export var minmaxReduxPixelShader: {
  139097. name: string;
  139098. shader: string;
  139099. };
  139100. }
  139101. declare module BABYLON {
  139102. /**
  139103. * This class computes a min/max reduction from a texture: it means it computes the minimum
  139104. * and maximum values from all values of the texture.
  139105. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  139106. * The source values are read from the red channel of the texture.
  139107. */
  139108. export class MinMaxReducer {
  139109. /**
  139110. * Observable triggered when the computation has been performed
  139111. */
  139112. onAfterReductionPerformed: Observable<{
  139113. min: number;
  139114. max: number;
  139115. }>;
  139116. protected _camera: Camera;
  139117. protected _sourceTexture: Nullable<RenderTargetTexture>;
  139118. protected _reductionSteps: Nullable<Array<PostProcess>>;
  139119. protected _postProcessManager: PostProcessManager;
  139120. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  139121. protected _forceFullscreenViewport: boolean;
  139122. /**
  139123. * Creates a min/max reducer
  139124. * @param camera The camera to use for the post processes
  139125. */
  139126. constructor(camera: Camera);
  139127. /**
  139128. * Gets the texture used to read the values from.
  139129. */
  139130. get sourceTexture(): Nullable<RenderTargetTexture>;
  139131. /**
  139132. * Sets the source texture to read the values from.
  139133. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  139134. * because in such textures '1' value must not be taken into account to compute the maximum
  139135. * as this value is used to clear the texture.
  139136. * Note that the computation is not activated by calling this function, you must call activate() for that!
  139137. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  139138. * @param depthRedux Indicates if the texture is a depth texture or not
  139139. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  139140. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139141. */
  139142. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139143. /**
  139144. * Defines the refresh rate of the computation.
  139145. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139146. */
  139147. get refreshRate(): number;
  139148. set refreshRate(value: number);
  139149. protected _activated: boolean;
  139150. /**
  139151. * Gets the activation status of the reducer
  139152. */
  139153. get activated(): boolean;
  139154. /**
  139155. * Activates the reduction computation.
  139156. * When activated, the observers registered in onAfterReductionPerformed are
  139157. * called after the compuation is performed
  139158. */
  139159. activate(): void;
  139160. /**
  139161. * Deactivates the reduction computation.
  139162. */
  139163. deactivate(): void;
  139164. /**
  139165. * Disposes the min/max reducer
  139166. * @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.
  139167. */
  139168. dispose(disposeAll?: boolean): void;
  139169. }
  139170. }
  139171. declare module BABYLON {
  139172. /**
  139173. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  139174. */
  139175. export class DepthReducer extends MinMaxReducer {
  139176. private _depthRenderer;
  139177. private _depthRendererId;
  139178. /**
  139179. * Gets the depth renderer used for the computation.
  139180. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  139181. */
  139182. get depthRenderer(): Nullable<DepthRenderer>;
  139183. /**
  139184. * Creates a depth reducer
  139185. * @param camera The camera used to render the depth texture
  139186. */
  139187. constructor(camera: Camera);
  139188. /**
  139189. * Sets the depth renderer to use to generate the depth map
  139190. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  139191. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  139192. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139193. */
  139194. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  139195. /** @hidden */
  139196. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139197. /**
  139198. * Activates the reduction computation.
  139199. * When activated, the observers registered in onAfterReductionPerformed are
  139200. * called after the compuation is performed
  139201. */
  139202. activate(): void;
  139203. /**
  139204. * Deactivates the reduction computation.
  139205. */
  139206. deactivate(): void;
  139207. /**
  139208. * Disposes the depth reducer
  139209. * @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.
  139210. */
  139211. dispose(disposeAll?: boolean): void;
  139212. }
  139213. }
  139214. declare module BABYLON {
  139215. /**
  139216. * A CSM implementation allowing casting shadows on large scenes.
  139217. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139218. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  139219. */
  139220. export class CascadedShadowGenerator extends ShadowGenerator {
  139221. private static readonly frustumCornersNDCSpace;
  139222. /**
  139223. * Name of the CSM class
  139224. */
  139225. static CLASSNAME: string;
  139226. /**
  139227. * Defines the default number of cascades used by the CSM.
  139228. */
  139229. static readonly DEFAULT_CASCADES_COUNT: number;
  139230. /**
  139231. * Defines the minimum number of cascades used by the CSM.
  139232. */
  139233. static readonly MIN_CASCADES_COUNT: number;
  139234. /**
  139235. * Defines the maximum number of cascades used by the CSM.
  139236. */
  139237. static readonly MAX_CASCADES_COUNT: number;
  139238. protected _validateFilter(filter: number): number;
  139239. /**
  139240. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  139241. */
  139242. penumbraDarkness: number;
  139243. private _numCascades;
  139244. /**
  139245. * Gets or set the number of cascades used by the CSM.
  139246. */
  139247. get numCascades(): number;
  139248. set numCascades(value: number);
  139249. /**
  139250. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  139251. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  139252. */
  139253. stabilizeCascades: boolean;
  139254. private _freezeShadowCastersBoundingInfo;
  139255. private _freezeShadowCastersBoundingInfoObservable;
  139256. /**
  139257. * Enables or disables the shadow casters bounding info computation.
  139258. * If your shadow casters don't move, you can disable this feature.
  139259. * If it is enabled, the bounding box computation is done every frame.
  139260. */
  139261. get freezeShadowCastersBoundingInfo(): boolean;
  139262. set freezeShadowCastersBoundingInfo(freeze: boolean);
  139263. private _scbiMin;
  139264. private _scbiMax;
  139265. protected _computeShadowCastersBoundingInfo(): void;
  139266. protected _shadowCastersBoundingInfo: BoundingInfo;
  139267. /**
  139268. * Gets or sets the shadow casters bounding info.
  139269. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  139270. * so that the system won't overwrite the bounds you provide
  139271. */
  139272. get shadowCastersBoundingInfo(): BoundingInfo;
  139273. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  139274. protected _breaksAreDirty: boolean;
  139275. protected _minDistance: number;
  139276. protected _maxDistance: number;
  139277. /**
  139278. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  139279. *
  139280. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  139281. * If you don't know these values, simply leave them to their defaults and don't call this function.
  139282. * @param min minimal distance for the breaks (default to 0.)
  139283. * @param max maximal distance for the breaks (default to 1.)
  139284. */
  139285. setMinMaxDistance(min: number, max: number): void;
  139286. /** Gets the minimal distance used in the cascade break computation */
  139287. get minDistance(): number;
  139288. /** Gets the maximal distance used in the cascade break computation */
  139289. get maxDistance(): number;
  139290. /**
  139291. * Gets the class name of that object
  139292. * @returns "CascadedShadowGenerator"
  139293. */
  139294. getClassName(): string;
  139295. private _cascadeMinExtents;
  139296. private _cascadeMaxExtents;
  139297. /**
  139298. * Gets a cascade minimum extents
  139299. * @param cascadeIndex index of the cascade
  139300. * @returns the minimum cascade extents
  139301. */
  139302. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  139303. /**
  139304. * Gets a cascade maximum extents
  139305. * @param cascadeIndex index of the cascade
  139306. * @returns the maximum cascade extents
  139307. */
  139308. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  139309. private _cascades;
  139310. private _currentLayer;
  139311. private _viewSpaceFrustumsZ;
  139312. private _viewMatrices;
  139313. private _projectionMatrices;
  139314. private _transformMatrices;
  139315. private _transformMatricesAsArray;
  139316. private _frustumLengths;
  139317. private _lightSizeUVCorrection;
  139318. private _depthCorrection;
  139319. private _frustumCornersWorldSpace;
  139320. private _frustumCenter;
  139321. private _shadowCameraPos;
  139322. private _shadowMaxZ;
  139323. /**
  139324. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  139325. * It defaults to camera.maxZ
  139326. */
  139327. get shadowMaxZ(): number;
  139328. /**
  139329. * Sets the shadow max z distance.
  139330. */
  139331. set shadowMaxZ(value: number);
  139332. protected _debug: boolean;
  139333. /**
  139334. * Gets or sets the debug flag.
  139335. * When enabled, the cascades are materialized by different colors on the screen.
  139336. */
  139337. get debug(): boolean;
  139338. set debug(dbg: boolean);
  139339. private _depthClamp;
  139340. /**
  139341. * Gets or sets the depth clamping value.
  139342. *
  139343. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  139344. * to account for the shadow casters far away.
  139345. *
  139346. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  139347. */
  139348. get depthClamp(): boolean;
  139349. set depthClamp(value: boolean);
  139350. private _cascadeBlendPercentage;
  139351. /**
  139352. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  139353. * It defaults to 0.1 (10% blending).
  139354. */
  139355. get cascadeBlendPercentage(): number;
  139356. set cascadeBlendPercentage(value: number);
  139357. private _lambda;
  139358. /**
  139359. * Gets or set the lambda parameter.
  139360. * This parameter is used to split the camera frustum and create the cascades.
  139361. * 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.
  139362. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  139363. */
  139364. get lambda(): number;
  139365. set lambda(value: number);
  139366. /**
  139367. * Gets the view matrix corresponding to a given cascade
  139368. * @param cascadeNum cascade to retrieve the view matrix from
  139369. * @returns the cascade view matrix
  139370. */
  139371. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  139372. /**
  139373. * Gets the projection matrix corresponding to a given cascade
  139374. * @param cascadeNum cascade to retrieve the projection matrix from
  139375. * @returns the cascade projection matrix
  139376. */
  139377. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  139378. /**
  139379. * Gets the transformation matrix corresponding to a given cascade
  139380. * @param cascadeNum cascade to retrieve the transformation matrix from
  139381. * @returns the cascade transformation matrix
  139382. */
  139383. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  139384. private _depthRenderer;
  139385. /**
  139386. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  139387. *
  139388. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  139389. *
  139390. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  139391. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  139392. * @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
  139393. */
  139394. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  139395. private _depthReducer;
  139396. private _autoCalcDepthBounds;
  139397. /**
  139398. * Gets or sets the autoCalcDepthBounds property.
  139399. *
  139400. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  139401. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  139402. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  139403. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  139404. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  139405. */
  139406. get autoCalcDepthBounds(): boolean;
  139407. set autoCalcDepthBounds(value: boolean);
  139408. /**
  139409. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  139410. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139411. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  139412. * for setting the refresh rate on the renderer yourself!
  139413. */
  139414. get autoCalcDepthBoundsRefreshRate(): number;
  139415. set autoCalcDepthBoundsRefreshRate(value: number);
  139416. /**
  139417. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  139418. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  139419. * you change the camera near/far planes!
  139420. */
  139421. splitFrustum(): void;
  139422. private _splitFrustum;
  139423. private _computeMatrices;
  139424. private _computeFrustumInWorldSpace;
  139425. private _computeCascadeFrustum;
  139426. /**
  139427. * Support test.
  139428. */
  139429. static get IsSupported(): boolean;
  139430. /** @hidden */
  139431. static _SceneComponentInitialization: (scene: Scene) => void;
  139432. /**
  139433. * Creates a Cascaded Shadow Generator object.
  139434. * A ShadowGenerator is the required tool to use the shadows.
  139435. * Each directional light casting shadows needs to use its own ShadowGenerator.
  139436. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139437. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  139438. * @param light The directional light object generating the shadows.
  139439. * @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.
  139440. */
  139441. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  139442. protected _initializeGenerator(): void;
  139443. protected _createTargetRenderTexture(): void;
  139444. protected _initializeShadowMap(): void;
  139445. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  139446. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  139447. /**
  139448. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  139449. * @param defines Defines of the material we want to update
  139450. * @param lightIndex Index of the light in the enabled light list of the material
  139451. */
  139452. prepareDefines(defines: any, lightIndex: number): void;
  139453. /**
  139454. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  139455. * defined in the generator but impacting the effect).
  139456. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  139457. * @param effect The effect we are binfing the information for
  139458. */
  139459. bindShadowLight(lightIndex: string, effect: Effect): void;
  139460. /**
  139461. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  139462. * (eq to view projection * shadow projection matrices)
  139463. * @returns The transform matrix used to create the shadow map
  139464. */
  139465. getTransformMatrix(): Matrix;
  139466. /**
  139467. * Disposes the ShadowGenerator.
  139468. * Returns nothing.
  139469. */
  139470. dispose(): void;
  139471. /**
  139472. * Serializes the shadow generator setup to a json object.
  139473. * @returns The serialized JSON object
  139474. */
  139475. serialize(): any;
  139476. /**
  139477. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  139478. * @param parsedShadowGenerator The JSON object to parse
  139479. * @param scene The scene to create the shadow map for
  139480. * @returns The parsed shadow generator
  139481. */
  139482. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  139483. }
  139484. }
  139485. declare module BABYLON {
  139486. /**
  139487. * Defines the shadow generator component responsible to manage any shadow generators
  139488. * in a given scene.
  139489. */
  139490. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  139491. /**
  139492. * The component name helpfull to identify the component in the list of scene components.
  139493. */
  139494. readonly name: string;
  139495. /**
  139496. * The scene the component belongs to.
  139497. */
  139498. scene: Scene;
  139499. /**
  139500. * Creates a new instance of the component for the given scene
  139501. * @param scene Defines the scene to register the component in
  139502. */
  139503. constructor(scene: Scene);
  139504. /**
  139505. * Registers the component in a given scene
  139506. */
  139507. register(): void;
  139508. /**
  139509. * Rebuilds the elements related to this component in case of
  139510. * context lost for instance.
  139511. */
  139512. rebuild(): void;
  139513. /**
  139514. * Serializes the component data to the specified json object
  139515. * @param serializationObject The object to serialize to
  139516. */
  139517. serialize(serializationObject: any): void;
  139518. /**
  139519. * Adds all the elements from the container to the scene
  139520. * @param container the container holding the elements
  139521. */
  139522. addFromContainer(container: AbstractScene): void;
  139523. /**
  139524. * Removes all the elements in the container from the scene
  139525. * @param container contains the elements to remove
  139526. * @param dispose if the removed element should be disposed (default: false)
  139527. */
  139528. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139529. /**
  139530. * Rebuilds the elements related to this component in case of
  139531. * context lost for instance.
  139532. */
  139533. dispose(): void;
  139534. private _gatherRenderTargets;
  139535. }
  139536. }
  139537. declare module BABYLON {
  139538. /**
  139539. * A point light is a light defined by an unique point in world space.
  139540. * The light is emitted in every direction from this point.
  139541. * A good example of a point light is a standard light bulb.
  139542. * Documentation: https://doc.babylonjs.com/babylon101/lights
  139543. */
  139544. export class PointLight extends ShadowLight {
  139545. private _shadowAngle;
  139546. /**
  139547. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139548. * This specifies what angle the shadow will use to be created.
  139549. *
  139550. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139551. */
  139552. get shadowAngle(): number;
  139553. /**
  139554. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139555. * This specifies what angle the shadow will use to be created.
  139556. *
  139557. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139558. */
  139559. set shadowAngle(value: number);
  139560. /**
  139561. * Gets the direction if it has been set.
  139562. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139563. */
  139564. get direction(): Vector3;
  139565. /**
  139566. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139567. */
  139568. set direction(value: Vector3);
  139569. /**
  139570. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  139571. * A PointLight emits the light in every direction.
  139572. * It can cast shadows.
  139573. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  139574. * ```javascript
  139575. * var pointLight = new PointLight("pl", camera.position, scene);
  139576. * ```
  139577. * Documentation : https://doc.babylonjs.com/babylon101/lights
  139578. * @param name The light friendly name
  139579. * @param position The position of the point light in the scene
  139580. * @param scene The scene the lights belongs to
  139581. */
  139582. constructor(name: string, position: Vector3, scene: Scene);
  139583. /**
  139584. * Returns the string "PointLight"
  139585. * @returns the class name
  139586. */
  139587. getClassName(): string;
  139588. /**
  139589. * Returns the integer 0.
  139590. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  139591. */
  139592. getTypeID(): number;
  139593. /**
  139594. * Specifies wether or not the shadowmap should be a cube texture.
  139595. * @returns true if the shadowmap needs to be a cube texture.
  139596. */
  139597. needCube(): boolean;
  139598. /**
  139599. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  139600. * @param faceIndex The index of the face we are computed the direction to generate shadow
  139601. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  139602. */
  139603. getShadowDirection(faceIndex?: number): Vector3;
  139604. /**
  139605. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  139606. * - fov = PI / 2
  139607. * - aspect ratio : 1.0
  139608. * - z-near and far equal to the active camera minZ and maxZ.
  139609. * Returns the PointLight.
  139610. */
  139611. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  139612. protected _buildUniformLayout(): void;
  139613. /**
  139614. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  139615. * @param effect The effect to update
  139616. * @param lightIndex The index of the light in the effect to update
  139617. * @returns The point light
  139618. */
  139619. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  139620. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  139621. /**
  139622. * Prepares the list of defines specific to the light type.
  139623. * @param defines the list of defines
  139624. * @param lightIndex defines the index of the light for the effect
  139625. */
  139626. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  139627. }
  139628. }
  139629. declare module BABYLON {
  139630. /**
  139631. * Header information of HDR texture files.
  139632. */
  139633. export interface HDRInfo {
  139634. /**
  139635. * The height of the texture in pixels.
  139636. */
  139637. height: number;
  139638. /**
  139639. * The width of the texture in pixels.
  139640. */
  139641. width: number;
  139642. /**
  139643. * The index of the beginning of the data in the binary file.
  139644. */
  139645. dataPosition: number;
  139646. }
  139647. /**
  139648. * This groups tools to convert HDR texture to native colors array.
  139649. */
  139650. export class HDRTools {
  139651. private static Ldexp;
  139652. private static Rgbe2float;
  139653. private static readStringLine;
  139654. /**
  139655. * Reads header information from an RGBE texture stored in a native array.
  139656. * More information on this format are available here:
  139657. * https://en.wikipedia.org/wiki/RGBE_image_format
  139658. *
  139659. * @param uint8array The binary file stored in native array.
  139660. * @return The header information.
  139661. */
  139662. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  139663. /**
  139664. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  139665. * This RGBE texture needs to store the information as a panorama.
  139666. *
  139667. * More information on this format are available here:
  139668. * https://en.wikipedia.org/wiki/RGBE_image_format
  139669. *
  139670. * @param buffer The binary file stored in an array buffer.
  139671. * @param size The expected size of the extracted cubemap.
  139672. * @return The Cube Map information.
  139673. */
  139674. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  139675. /**
  139676. * Returns the pixels data extracted from an RGBE texture.
  139677. * This pixels will be stored left to right up to down in the R G B order in one array.
  139678. *
  139679. * More information on this format are available here:
  139680. * https://en.wikipedia.org/wiki/RGBE_image_format
  139681. *
  139682. * @param uint8array The binary file stored in an array buffer.
  139683. * @param hdrInfo The header information of the file.
  139684. * @return The pixels data in RGB right to left up to down order.
  139685. */
  139686. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  139687. private static RGBE_ReadPixels_RLE;
  139688. private static RGBE_ReadPixels_NOT_RLE;
  139689. }
  139690. }
  139691. declare module BABYLON {
  139692. /**
  139693. * Effect Render Options
  139694. */
  139695. export interface IEffectRendererOptions {
  139696. /**
  139697. * Defines the vertices positions.
  139698. */
  139699. positions?: number[];
  139700. /**
  139701. * Defines the indices.
  139702. */
  139703. indices?: number[];
  139704. }
  139705. /**
  139706. * Helper class to render one or more effects.
  139707. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  139708. */
  139709. export class EffectRenderer {
  139710. private engine;
  139711. private static _DefaultOptions;
  139712. private _vertexBuffers;
  139713. private _indexBuffer;
  139714. private _fullscreenViewport;
  139715. /**
  139716. * Creates an effect renderer
  139717. * @param engine the engine to use for rendering
  139718. * @param options defines the options of the effect renderer
  139719. */
  139720. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  139721. /**
  139722. * Sets the current viewport in normalized coordinates 0-1
  139723. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  139724. */
  139725. setViewport(viewport?: Viewport): void;
  139726. /**
  139727. * Binds the embedded attributes buffer to the effect.
  139728. * @param effect Defines the effect to bind the attributes for
  139729. */
  139730. bindBuffers(effect: Effect): void;
  139731. /**
  139732. * Sets the current effect wrapper to use during draw.
  139733. * The effect needs to be ready before calling this api.
  139734. * This also sets the default full screen position attribute.
  139735. * @param effectWrapper Defines the effect to draw with
  139736. */
  139737. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  139738. /**
  139739. * Restores engine states
  139740. */
  139741. restoreStates(): void;
  139742. /**
  139743. * Draws a full screen quad.
  139744. */
  139745. draw(): void;
  139746. private isRenderTargetTexture;
  139747. /**
  139748. * renders one or more effects to a specified texture
  139749. * @param effectWrapper the effect to renderer
  139750. * @param outputTexture texture to draw to, if null it will render to the screen.
  139751. */
  139752. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  139753. /**
  139754. * Disposes of the effect renderer
  139755. */
  139756. dispose(): void;
  139757. }
  139758. /**
  139759. * Options to create an EffectWrapper
  139760. */
  139761. interface EffectWrapperCreationOptions {
  139762. /**
  139763. * Engine to use to create the effect
  139764. */
  139765. engine: ThinEngine;
  139766. /**
  139767. * Fragment shader for the effect
  139768. */
  139769. fragmentShader: string;
  139770. /**
  139771. * Use the shader store instead of direct source code
  139772. */
  139773. useShaderStore?: boolean;
  139774. /**
  139775. * Vertex shader for the effect
  139776. */
  139777. vertexShader?: string;
  139778. /**
  139779. * Attributes to use in the shader
  139780. */
  139781. attributeNames?: Array<string>;
  139782. /**
  139783. * Uniforms to use in the shader
  139784. */
  139785. uniformNames?: Array<string>;
  139786. /**
  139787. * Texture sampler names to use in the shader
  139788. */
  139789. samplerNames?: Array<string>;
  139790. /**
  139791. * Defines to use in the shader
  139792. */
  139793. defines?: Array<string>;
  139794. /**
  139795. * Callback when effect is compiled
  139796. */
  139797. onCompiled?: Nullable<(effect: Effect) => void>;
  139798. /**
  139799. * The friendly name of the effect displayed in Spector.
  139800. */
  139801. name?: string;
  139802. }
  139803. /**
  139804. * Wraps an effect to be used for rendering
  139805. */
  139806. export class EffectWrapper {
  139807. /**
  139808. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  139809. */
  139810. onApplyObservable: Observable<{}>;
  139811. /**
  139812. * The underlying effect
  139813. */
  139814. effect: Effect;
  139815. /**
  139816. * Creates an effect to be renderer
  139817. * @param creationOptions options to create the effect
  139818. */
  139819. constructor(creationOptions: EffectWrapperCreationOptions);
  139820. /**
  139821. * Disposes of the effect wrapper
  139822. */
  139823. dispose(): void;
  139824. }
  139825. }
  139826. declare module BABYLON {
  139827. /** @hidden */
  139828. export var hdrFilteringVertexShader: {
  139829. name: string;
  139830. shader: string;
  139831. };
  139832. }
  139833. declare module BABYLON {
  139834. /** @hidden */
  139835. export var hdrFilteringPixelShader: {
  139836. name: string;
  139837. shader: string;
  139838. };
  139839. }
  139840. declare module BABYLON {
  139841. /**
  139842. * Options for texture filtering
  139843. */
  139844. interface IHDRFilteringOptions {
  139845. /**
  139846. * Scales pixel intensity for the input HDR map.
  139847. */
  139848. hdrScale?: number;
  139849. /**
  139850. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  139851. */
  139852. quality?: number;
  139853. }
  139854. /**
  139855. * Filters HDR maps to get correct renderings of PBR reflections
  139856. */
  139857. export class HDRFiltering {
  139858. private _engine;
  139859. private _effectRenderer;
  139860. private _effectWrapper;
  139861. private _lodGenerationOffset;
  139862. private _lodGenerationScale;
  139863. /**
  139864. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  139865. * you care about baking speed.
  139866. */
  139867. quality: number;
  139868. /**
  139869. * Scales pixel intensity for the input HDR map.
  139870. */
  139871. hdrScale: number;
  139872. /**
  139873. * Instantiates HDR filter for reflection maps
  139874. *
  139875. * @param engine Thin engine
  139876. * @param options Options
  139877. */
  139878. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  139879. private _createRenderTarget;
  139880. private _prefilterInternal;
  139881. private _createEffect;
  139882. /**
  139883. * Get a value indicating if the filter is ready to be used
  139884. * @param texture Texture to filter
  139885. * @returns true if the filter is ready
  139886. */
  139887. isReady(texture: BaseTexture): boolean;
  139888. /**
  139889. * Prefilters a cube texture to have mipmap levels representing roughness values.
  139890. * Prefiltering will be invoked at the end of next rendering pass.
  139891. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  139892. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  139893. * @param texture Texture to filter
  139894. * @param onFinished Callback when filtering is done
  139895. * @return Promise called when prefiltering is done
  139896. */
  139897. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  139898. }
  139899. }
  139900. declare module BABYLON {
  139901. /**
  139902. * This represents a texture coming from an HDR input.
  139903. *
  139904. * The only supported format is currently panorama picture stored in RGBE format.
  139905. * Example of such files can be found on HDRLib: http://hdrlib.com/
  139906. */
  139907. export class HDRCubeTexture extends BaseTexture {
  139908. private static _facesMapping;
  139909. private _generateHarmonics;
  139910. private _noMipmap;
  139911. private _prefilterOnLoad;
  139912. private _textureMatrix;
  139913. private _size;
  139914. private _onLoad;
  139915. private _onError;
  139916. /**
  139917. * The texture URL.
  139918. */
  139919. url: string;
  139920. protected _isBlocking: boolean;
  139921. /**
  139922. * Sets wether or not the texture is blocking during loading.
  139923. */
  139924. set isBlocking(value: boolean);
  139925. /**
  139926. * Gets wether or not the texture is blocking during loading.
  139927. */
  139928. get isBlocking(): boolean;
  139929. protected _rotationY: number;
  139930. /**
  139931. * Sets texture matrix rotation angle around Y axis in radians.
  139932. */
  139933. set rotationY(value: number);
  139934. /**
  139935. * Gets texture matrix rotation angle around Y axis radians.
  139936. */
  139937. get rotationY(): number;
  139938. /**
  139939. * Gets or sets the center of the bounding box associated with the cube texture
  139940. * It must define where the camera used to render the texture was set
  139941. */
  139942. boundingBoxPosition: Vector3;
  139943. private _boundingBoxSize;
  139944. /**
  139945. * Gets or sets the size of the bounding box associated with the cube texture
  139946. * When defined, the cubemap will switch to local mode
  139947. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  139948. * @example https://www.babylonjs-playground.com/#RNASML
  139949. */
  139950. set boundingBoxSize(value: Vector3);
  139951. get boundingBoxSize(): Vector3;
  139952. /**
  139953. * Instantiates an HDRTexture from the following parameters.
  139954. *
  139955. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  139956. * @param sceneOrEngine The scene or engine the texture will be used in
  139957. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  139958. * @param noMipmap Forces to not generate the mipmap if true
  139959. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  139960. * @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)
  139961. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  139962. */
  139963. 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>);
  139964. /**
  139965. * Get the current class name of the texture useful for serialization or dynamic coding.
  139966. * @returns "HDRCubeTexture"
  139967. */
  139968. getClassName(): string;
  139969. /**
  139970. * Occurs when the file is raw .hdr file.
  139971. */
  139972. private loadTexture;
  139973. clone(): HDRCubeTexture;
  139974. delayLoad(): void;
  139975. /**
  139976. * Get the texture reflection matrix used to rotate/transform the reflection.
  139977. * @returns the reflection matrix
  139978. */
  139979. getReflectionTextureMatrix(): Matrix;
  139980. /**
  139981. * Set the texture reflection matrix used to rotate/transform the reflection.
  139982. * @param value Define the reflection matrix to set
  139983. */
  139984. setReflectionTextureMatrix(value: Matrix): void;
  139985. /**
  139986. * Parses a JSON representation of an HDR Texture in order to create the texture
  139987. * @param parsedTexture Define the JSON representation
  139988. * @param scene Define the scene the texture should be created in
  139989. * @param rootUrl Define the root url in case we need to load relative dependencies
  139990. * @returns the newly created texture after parsing
  139991. */
  139992. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  139993. serialize(): any;
  139994. }
  139995. }
  139996. declare module BABYLON {
  139997. /**
  139998. * Class used to control physics engine
  139999. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140000. */
  140001. export class PhysicsEngine implements IPhysicsEngine {
  140002. private _physicsPlugin;
  140003. /**
  140004. * Global value used to control the smallest number supported by the simulation
  140005. */
  140006. static Epsilon: number;
  140007. private _impostors;
  140008. private _joints;
  140009. private _subTimeStep;
  140010. /**
  140011. * Gets the gravity vector used by the simulation
  140012. */
  140013. gravity: Vector3;
  140014. /**
  140015. * Factory used to create the default physics plugin.
  140016. * @returns The default physics plugin
  140017. */
  140018. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  140019. /**
  140020. * Creates a new Physics Engine
  140021. * @param gravity defines the gravity vector used by the simulation
  140022. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  140023. */
  140024. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  140025. /**
  140026. * Sets the gravity vector used by the simulation
  140027. * @param gravity defines the gravity vector to use
  140028. */
  140029. setGravity(gravity: Vector3): void;
  140030. /**
  140031. * Set the time step of the physics engine.
  140032. * Default is 1/60.
  140033. * To slow it down, enter 1/600 for example.
  140034. * To speed it up, 1/30
  140035. * @param newTimeStep defines the new timestep to apply to this world.
  140036. */
  140037. setTimeStep(newTimeStep?: number): void;
  140038. /**
  140039. * Get the time step of the physics engine.
  140040. * @returns the current time step
  140041. */
  140042. getTimeStep(): number;
  140043. /**
  140044. * Set the sub time step of the physics engine.
  140045. * Default is 0 meaning there is no sub steps
  140046. * To increase physics resolution precision, set a small value (like 1 ms)
  140047. * @param subTimeStep defines the new sub timestep used for physics resolution.
  140048. */
  140049. setSubTimeStep(subTimeStep?: number): void;
  140050. /**
  140051. * Get the sub time step of the physics engine.
  140052. * @returns the current sub time step
  140053. */
  140054. getSubTimeStep(): number;
  140055. /**
  140056. * Release all resources
  140057. */
  140058. dispose(): void;
  140059. /**
  140060. * Gets the name of the current physics plugin
  140061. * @returns the name of the plugin
  140062. */
  140063. getPhysicsPluginName(): string;
  140064. /**
  140065. * Adding a new impostor for the impostor tracking.
  140066. * This will be done by the impostor itself.
  140067. * @param impostor the impostor to add
  140068. */
  140069. addImpostor(impostor: PhysicsImpostor): void;
  140070. /**
  140071. * Remove an impostor from the engine.
  140072. * This impostor and its mesh will not longer be updated by the physics engine.
  140073. * @param impostor the impostor to remove
  140074. */
  140075. removeImpostor(impostor: PhysicsImpostor): void;
  140076. /**
  140077. * Add a joint to the physics engine
  140078. * @param mainImpostor defines the main impostor to which the joint is added.
  140079. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  140080. * @param joint defines the joint that will connect both impostors.
  140081. */
  140082. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140083. /**
  140084. * Removes a joint from the simulation
  140085. * @param mainImpostor defines the impostor used with the joint
  140086. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  140087. * @param joint defines the joint to remove
  140088. */
  140089. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140090. /**
  140091. * Called by the scene. No need to call it.
  140092. * @param delta defines the timespam between frames
  140093. */
  140094. _step(delta: number): void;
  140095. /**
  140096. * Gets the current plugin used to run the simulation
  140097. * @returns current plugin
  140098. */
  140099. getPhysicsPlugin(): IPhysicsEnginePlugin;
  140100. /**
  140101. * Gets the list of physic impostors
  140102. * @returns an array of PhysicsImpostor
  140103. */
  140104. getImpostors(): Array<PhysicsImpostor>;
  140105. /**
  140106. * Gets the impostor for a physics enabled object
  140107. * @param object defines the object impersonated by the impostor
  140108. * @returns the PhysicsImpostor or null if not found
  140109. */
  140110. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  140111. /**
  140112. * Gets the impostor for a physics body object
  140113. * @param body defines physics body used by the impostor
  140114. * @returns the PhysicsImpostor or null if not found
  140115. */
  140116. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  140117. /**
  140118. * Does a raycast in the physics world
  140119. * @param from when should the ray start?
  140120. * @param to when should the ray end?
  140121. * @returns PhysicsRaycastResult
  140122. */
  140123. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140124. }
  140125. }
  140126. declare module BABYLON {
  140127. /** @hidden */
  140128. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  140129. private _useDeltaForWorldStep;
  140130. world: any;
  140131. name: string;
  140132. private _physicsMaterials;
  140133. private _fixedTimeStep;
  140134. private _cannonRaycastResult;
  140135. private _raycastResult;
  140136. private _physicsBodysToRemoveAfterStep;
  140137. private _firstFrame;
  140138. BJSCANNON: any;
  140139. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  140140. setGravity(gravity: Vector3): void;
  140141. setTimeStep(timeStep: number): void;
  140142. getTimeStep(): number;
  140143. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140144. private _removeMarkedPhysicsBodiesFromWorld;
  140145. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140146. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140147. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140148. private _processChildMeshes;
  140149. removePhysicsBody(impostor: PhysicsImpostor): void;
  140150. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140151. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140152. private _addMaterial;
  140153. private _checkWithEpsilon;
  140154. private _createShape;
  140155. private _createHeightmap;
  140156. private _minus90X;
  140157. private _plus90X;
  140158. private _tmpPosition;
  140159. private _tmpDeltaPosition;
  140160. private _tmpUnityRotation;
  140161. private _updatePhysicsBodyTransformation;
  140162. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140163. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140164. isSupported(): boolean;
  140165. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140166. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140167. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140168. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140169. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140170. getBodyMass(impostor: PhysicsImpostor): number;
  140171. getBodyFriction(impostor: PhysicsImpostor): number;
  140172. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140173. getBodyRestitution(impostor: PhysicsImpostor): number;
  140174. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140175. sleepBody(impostor: PhysicsImpostor): void;
  140176. wakeUpBody(impostor: PhysicsImpostor): void;
  140177. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  140178. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140179. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140180. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140181. getRadius(impostor: PhysicsImpostor): number;
  140182. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140183. dispose(): void;
  140184. private _extendNamespace;
  140185. /**
  140186. * Does a raycast in the physics world
  140187. * @param from when should the ray start?
  140188. * @param to when should the ray end?
  140189. * @returns PhysicsRaycastResult
  140190. */
  140191. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140192. }
  140193. }
  140194. declare module BABYLON {
  140195. /** @hidden */
  140196. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  140197. private _useDeltaForWorldStep;
  140198. world: any;
  140199. name: string;
  140200. BJSOIMO: any;
  140201. private _raycastResult;
  140202. private _fixedTimeStep;
  140203. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  140204. setGravity(gravity: Vector3): void;
  140205. setTimeStep(timeStep: number): void;
  140206. getTimeStep(): number;
  140207. private _tmpImpostorsArray;
  140208. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140209. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140210. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140211. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140212. private _tmpPositionVector;
  140213. removePhysicsBody(impostor: PhysicsImpostor): void;
  140214. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140215. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140216. isSupported(): boolean;
  140217. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140218. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140219. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140220. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140221. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140222. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140223. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140224. getBodyMass(impostor: PhysicsImpostor): number;
  140225. getBodyFriction(impostor: PhysicsImpostor): number;
  140226. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140227. getBodyRestitution(impostor: PhysicsImpostor): number;
  140228. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140229. sleepBody(impostor: PhysicsImpostor): void;
  140230. wakeUpBody(impostor: PhysicsImpostor): void;
  140231. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140232. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  140233. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  140234. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140235. getRadius(impostor: PhysicsImpostor): number;
  140236. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140237. dispose(): void;
  140238. /**
  140239. * Does a raycast in the physics world
  140240. * @param from when should the ray start?
  140241. * @param to when should the ray end?
  140242. * @returns PhysicsRaycastResult
  140243. */
  140244. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140245. }
  140246. }
  140247. declare module BABYLON {
  140248. /**
  140249. * AmmoJS Physics plugin
  140250. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140251. * @see https://github.com/kripken/ammo.js/
  140252. */
  140253. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  140254. private _useDeltaForWorldStep;
  140255. /**
  140256. * Reference to the Ammo library
  140257. */
  140258. bjsAMMO: any;
  140259. /**
  140260. * Created ammoJS world which physics bodies are added to
  140261. */
  140262. world: any;
  140263. /**
  140264. * Name of the plugin
  140265. */
  140266. name: string;
  140267. private _timeStep;
  140268. private _fixedTimeStep;
  140269. private _maxSteps;
  140270. private _tmpQuaternion;
  140271. private _tmpAmmoTransform;
  140272. private _tmpAmmoQuaternion;
  140273. private _tmpAmmoConcreteContactResultCallback;
  140274. private _collisionConfiguration;
  140275. private _dispatcher;
  140276. private _overlappingPairCache;
  140277. private _solver;
  140278. private _softBodySolver;
  140279. private _tmpAmmoVectorA;
  140280. private _tmpAmmoVectorB;
  140281. private _tmpAmmoVectorC;
  140282. private _tmpAmmoVectorD;
  140283. private _tmpContactCallbackResult;
  140284. private _tmpAmmoVectorRCA;
  140285. private _tmpAmmoVectorRCB;
  140286. private _raycastResult;
  140287. private static readonly DISABLE_COLLISION_FLAG;
  140288. private static readonly KINEMATIC_FLAG;
  140289. private static readonly DISABLE_DEACTIVATION_FLAG;
  140290. /**
  140291. * Initializes the ammoJS plugin
  140292. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  140293. * @param ammoInjection can be used to inject your own ammo reference
  140294. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  140295. */
  140296. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  140297. /**
  140298. * Sets the gravity of the physics world (m/(s^2))
  140299. * @param gravity Gravity to set
  140300. */
  140301. setGravity(gravity: Vector3): void;
  140302. /**
  140303. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  140304. * @param timeStep timestep to use in seconds
  140305. */
  140306. setTimeStep(timeStep: number): void;
  140307. /**
  140308. * 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)
  140309. * @param fixedTimeStep fixedTimeStep to use in seconds
  140310. */
  140311. setFixedTimeStep(fixedTimeStep: number): void;
  140312. /**
  140313. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  140314. * @param maxSteps the maximum number of steps by the physics engine per frame
  140315. */
  140316. setMaxSteps(maxSteps: number): void;
  140317. /**
  140318. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  140319. * @returns the current timestep in seconds
  140320. */
  140321. getTimeStep(): number;
  140322. /**
  140323. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  140324. */
  140325. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  140326. private _isImpostorInContact;
  140327. private _isImpostorPairInContact;
  140328. private _stepSimulation;
  140329. /**
  140330. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  140331. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  140332. * After the step the babylon meshes are set to the position of the physics imposters
  140333. * @param delta amount of time to step forward
  140334. * @param impostors array of imposters to update before/after the step
  140335. */
  140336. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140337. /**
  140338. * Update babylon mesh to match physics world object
  140339. * @param impostor imposter to match
  140340. */
  140341. private _afterSoftStep;
  140342. /**
  140343. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140344. * @param impostor imposter to match
  140345. */
  140346. private _ropeStep;
  140347. /**
  140348. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140349. * @param impostor imposter to match
  140350. */
  140351. private _softbodyOrClothStep;
  140352. private _tmpMatrix;
  140353. /**
  140354. * Applies an impulse on the imposter
  140355. * @param impostor imposter to apply impulse to
  140356. * @param force amount of force to be applied to the imposter
  140357. * @param contactPoint the location to apply the impulse on the imposter
  140358. */
  140359. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140360. /**
  140361. * Applies a force on the imposter
  140362. * @param impostor imposter to apply force
  140363. * @param force amount of force to be applied to the imposter
  140364. * @param contactPoint the location to apply the force on the imposter
  140365. */
  140366. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140367. /**
  140368. * Creates a physics body using the plugin
  140369. * @param impostor the imposter to create the physics body on
  140370. */
  140371. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140372. /**
  140373. * Removes the physics body from the imposter and disposes of the body's memory
  140374. * @param impostor imposter to remove the physics body from
  140375. */
  140376. removePhysicsBody(impostor: PhysicsImpostor): void;
  140377. /**
  140378. * Generates a joint
  140379. * @param impostorJoint the imposter joint to create the joint with
  140380. */
  140381. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140382. /**
  140383. * Removes a joint
  140384. * @param impostorJoint the imposter joint to remove the joint from
  140385. */
  140386. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140387. private _addMeshVerts;
  140388. /**
  140389. * Initialise the soft body vertices to match its object's (mesh) vertices
  140390. * Softbody vertices (nodes) are in world space and to match this
  140391. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  140392. * @param impostor to create the softbody for
  140393. */
  140394. private _softVertexData;
  140395. /**
  140396. * Create an impostor's soft body
  140397. * @param impostor to create the softbody for
  140398. */
  140399. private _createSoftbody;
  140400. /**
  140401. * Create cloth for an impostor
  140402. * @param impostor to create the softbody for
  140403. */
  140404. private _createCloth;
  140405. /**
  140406. * Create rope for an impostor
  140407. * @param impostor to create the softbody for
  140408. */
  140409. private _createRope;
  140410. /**
  140411. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  140412. * @param impostor to create the custom physics shape for
  140413. */
  140414. private _createCustom;
  140415. private _addHullVerts;
  140416. private _createShape;
  140417. /**
  140418. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  140419. * @param impostor imposter containing the physics body and babylon object
  140420. */
  140421. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140422. /**
  140423. * Sets the babylon object's position/rotation from the physics body's position/rotation
  140424. * @param impostor imposter containing the physics body and babylon object
  140425. * @param newPosition new position
  140426. * @param newRotation new rotation
  140427. */
  140428. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140429. /**
  140430. * If this plugin is supported
  140431. * @returns true if its supported
  140432. */
  140433. isSupported(): boolean;
  140434. /**
  140435. * Sets the linear velocity of the physics body
  140436. * @param impostor imposter to set the velocity on
  140437. * @param velocity velocity to set
  140438. */
  140439. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140440. /**
  140441. * Sets the angular velocity of the physics body
  140442. * @param impostor imposter to set the velocity on
  140443. * @param velocity velocity to set
  140444. */
  140445. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140446. /**
  140447. * gets the linear velocity
  140448. * @param impostor imposter to get linear velocity from
  140449. * @returns linear velocity
  140450. */
  140451. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140452. /**
  140453. * gets the angular velocity
  140454. * @param impostor imposter to get angular velocity from
  140455. * @returns angular velocity
  140456. */
  140457. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140458. /**
  140459. * Sets the mass of physics body
  140460. * @param impostor imposter to set the mass on
  140461. * @param mass mass to set
  140462. */
  140463. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140464. /**
  140465. * Gets the mass of the physics body
  140466. * @param impostor imposter to get the mass from
  140467. * @returns mass
  140468. */
  140469. getBodyMass(impostor: PhysicsImpostor): number;
  140470. /**
  140471. * Gets friction of the impostor
  140472. * @param impostor impostor to get friction from
  140473. * @returns friction value
  140474. */
  140475. getBodyFriction(impostor: PhysicsImpostor): number;
  140476. /**
  140477. * Sets friction of the impostor
  140478. * @param impostor impostor to set friction on
  140479. * @param friction friction value
  140480. */
  140481. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140482. /**
  140483. * Gets restitution of the impostor
  140484. * @param impostor impostor to get restitution from
  140485. * @returns restitution value
  140486. */
  140487. getBodyRestitution(impostor: PhysicsImpostor): number;
  140488. /**
  140489. * Sets resitution of the impostor
  140490. * @param impostor impostor to set resitution on
  140491. * @param restitution resitution value
  140492. */
  140493. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140494. /**
  140495. * Gets pressure inside the impostor
  140496. * @param impostor impostor to get pressure from
  140497. * @returns pressure value
  140498. */
  140499. getBodyPressure(impostor: PhysicsImpostor): number;
  140500. /**
  140501. * Sets pressure inside a soft body impostor
  140502. * Cloth and rope must remain 0 pressure
  140503. * @param impostor impostor to set pressure on
  140504. * @param pressure pressure value
  140505. */
  140506. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  140507. /**
  140508. * Gets stiffness of the impostor
  140509. * @param impostor impostor to get stiffness from
  140510. * @returns pressure value
  140511. */
  140512. getBodyStiffness(impostor: PhysicsImpostor): number;
  140513. /**
  140514. * Sets stiffness of the impostor
  140515. * @param impostor impostor to set stiffness on
  140516. * @param stiffness stiffness value from 0 to 1
  140517. */
  140518. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  140519. /**
  140520. * Gets velocityIterations of the impostor
  140521. * @param impostor impostor to get velocity iterations from
  140522. * @returns velocityIterations value
  140523. */
  140524. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  140525. /**
  140526. * Sets velocityIterations of the impostor
  140527. * @param impostor impostor to set velocity iterations on
  140528. * @param velocityIterations velocityIterations value
  140529. */
  140530. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  140531. /**
  140532. * Gets positionIterations of the impostor
  140533. * @param impostor impostor to get position iterations from
  140534. * @returns positionIterations value
  140535. */
  140536. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  140537. /**
  140538. * Sets positionIterations of the impostor
  140539. * @param impostor impostor to set position on
  140540. * @param positionIterations positionIterations value
  140541. */
  140542. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  140543. /**
  140544. * Append an anchor to a cloth object
  140545. * @param impostor is the cloth impostor to add anchor to
  140546. * @param otherImpostor is the rigid impostor to anchor to
  140547. * @param width ratio across width from 0 to 1
  140548. * @param height ratio up height from 0 to 1
  140549. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  140550. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140551. */
  140552. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140553. /**
  140554. * Append an hook to a rope object
  140555. * @param impostor is the rope impostor to add hook to
  140556. * @param otherImpostor is the rigid impostor to hook to
  140557. * @param length ratio along the rope from 0 to 1
  140558. * @param influence the elasticity between soft 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. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140562. /**
  140563. * Sleeps the physics body and stops it from being active
  140564. * @param impostor impostor to sleep
  140565. */
  140566. sleepBody(impostor: PhysicsImpostor): void;
  140567. /**
  140568. * Activates the physics body
  140569. * @param impostor impostor to activate
  140570. */
  140571. wakeUpBody(impostor: PhysicsImpostor): void;
  140572. /**
  140573. * Updates the distance parameters of the joint
  140574. * @param joint joint to update
  140575. * @param maxDistance maximum distance of the joint
  140576. * @param minDistance minimum distance of the joint
  140577. */
  140578. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140579. /**
  140580. * Sets a motor on the joint
  140581. * @param joint joint to set motor on
  140582. * @param speed speed of the motor
  140583. * @param maxForce maximum force of the motor
  140584. * @param motorIndex index of the motor
  140585. */
  140586. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140587. /**
  140588. * Sets the motors limit
  140589. * @param joint joint to set limit on
  140590. * @param upperLimit upper limit
  140591. * @param lowerLimit lower limit
  140592. */
  140593. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140594. /**
  140595. * Syncs the position and rotation of a mesh with the impostor
  140596. * @param mesh mesh to sync
  140597. * @param impostor impostor to update the mesh with
  140598. */
  140599. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140600. /**
  140601. * Gets the radius of the impostor
  140602. * @param impostor impostor to get radius from
  140603. * @returns the radius
  140604. */
  140605. getRadius(impostor: PhysicsImpostor): number;
  140606. /**
  140607. * Gets the box size of the impostor
  140608. * @param impostor impostor to get box size from
  140609. * @param result the resulting box size
  140610. */
  140611. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140612. /**
  140613. * Disposes of the impostor
  140614. */
  140615. dispose(): void;
  140616. /**
  140617. * Does a raycast in the physics world
  140618. * @param from when should the ray start?
  140619. * @param to when should the ray end?
  140620. * @returns PhysicsRaycastResult
  140621. */
  140622. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140623. }
  140624. }
  140625. declare module BABYLON {
  140626. interface AbstractScene {
  140627. /**
  140628. * The list of reflection probes added to the scene
  140629. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140630. */
  140631. reflectionProbes: Array<ReflectionProbe>;
  140632. /**
  140633. * Removes the given reflection probe from this scene.
  140634. * @param toRemove The reflection probe to remove
  140635. * @returns The index of the removed reflection probe
  140636. */
  140637. removeReflectionProbe(toRemove: ReflectionProbe): number;
  140638. /**
  140639. * Adds the given reflection probe to this scene.
  140640. * @param newReflectionProbe The reflection probe to add
  140641. */
  140642. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  140643. }
  140644. /**
  140645. * Class used to generate realtime reflection / refraction cube textures
  140646. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140647. */
  140648. export class ReflectionProbe {
  140649. /** defines the name of the probe */
  140650. name: string;
  140651. private _scene;
  140652. private _renderTargetTexture;
  140653. private _projectionMatrix;
  140654. private _viewMatrix;
  140655. private _target;
  140656. private _add;
  140657. private _attachedMesh;
  140658. private _invertYAxis;
  140659. /** Gets or sets probe position (center of the cube map) */
  140660. position: Vector3;
  140661. /**
  140662. * Creates a new reflection probe
  140663. * @param name defines the name of the probe
  140664. * @param size defines the texture resolution (for each face)
  140665. * @param scene defines the hosting scene
  140666. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  140667. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  140668. */
  140669. constructor(
  140670. /** defines the name of the probe */
  140671. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  140672. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  140673. get samples(): number;
  140674. set samples(value: number);
  140675. /** Gets or sets the refresh rate to use (on every frame by default) */
  140676. get refreshRate(): number;
  140677. set refreshRate(value: number);
  140678. /**
  140679. * Gets the hosting scene
  140680. * @returns a Scene
  140681. */
  140682. getScene(): Scene;
  140683. /** Gets the internal CubeTexture used to render to */
  140684. get cubeTexture(): RenderTargetTexture;
  140685. /** Gets the list of meshes to render */
  140686. get renderList(): Nullable<AbstractMesh[]>;
  140687. /**
  140688. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  140689. * @param mesh defines the mesh to attach to
  140690. */
  140691. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  140692. /**
  140693. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  140694. * @param renderingGroupId The rendering group id corresponding to its index
  140695. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  140696. */
  140697. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  140698. /**
  140699. * Clean all associated resources
  140700. */
  140701. dispose(): void;
  140702. /**
  140703. * Converts the reflection probe information to a readable string for debug purpose.
  140704. * @param fullDetails Supports for multiple levels of logging within scene loading
  140705. * @returns the human readable reflection probe info
  140706. */
  140707. toString(fullDetails?: boolean): string;
  140708. /**
  140709. * Get the class name of the relfection probe.
  140710. * @returns "ReflectionProbe"
  140711. */
  140712. getClassName(): string;
  140713. /**
  140714. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  140715. * @returns The JSON representation of the texture
  140716. */
  140717. serialize(): any;
  140718. /**
  140719. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  140720. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  140721. * @param scene Define the scene the parsed reflection probe should be instantiated in
  140722. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  140723. * @returns The parsed reflection probe if successful
  140724. */
  140725. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  140726. }
  140727. }
  140728. declare module BABYLON {
  140729. /** @hidden */
  140730. export var _BabylonLoaderRegistered: boolean;
  140731. /**
  140732. * Helps setting up some configuration for the babylon file loader.
  140733. */
  140734. export class BabylonFileLoaderConfiguration {
  140735. /**
  140736. * The loader does not allow injecting custom physix engine into the plugins.
  140737. * Unfortunately in ES6, we need to manually inject them into the plugin.
  140738. * So you could set this variable to your engine import to make it work.
  140739. */
  140740. static LoaderInjectedPhysicsEngine: any;
  140741. }
  140742. }
  140743. declare module BABYLON {
  140744. /**
  140745. * The Physically based simple base material of BJS.
  140746. *
  140747. * This enables better naming and convention enforcements on top of the pbrMaterial.
  140748. * It is used as the base class for both the specGloss and metalRough conventions.
  140749. */
  140750. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  140751. /**
  140752. * Number of Simultaneous lights allowed on the material.
  140753. */
  140754. maxSimultaneousLights: number;
  140755. /**
  140756. * If sets to true, disables all the lights affecting the material.
  140757. */
  140758. disableLighting: boolean;
  140759. /**
  140760. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  140761. */
  140762. environmentTexture: BaseTexture;
  140763. /**
  140764. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  140765. */
  140766. invertNormalMapX: boolean;
  140767. /**
  140768. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  140769. */
  140770. invertNormalMapY: boolean;
  140771. /**
  140772. * Normal map used in the model.
  140773. */
  140774. normalTexture: BaseTexture;
  140775. /**
  140776. * Emissivie color used to self-illuminate the model.
  140777. */
  140778. emissiveColor: Color3;
  140779. /**
  140780. * Emissivie texture used to self-illuminate the model.
  140781. */
  140782. emissiveTexture: BaseTexture;
  140783. /**
  140784. * Occlusion Channel Strenght.
  140785. */
  140786. occlusionStrength: number;
  140787. /**
  140788. * Occlusion Texture of the material (adding extra occlusion effects).
  140789. */
  140790. occlusionTexture: BaseTexture;
  140791. /**
  140792. * Defines the alpha limits in alpha test mode.
  140793. */
  140794. alphaCutOff: number;
  140795. /**
  140796. * Gets the current double sided mode.
  140797. */
  140798. get doubleSided(): boolean;
  140799. /**
  140800. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  140801. */
  140802. set doubleSided(value: boolean);
  140803. /**
  140804. * Stores the pre-calculated light information of a mesh in a texture.
  140805. */
  140806. lightmapTexture: BaseTexture;
  140807. /**
  140808. * If true, the light map contains occlusion information instead of lighting info.
  140809. */
  140810. useLightmapAsShadowmap: boolean;
  140811. /**
  140812. * Instantiates a new PBRMaterial instance.
  140813. *
  140814. * @param name The material name
  140815. * @param scene The scene the material will be use in.
  140816. */
  140817. constructor(name: string, scene: Scene);
  140818. getClassName(): string;
  140819. }
  140820. }
  140821. declare module BABYLON {
  140822. /**
  140823. * The PBR material of BJS following the metal roughness convention.
  140824. *
  140825. * This fits to the PBR convention in the GLTF definition:
  140826. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  140827. */
  140828. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  140829. /**
  140830. * The base color has two different interpretations depending on the value of metalness.
  140831. * When the material is a metal, the base color is the specific measured reflectance value
  140832. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  140833. * of the material.
  140834. */
  140835. baseColor: Color3;
  140836. /**
  140837. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  140838. * well as opacity information in the alpha channel.
  140839. */
  140840. baseTexture: BaseTexture;
  140841. /**
  140842. * Specifies the metallic scalar value of the material.
  140843. * Can also be used to scale the metalness values of the metallic texture.
  140844. */
  140845. metallic: number;
  140846. /**
  140847. * Specifies the roughness scalar value of the material.
  140848. * Can also be used to scale the roughness values of the metallic texture.
  140849. */
  140850. roughness: number;
  140851. /**
  140852. * Texture containing both the metallic value in the B channel and the
  140853. * roughness value in the G channel to keep better precision.
  140854. */
  140855. metallicRoughnessTexture: BaseTexture;
  140856. /**
  140857. * Instantiates a new PBRMetalRoughnessMaterial instance.
  140858. *
  140859. * @param name The material name
  140860. * @param scene The scene the material will be use in.
  140861. */
  140862. constructor(name: string, scene: Scene);
  140863. /**
  140864. * Return the currrent class name of the material.
  140865. */
  140866. getClassName(): string;
  140867. /**
  140868. * Makes a duplicate of the current material.
  140869. * @param name - name to use for the new material.
  140870. */
  140871. clone(name: string): PBRMetallicRoughnessMaterial;
  140872. /**
  140873. * Serialize the material to a parsable JSON object.
  140874. */
  140875. serialize(): any;
  140876. /**
  140877. * Parses a JSON object correponding to the serialize function.
  140878. */
  140879. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  140880. }
  140881. }
  140882. declare module BABYLON {
  140883. /**
  140884. * The PBR material of BJS following the specular glossiness convention.
  140885. *
  140886. * This fits to the PBR convention in the GLTF definition:
  140887. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  140888. */
  140889. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  140890. /**
  140891. * Specifies the diffuse color of the material.
  140892. */
  140893. diffuseColor: Color3;
  140894. /**
  140895. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  140896. * channel.
  140897. */
  140898. diffuseTexture: BaseTexture;
  140899. /**
  140900. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  140901. */
  140902. specularColor: Color3;
  140903. /**
  140904. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  140905. */
  140906. glossiness: number;
  140907. /**
  140908. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  140909. */
  140910. specularGlossinessTexture: BaseTexture;
  140911. /**
  140912. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  140913. *
  140914. * @param name The material name
  140915. * @param scene The scene the material will be use in.
  140916. */
  140917. constructor(name: string, scene: Scene);
  140918. /**
  140919. * Return the currrent class name of the material.
  140920. */
  140921. getClassName(): string;
  140922. /**
  140923. * Makes a duplicate of the current material.
  140924. * @param name - name to use for the new material.
  140925. */
  140926. clone(name: string): PBRSpecularGlossinessMaterial;
  140927. /**
  140928. * Serialize the material to a parsable JSON object.
  140929. */
  140930. serialize(): any;
  140931. /**
  140932. * Parses a JSON object correponding to the serialize function.
  140933. */
  140934. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  140935. }
  140936. }
  140937. declare module BABYLON {
  140938. /**
  140939. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  140940. * It can help converting any input color in a desired output one. This can then be used to create effects
  140941. * from sepia, black and white to sixties or futuristic rendering...
  140942. *
  140943. * The only supported format is currently 3dl.
  140944. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  140945. */
  140946. export class ColorGradingTexture extends BaseTexture {
  140947. /**
  140948. * The texture URL.
  140949. */
  140950. url: string;
  140951. /**
  140952. * Empty line regex stored for GC.
  140953. */
  140954. private static _noneEmptyLineRegex;
  140955. private _textureMatrix;
  140956. private _onLoad;
  140957. /**
  140958. * Instantiates a ColorGradingTexture from the following parameters.
  140959. *
  140960. * @param url The location of the color gradind data (currently only supporting 3dl)
  140961. * @param sceneOrEngine The scene or engine the texture will be used in
  140962. * @param onLoad defines a callback triggered when the texture has been loaded
  140963. */
  140964. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  140965. /**
  140966. * Fires the onload event from the constructor if requested.
  140967. */
  140968. private _triggerOnLoad;
  140969. /**
  140970. * Returns the texture matrix used in most of the material.
  140971. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  140972. */
  140973. getTextureMatrix(): Matrix;
  140974. /**
  140975. * Occurs when the file being loaded is a .3dl LUT file.
  140976. */
  140977. private load3dlTexture;
  140978. /**
  140979. * Starts the loading process of the texture.
  140980. */
  140981. private loadTexture;
  140982. /**
  140983. * Clones the color gradind texture.
  140984. */
  140985. clone(): ColorGradingTexture;
  140986. /**
  140987. * Called during delayed load for textures.
  140988. */
  140989. delayLoad(): void;
  140990. /**
  140991. * Parses a color grading texture serialized by Babylon.
  140992. * @param parsedTexture The texture information being parsedTexture
  140993. * @param scene The scene to load the texture in
  140994. * @param rootUrl The root url of the data assets to load
  140995. * @return A color gradind texture
  140996. */
  140997. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  140998. /**
  140999. * Serializes the LUT texture to json format.
  141000. */
  141001. serialize(): any;
  141002. }
  141003. }
  141004. declare module BABYLON {
  141005. /**
  141006. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  141007. */
  141008. export class EquiRectangularCubeTexture extends BaseTexture {
  141009. /** The six faces of the cube. */
  141010. private static _FacesMapping;
  141011. private _noMipmap;
  141012. private _onLoad;
  141013. private _onError;
  141014. /** The size of the cubemap. */
  141015. private _size;
  141016. /** The buffer of the image. */
  141017. private _buffer;
  141018. /** The width of the input image. */
  141019. private _width;
  141020. /** The height of the input image. */
  141021. private _height;
  141022. /** The URL to the image. */
  141023. url: string;
  141024. /**
  141025. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  141026. * @param url The location of the image
  141027. * @param scene The scene the texture will be used in
  141028. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  141029. * @param noMipmap Forces to not generate the mipmap if true
  141030. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  141031. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  141032. * @param onLoad — defines a callback called when texture is loaded
  141033. * @param onError — defines a callback called if there is an error
  141034. */
  141035. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  141036. /**
  141037. * Load the image data, by putting the image on a canvas and extracting its buffer.
  141038. */
  141039. private loadImage;
  141040. /**
  141041. * Convert the image buffer into a cubemap and create a CubeTexture.
  141042. */
  141043. private loadTexture;
  141044. /**
  141045. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  141046. * @param buffer The ArrayBuffer that should be converted.
  141047. * @returns The buffer as Float32Array.
  141048. */
  141049. private getFloat32ArrayFromArrayBuffer;
  141050. /**
  141051. * Get the current class name of the texture useful for serialization or dynamic coding.
  141052. * @returns "EquiRectangularCubeTexture"
  141053. */
  141054. getClassName(): string;
  141055. /**
  141056. * Create a clone of the current EquiRectangularCubeTexture and return it.
  141057. * @returns A clone of the current EquiRectangularCubeTexture.
  141058. */
  141059. clone(): EquiRectangularCubeTexture;
  141060. }
  141061. }
  141062. declare module BABYLON {
  141063. /**
  141064. * Defines the options related to the creation of an HtmlElementTexture
  141065. */
  141066. export interface IHtmlElementTextureOptions {
  141067. /**
  141068. * Defines wether mip maps should be created or not.
  141069. */
  141070. generateMipMaps?: boolean;
  141071. /**
  141072. * Defines the sampling mode of the texture.
  141073. */
  141074. samplingMode?: number;
  141075. /**
  141076. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  141077. */
  141078. engine: Nullable<ThinEngine>;
  141079. /**
  141080. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  141081. */
  141082. scene: Nullable<Scene>;
  141083. }
  141084. /**
  141085. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  141086. * To be as efficient as possible depending on your constraints nothing aside the first upload
  141087. * is automatically managed.
  141088. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  141089. * in your application.
  141090. *
  141091. * As the update is not automatic, you need to call them manually.
  141092. */
  141093. export class HtmlElementTexture extends BaseTexture {
  141094. /**
  141095. * The texture URL.
  141096. */
  141097. element: HTMLVideoElement | HTMLCanvasElement;
  141098. private static readonly DefaultOptions;
  141099. private _textureMatrix;
  141100. private _isVideo;
  141101. private _generateMipMaps;
  141102. private _samplingMode;
  141103. /**
  141104. * Instantiates a HtmlElementTexture from the following parameters.
  141105. *
  141106. * @param name Defines the name of the texture
  141107. * @param element Defines the video or canvas the texture is filled with
  141108. * @param options Defines the other none mandatory texture creation options
  141109. */
  141110. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  141111. private _createInternalTexture;
  141112. /**
  141113. * Returns the texture matrix used in most of the material.
  141114. */
  141115. getTextureMatrix(): Matrix;
  141116. /**
  141117. * Updates the content of the texture.
  141118. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  141119. */
  141120. update(invertY?: Nullable<boolean>): void;
  141121. }
  141122. }
  141123. declare module BABYLON {
  141124. /**
  141125. * Based on jsTGALoader - Javascript loader for TGA file
  141126. * By Vincent Thibault
  141127. * @see http://blog.robrowser.com/javascript-tga-loader.html
  141128. */
  141129. export class TGATools {
  141130. private static _TYPE_INDEXED;
  141131. private static _TYPE_RGB;
  141132. private static _TYPE_GREY;
  141133. private static _TYPE_RLE_INDEXED;
  141134. private static _TYPE_RLE_RGB;
  141135. private static _TYPE_RLE_GREY;
  141136. private static _ORIGIN_MASK;
  141137. private static _ORIGIN_SHIFT;
  141138. private static _ORIGIN_BL;
  141139. private static _ORIGIN_BR;
  141140. private static _ORIGIN_UL;
  141141. private static _ORIGIN_UR;
  141142. /**
  141143. * Gets the header of a TGA file
  141144. * @param data defines the TGA data
  141145. * @returns the header
  141146. */
  141147. static GetTGAHeader(data: Uint8Array): any;
  141148. /**
  141149. * Uploads TGA content to a Babylon Texture
  141150. * @hidden
  141151. */
  141152. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  141153. /** @hidden */
  141154. 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;
  141155. /** @hidden */
  141156. 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;
  141157. /** @hidden */
  141158. 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;
  141159. /** @hidden */
  141160. 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;
  141161. /** @hidden */
  141162. 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;
  141163. /** @hidden */
  141164. 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;
  141165. }
  141166. }
  141167. declare module BABYLON {
  141168. /**
  141169. * Implementation of the TGA Texture Loader.
  141170. * @hidden
  141171. */
  141172. export class _TGATextureLoader implements IInternalTextureLoader {
  141173. /**
  141174. * Defines wether the loader supports cascade loading the different faces.
  141175. */
  141176. readonly supportCascades: boolean;
  141177. /**
  141178. * This returns if the loader support the current file information.
  141179. * @param extension defines the file extension of the file being loaded
  141180. * @returns true if the loader can load the specified file
  141181. */
  141182. canLoad(extension: string): boolean;
  141183. /**
  141184. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141185. * @param data contains the texture data
  141186. * @param texture defines the BabylonJS internal texture
  141187. * @param createPolynomials will be true if polynomials have been requested
  141188. * @param onLoad defines the callback to trigger once the texture is ready
  141189. * @param onError defines the callback to trigger in case of error
  141190. */
  141191. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141192. /**
  141193. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141194. * @param data contains the texture data
  141195. * @param texture defines the BabylonJS internal texture
  141196. * @param callback defines the method to call once ready to upload
  141197. */
  141198. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141199. }
  141200. }
  141201. declare module BABYLON {
  141202. /**
  141203. * Info about the .basis files
  141204. */
  141205. class BasisFileInfo {
  141206. /**
  141207. * If the file has alpha
  141208. */
  141209. hasAlpha: boolean;
  141210. /**
  141211. * Info about each image of the basis file
  141212. */
  141213. images: Array<{
  141214. levels: Array<{
  141215. width: number;
  141216. height: number;
  141217. transcodedPixels: ArrayBufferView;
  141218. }>;
  141219. }>;
  141220. }
  141221. /**
  141222. * Result of transcoding a basis file
  141223. */
  141224. class TranscodeResult {
  141225. /**
  141226. * Info about the .basis file
  141227. */
  141228. fileInfo: BasisFileInfo;
  141229. /**
  141230. * Format to use when loading the file
  141231. */
  141232. format: number;
  141233. }
  141234. /**
  141235. * Configuration options for the Basis transcoder
  141236. */
  141237. export class BasisTranscodeConfiguration {
  141238. /**
  141239. * Supported compression formats used to determine the supported output format of the transcoder
  141240. */
  141241. supportedCompressionFormats?: {
  141242. /**
  141243. * etc1 compression format
  141244. */
  141245. etc1?: boolean;
  141246. /**
  141247. * s3tc compression format
  141248. */
  141249. s3tc?: boolean;
  141250. /**
  141251. * pvrtc compression format
  141252. */
  141253. pvrtc?: boolean;
  141254. /**
  141255. * etc2 compression format
  141256. */
  141257. etc2?: boolean;
  141258. };
  141259. /**
  141260. * If mipmap levels should be loaded for transcoded images (Default: true)
  141261. */
  141262. loadMipmapLevels?: boolean;
  141263. /**
  141264. * Index of a single image to load (Default: all images)
  141265. */
  141266. loadSingleImage?: number;
  141267. }
  141268. /**
  141269. * Used to load .Basis files
  141270. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  141271. */
  141272. export class BasisTools {
  141273. private static _IgnoreSupportedFormats;
  141274. /**
  141275. * URL to use when loading the basis transcoder
  141276. */
  141277. static JSModuleURL: string;
  141278. /**
  141279. * URL to use when loading the wasm module for the transcoder
  141280. */
  141281. static WasmModuleURL: string;
  141282. /**
  141283. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  141284. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  141285. * @returns internal format corresponding to the Basis format
  141286. */
  141287. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  141288. private static _WorkerPromise;
  141289. private static _Worker;
  141290. private static _actionId;
  141291. private static _CreateWorkerAsync;
  141292. /**
  141293. * Transcodes a loaded image file to compressed pixel data
  141294. * @param data image data to transcode
  141295. * @param config configuration options for the transcoding
  141296. * @returns a promise resulting in the transcoded image
  141297. */
  141298. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  141299. /**
  141300. * Loads a texture from the transcode result
  141301. * @param texture texture load to
  141302. * @param transcodeResult the result of transcoding the basis file to load from
  141303. */
  141304. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  141305. }
  141306. }
  141307. declare module BABYLON {
  141308. /**
  141309. * Loader for .basis file format
  141310. */
  141311. export class _BasisTextureLoader implements IInternalTextureLoader {
  141312. /**
  141313. * Defines whether the loader supports cascade loading the different faces.
  141314. */
  141315. readonly supportCascades: boolean;
  141316. /**
  141317. * This returns if the loader support the current file information.
  141318. * @param extension defines the file extension of the file being loaded
  141319. * @returns true if the loader can load the specified file
  141320. */
  141321. canLoad(extension: string): boolean;
  141322. /**
  141323. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141324. * @param data contains the texture data
  141325. * @param texture defines the BabylonJS internal texture
  141326. * @param createPolynomials will be true if polynomials have been requested
  141327. * @param onLoad defines the callback to trigger once the texture is ready
  141328. * @param onError defines the callback to trigger in case of error
  141329. */
  141330. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141331. /**
  141332. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141333. * @param data contains the texture data
  141334. * @param texture defines the BabylonJS internal texture
  141335. * @param callback defines the method to call once ready to upload
  141336. */
  141337. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141338. }
  141339. }
  141340. declare module BABYLON {
  141341. /**
  141342. * Defines the basic options interface of a TexturePacker Frame
  141343. */
  141344. export interface ITexturePackerFrame {
  141345. /**
  141346. * The frame ID
  141347. */
  141348. id: number;
  141349. /**
  141350. * The frames Scale
  141351. */
  141352. scale: Vector2;
  141353. /**
  141354. * The Frames offset
  141355. */
  141356. offset: Vector2;
  141357. }
  141358. /**
  141359. * This is a support class for frame Data on texture packer sets.
  141360. */
  141361. export class TexturePackerFrame implements ITexturePackerFrame {
  141362. /**
  141363. * The frame ID
  141364. */
  141365. id: number;
  141366. /**
  141367. * The frames Scale
  141368. */
  141369. scale: Vector2;
  141370. /**
  141371. * The Frames offset
  141372. */
  141373. offset: Vector2;
  141374. /**
  141375. * Initializes a texture package frame.
  141376. * @param id The numerical frame identifier
  141377. * @param scale Scalar Vector2 for UV frame
  141378. * @param offset Vector2 for the frame position in UV units.
  141379. * @returns TexturePackerFrame
  141380. */
  141381. constructor(id: number, scale: Vector2, offset: Vector2);
  141382. }
  141383. }
  141384. declare module BABYLON {
  141385. /**
  141386. * Defines the basic options interface of a TexturePacker
  141387. */
  141388. export interface ITexturePackerOptions {
  141389. /**
  141390. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  141391. */
  141392. map?: string[];
  141393. /**
  141394. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141395. */
  141396. uvsIn?: string;
  141397. /**
  141398. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141399. */
  141400. uvsOut?: string;
  141401. /**
  141402. * number representing the layout style. Defaults to LAYOUT_STRIP
  141403. */
  141404. layout?: number;
  141405. /**
  141406. * number of columns if using custom column count layout(2). This defaults to 4.
  141407. */
  141408. colnum?: number;
  141409. /**
  141410. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  141411. */
  141412. updateInputMeshes?: boolean;
  141413. /**
  141414. * boolean flag to dispose all the source textures. Defaults to true.
  141415. */
  141416. disposeSources?: boolean;
  141417. /**
  141418. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  141419. */
  141420. fillBlanks?: boolean;
  141421. /**
  141422. * string value representing the context fill style color. Defaults to 'black'.
  141423. */
  141424. customFillColor?: string;
  141425. /**
  141426. * Width and Height Value of each Frame in the TexturePacker Sets
  141427. */
  141428. frameSize?: number;
  141429. /**
  141430. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  141431. */
  141432. paddingRatio?: number;
  141433. /**
  141434. * Number that declares the fill method for the padding gutter.
  141435. */
  141436. paddingMode?: number;
  141437. /**
  141438. * If in SUBUV_COLOR padding mode what color to use.
  141439. */
  141440. paddingColor?: Color3 | Color4;
  141441. }
  141442. /**
  141443. * Defines the basic interface of a TexturePacker JSON File
  141444. */
  141445. export interface ITexturePackerJSON {
  141446. /**
  141447. * The frame ID
  141448. */
  141449. name: string;
  141450. /**
  141451. * The base64 channel data
  141452. */
  141453. sets: any;
  141454. /**
  141455. * The options of the Packer
  141456. */
  141457. options: ITexturePackerOptions;
  141458. /**
  141459. * The frame data of the Packer
  141460. */
  141461. frames: Array<number>;
  141462. }
  141463. /**
  141464. * This is a support class that generates a series of packed texture sets.
  141465. * @see https://doc.babylonjs.com/babylon101/materials
  141466. */
  141467. export class TexturePacker {
  141468. /** Packer Layout Constant 0 */
  141469. static readonly LAYOUT_STRIP: number;
  141470. /** Packer Layout Constant 1 */
  141471. static readonly LAYOUT_POWER2: number;
  141472. /** Packer Layout Constant 2 */
  141473. static readonly LAYOUT_COLNUM: number;
  141474. /** Packer Layout Constant 0 */
  141475. static readonly SUBUV_WRAP: number;
  141476. /** Packer Layout Constant 1 */
  141477. static readonly SUBUV_EXTEND: number;
  141478. /** Packer Layout Constant 2 */
  141479. static readonly SUBUV_COLOR: number;
  141480. /** The Name of the Texture Package */
  141481. name: string;
  141482. /** The scene scope of the TexturePacker */
  141483. scene: Scene;
  141484. /** The Meshes to target */
  141485. meshes: AbstractMesh[];
  141486. /** Arguments passed with the Constructor */
  141487. options: ITexturePackerOptions;
  141488. /** The promise that is started upon initialization */
  141489. promise: Nullable<Promise<TexturePacker | string>>;
  141490. /** The Container object for the channel sets that are generated */
  141491. sets: object;
  141492. /** The Container array for the frames that are generated */
  141493. frames: TexturePackerFrame[];
  141494. /** The expected number of textures the system is parsing. */
  141495. private _expecting;
  141496. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  141497. private _paddingValue;
  141498. /**
  141499. * Initializes a texture package series from an array of meshes or a single mesh.
  141500. * @param name The name of the package
  141501. * @param meshes The target meshes to compose the package from
  141502. * @param options The arguments that texture packer should follow while building.
  141503. * @param scene The scene which the textures are scoped to.
  141504. * @returns TexturePacker
  141505. */
  141506. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  141507. /**
  141508. * Starts the package process
  141509. * @param resolve The promises resolution function
  141510. * @returns TexturePacker
  141511. */
  141512. private _createFrames;
  141513. /**
  141514. * Calculates the Size of the Channel Sets
  141515. * @returns Vector2
  141516. */
  141517. private _calculateSize;
  141518. /**
  141519. * Calculates the UV data for the frames.
  141520. * @param baseSize the base frameSize
  141521. * @param padding the base frame padding
  141522. * @param dtSize size of the Dynamic Texture for that channel
  141523. * @param dtUnits is 1/dtSize
  141524. * @param update flag to update the input meshes
  141525. */
  141526. private _calculateMeshUVFrames;
  141527. /**
  141528. * Calculates the frames Offset.
  141529. * @param index of the frame
  141530. * @returns Vector2
  141531. */
  141532. private _getFrameOffset;
  141533. /**
  141534. * Updates a Mesh to the frame data
  141535. * @param mesh that is the target
  141536. * @param frameID or the frame index
  141537. */
  141538. private _updateMeshUV;
  141539. /**
  141540. * Updates a Meshes materials to use the texture packer channels
  141541. * @param m is the mesh to target
  141542. * @param force all channels on the packer to be set.
  141543. */
  141544. private _updateTextureReferences;
  141545. /**
  141546. * Public method to set a Mesh to a frame
  141547. * @param m that is the target
  141548. * @param frameID or the frame index
  141549. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  141550. */
  141551. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  141552. /**
  141553. * Starts the async promise to compile the texture packer.
  141554. * @returns Promise<void>
  141555. */
  141556. processAsync(): Promise<void>;
  141557. /**
  141558. * Disposes all textures associated with this packer
  141559. */
  141560. dispose(): void;
  141561. /**
  141562. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  141563. * @param imageType is the image type to use.
  141564. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  141565. */
  141566. download(imageType?: string, quality?: number): void;
  141567. /**
  141568. * Public method to load a texturePacker JSON file.
  141569. * @param data of the JSON file in string format.
  141570. */
  141571. updateFromJSON(data: string): void;
  141572. }
  141573. }
  141574. declare module BABYLON {
  141575. /**
  141576. * 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.
  141577. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141578. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141579. */
  141580. export class CustomProceduralTexture extends ProceduralTexture {
  141581. private _animate;
  141582. private _time;
  141583. private _config;
  141584. private _texturePath;
  141585. /**
  141586. * Instantiates a new Custom Procedural Texture.
  141587. * 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.
  141588. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141589. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141590. * @param name Define the name of the texture
  141591. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  141592. * @param size Define the size of the texture to create
  141593. * @param scene Define the scene the texture belongs to
  141594. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  141595. * @param generateMipMaps Define if the texture should creates mip maps or not
  141596. */
  141597. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141598. private _loadJson;
  141599. /**
  141600. * Is the texture ready to be used ? (rendered at least once)
  141601. * @returns true if ready, otherwise, false.
  141602. */
  141603. isReady(): boolean;
  141604. /**
  141605. * Render the texture to its associated render target.
  141606. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  141607. */
  141608. render(useCameraPostProcess?: boolean): void;
  141609. /**
  141610. * Update the list of dependant textures samplers in the shader.
  141611. */
  141612. updateTextures(): void;
  141613. /**
  141614. * Update the uniform values of the procedural texture in the shader.
  141615. */
  141616. updateShaderUniforms(): void;
  141617. /**
  141618. * Define if the texture animates or not.
  141619. */
  141620. get animate(): boolean;
  141621. set animate(value: boolean);
  141622. }
  141623. }
  141624. declare module BABYLON {
  141625. /** @hidden */
  141626. export var noisePixelShader: {
  141627. name: string;
  141628. shader: string;
  141629. };
  141630. }
  141631. declare module BABYLON {
  141632. /**
  141633. * Class used to generate noise procedural textures
  141634. */
  141635. export class NoiseProceduralTexture extends ProceduralTexture {
  141636. private _time;
  141637. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  141638. brightness: number;
  141639. /** Defines the number of octaves to process */
  141640. octaves: number;
  141641. /** Defines the level of persistence (0.8 by default) */
  141642. persistence: number;
  141643. /** Gets or sets animation speed factor (default is 1) */
  141644. animationSpeedFactor: number;
  141645. /**
  141646. * Creates a new NoiseProceduralTexture
  141647. * @param name defines the name fo the texture
  141648. * @param size defines the size of the texture (default is 256)
  141649. * @param scene defines the hosting scene
  141650. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  141651. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  141652. */
  141653. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141654. private _updateShaderUniforms;
  141655. protected _getDefines(): string;
  141656. /** Generate the current state of the procedural texture */
  141657. render(useCameraPostProcess?: boolean): void;
  141658. /**
  141659. * Serializes this noise procedural texture
  141660. * @returns a serialized noise procedural texture object
  141661. */
  141662. serialize(): any;
  141663. /**
  141664. * Clone the texture.
  141665. * @returns the cloned texture
  141666. */
  141667. clone(): NoiseProceduralTexture;
  141668. /**
  141669. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  141670. * @param parsedTexture defines parsed texture data
  141671. * @param scene defines the current scene
  141672. * @param rootUrl defines the root URL containing noise procedural texture information
  141673. * @returns a parsed NoiseProceduralTexture
  141674. */
  141675. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  141676. }
  141677. }
  141678. declare module BABYLON {
  141679. /**
  141680. * Raw cube texture where the raw buffers are passed in
  141681. */
  141682. export class RawCubeTexture extends CubeTexture {
  141683. /**
  141684. * Creates a cube texture where the raw buffers are passed in.
  141685. * @param scene defines the scene the texture is attached to
  141686. * @param data defines the array of data to use to create each face
  141687. * @param size defines the size of the textures
  141688. * @param format defines the format of the data
  141689. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  141690. * @param generateMipMaps defines if the engine should generate the mip levels
  141691. * @param invertY defines if data must be stored with Y axis inverted
  141692. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  141693. * @param compression defines the compression used (null by default)
  141694. */
  141695. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  141696. /**
  141697. * Updates the raw cube texture.
  141698. * @param data defines the data to store
  141699. * @param format defines the data format
  141700. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  141701. * @param invertY defines if data must be stored with Y axis inverted
  141702. * @param compression defines the compression used (null by default)
  141703. * @param level defines which level of the texture to update
  141704. */
  141705. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  141706. /**
  141707. * Updates a raw cube texture with RGBD encoded data.
  141708. * @param data defines the array of data [mipmap][face] to use to create each face
  141709. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  141710. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  141711. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  141712. * @returns a promsie that resolves when the operation is complete
  141713. */
  141714. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  141715. /**
  141716. * Clones the raw cube texture.
  141717. * @return a new cube texture
  141718. */
  141719. clone(): CubeTexture;
  141720. /** @hidden */
  141721. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  141722. }
  141723. }
  141724. declare module BABYLON {
  141725. /**
  141726. * Class used to store 2D array textures containing user data
  141727. */
  141728. export class RawTexture2DArray extends Texture {
  141729. /** Gets or sets the texture format to use */
  141730. format: number;
  141731. /**
  141732. * Create a new RawTexture2DArray
  141733. * @param data defines the data of the texture
  141734. * @param width defines the width of the texture
  141735. * @param height defines the height of the texture
  141736. * @param depth defines the number of layers of the texture
  141737. * @param format defines the texture format to use
  141738. * @param scene defines the hosting scene
  141739. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141740. * @param invertY defines if texture must be stored with Y axis inverted
  141741. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141742. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141743. */
  141744. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141745. /** Gets or sets the texture format to use */
  141746. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141747. /**
  141748. * Update the texture with new data
  141749. * @param data defines the data to store in the texture
  141750. */
  141751. update(data: ArrayBufferView): void;
  141752. }
  141753. }
  141754. declare module BABYLON {
  141755. /**
  141756. * Class used to store 3D textures containing user data
  141757. */
  141758. export class RawTexture3D extends Texture {
  141759. /** Gets or sets the texture format to use */
  141760. format: number;
  141761. /**
  141762. * Create a new RawTexture3D
  141763. * @param data defines the data of the texture
  141764. * @param width defines the width of the texture
  141765. * @param height defines the height of the texture
  141766. * @param depth defines the depth of the texture
  141767. * @param format defines the texture format to use
  141768. * @param scene defines the hosting scene
  141769. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141770. * @param invertY defines if texture must be stored with Y axis inverted
  141771. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141772. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141773. */
  141774. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141775. /** Gets or sets the texture format to use */
  141776. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141777. /**
  141778. * Update the texture with new data
  141779. * @param data defines the data to store in the texture
  141780. */
  141781. update(data: ArrayBufferView): void;
  141782. }
  141783. }
  141784. declare module BABYLON {
  141785. /**
  141786. * Creates a refraction texture used by refraction channel of the standard material.
  141787. * It is like a mirror but to see through a material.
  141788. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141789. */
  141790. export class RefractionTexture extends RenderTargetTexture {
  141791. /**
  141792. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  141793. * 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.
  141794. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141795. */
  141796. refractionPlane: Plane;
  141797. /**
  141798. * Define how deep under the surface we should see.
  141799. */
  141800. depth: number;
  141801. /**
  141802. * Creates a refraction texture used by refraction channel of the standard material.
  141803. * It is like a mirror but to see through a material.
  141804. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141805. * @param name Define the texture name
  141806. * @param size Define the size of the underlying texture
  141807. * @param scene Define the scene the refraction belongs to
  141808. * @param generateMipMaps Define if we need to generate mips level for the refraction
  141809. */
  141810. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  141811. /**
  141812. * Clone the refraction texture.
  141813. * @returns the cloned texture
  141814. */
  141815. clone(): RefractionTexture;
  141816. /**
  141817. * Serialize the texture to a JSON representation you could use in Parse later on
  141818. * @returns the serialized JSON representation
  141819. */
  141820. serialize(): any;
  141821. }
  141822. }
  141823. declare module BABYLON {
  141824. /**
  141825. * Block used to add support for vertex skinning (bones)
  141826. */
  141827. export class BonesBlock extends NodeMaterialBlock {
  141828. /**
  141829. * Creates a new BonesBlock
  141830. * @param name defines the block name
  141831. */
  141832. constructor(name: string);
  141833. /**
  141834. * Initialize the block and prepare the context for build
  141835. * @param state defines the state that will be used for the build
  141836. */
  141837. initialize(state: NodeMaterialBuildState): void;
  141838. /**
  141839. * Gets the current class name
  141840. * @returns the class name
  141841. */
  141842. getClassName(): string;
  141843. /**
  141844. * Gets the matrix indices input component
  141845. */
  141846. get matricesIndices(): NodeMaterialConnectionPoint;
  141847. /**
  141848. * Gets the matrix weights input component
  141849. */
  141850. get matricesWeights(): NodeMaterialConnectionPoint;
  141851. /**
  141852. * Gets the extra matrix indices input component
  141853. */
  141854. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  141855. /**
  141856. * Gets the extra matrix weights input component
  141857. */
  141858. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  141859. /**
  141860. * Gets the world input component
  141861. */
  141862. get world(): NodeMaterialConnectionPoint;
  141863. /**
  141864. * Gets the output component
  141865. */
  141866. get output(): NodeMaterialConnectionPoint;
  141867. autoConfigure(material: NodeMaterial): void;
  141868. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  141869. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141870. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141871. protected _buildBlock(state: NodeMaterialBuildState): this;
  141872. }
  141873. }
  141874. declare module BABYLON {
  141875. /**
  141876. * Block used to add support for instances
  141877. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  141878. */
  141879. export class InstancesBlock extends NodeMaterialBlock {
  141880. /**
  141881. * Creates a new InstancesBlock
  141882. * @param name defines the block name
  141883. */
  141884. constructor(name: string);
  141885. /**
  141886. * Gets the current class name
  141887. * @returns the class name
  141888. */
  141889. getClassName(): string;
  141890. /**
  141891. * Gets the first world row input component
  141892. */
  141893. get world0(): NodeMaterialConnectionPoint;
  141894. /**
  141895. * Gets the second world row input component
  141896. */
  141897. get world1(): NodeMaterialConnectionPoint;
  141898. /**
  141899. * Gets the third world row input component
  141900. */
  141901. get world2(): NodeMaterialConnectionPoint;
  141902. /**
  141903. * Gets the forth world row input component
  141904. */
  141905. get world3(): NodeMaterialConnectionPoint;
  141906. /**
  141907. * Gets the world input component
  141908. */
  141909. get world(): NodeMaterialConnectionPoint;
  141910. /**
  141911. * Gets the output component
  141912. */
  141913. get output(): NodeMaterialConnectionPoint;
  141914. /**
  141915. * Gets the isntanceID component
  141916. */
  141917. get instanceID(): NodeMaterialConnectionPoint;
  141918. autoConfigure(material: NodeMaterial): void;
  141919. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  141920. protected _buildBlock(state: NodeMaterialBuildState): this;
  141921. }
  141922. }
  141923. declare module BABYLON {
  141924. /**
  141925. * Block used to add morph targets support to vertex shader
  141926. */
  141927. export class MorphTargetsBlock extends NodeMaterialBlock {
  141928. private _repeatableContentAnchor;
  141929. /**
  141930. * Create a new MorphTargetsBlock
  141931. * @param name defines the block name
  141932. */
  141933. constructor(name: string);
  141934. /**
  141935. * Gets the current class name
  141936. * @returns the class name
  141937. */
  141938. getClassName(): string;
  141939. /**
  141940. * Gets the position input component
  141941. */
  141942. get position(): NodeMaterialConnectionPoint;
  141943. /**
  141944. * Gets the normal input component
  141945. */
  141946. get normal(): NodeMaterialConnectionPoint;
  141947. /**
  141948. * Gets the tangent input component
  141949. */
  141950. get tangent(): NodeMaterialConnectionPoint;
  141951. /**
  141952. * Gets the tangent input component
  141953. */
  141954. get uv(): NodeMaterialConnectionPoint;
  141955. /**
  141956. * Gets the position output component
  141957. */
  141958. get positionOutput(): NodeMaterialConnectionPoint;
  141959. /**
  141960. * Gets the normal output component
  141961. */
  141962. get normalOutput(): NodeMaterialConnectionPoint;
  141963. /**
  141964. * Gets the tangent output component
  141965. */
  141966. get tangentOutput(): NodeMaterialConnectionPoint;
  141967. /**
  141968. * Gets the tangent output component
  141969. */
  141970. get uvOutput(): NodeMaterialConnectionPoint;
  141971. initialize(state: NodeMaterialBuildState): void;
  141972. autoConfigure(material: NodeMaterial): void;
  141973. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141974. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141975. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  141976. protected _buildBlock(state: NodeMaterialBuildState): this;
  141977. }
  141978. }
  141979. declare module BABYLON {
  141980. /**
  141981. * Block used to get data information from a light
  141982. */
  141983. export class LightInformationBlock extends NodeMaterialBlock {
  141984. private _lightDataUniformName;
  141985. private _lightColorUniformName;
  141986. private _lightTypeDefineName;
  141987. /**
  141988. * Gets or sets the light associated with this block
  141989. */
  141990. light: Nullable<Light>;
  141991. /**
  141992. * Creates a new LightInformationBlock
  141993. * @param name defines the block name
  141994. */
  141995. constructor(name: string);
  141996. /**
  141997. * Gets the current class name
  141998. * @returns the class name
  141999. */
  142000. getClassName(): string;
  142001. /**
  142002. * Gets the world position input component
  142003. */
  142004. get worldPosition(): NodeMaterialConnectionPoint;
  142005. /**
  142006. * Gets the direction output component
  142007. */
  142008. get direction(): NodeMaterialConnectionPoint;
  142009. /**
  142010. * Gets the direction output component
  142011. */
  142012. get color(): NodeMaterialConnectionPoint;
  142013. /**
  142014. * Gets the direction output component
  142015. */
  142016. get intensity(): NodeMaterialConnectionPoint;
  142017. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142018. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142019. protected _buildBlock(state: NodeMaterialBuildState): this;
  142020. serialize(): any;
  142021. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142022. }
  142023. }
  142024. declare module BABYLON {
  142025. /**
  142026. * Block used to add image processing support to fragment shader
  142027. */
  142028. export class ImageProcessingBlock extends NodeMaterialBlock {
  142029. /**
  142030. * Create a new ImageProcessingBlock
  142031. * @param name defines the block name
  142032. */
  142033. constructor(name: string);
  142034. /**
  142035. * Gets the current class name
  142036. * @returns the class name
  142037. */
  142038. getClassName(): string;
  142039. /**
  142040. * Gets the color input component
  142041. */
  142042. get color(): NodeMaterialConnectionPoint;
  142043. /**
  142044. * Gets the output component
  142045. */
  142046. get output(): NodeMaterialConnectionPoint;
  142047. /**
  142048. * Initialize the block and prepare the context for build
  142049. * @param state defines the state that will be used for the build
  142050. */
  142051. initialize(state: NodeMaterialBuildState): void;
  142052. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  142053. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142054. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142055. protected _buildBlock(state: NodeMaterialBuildState): this;
  142056. }
  142057. }
  142058. declare module BABYLON {
  142059. /**
  142060. * Block used to pertub normals based on a normal map
  142061. */
  142062. export class PerturbNormalBlock extends NodeMaterialBlock {
  142063. private _tangentSpaceParameterName;
  142064. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  142065. invertX: boolean;
  142066. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  142067. invertY: boolean;
  142068. /**
  142069. * Create a new PerturbNormalBlock
  142070. * @param name defines the block name
  142071. */
  142072. constructor(name: string);
  142073. /**
  142074. * Gets the current class name
  142075. * @returns the class name
  142076. */
  142077. getClassName(): string;
  142078. /**
  142079. * Gets the world position input component
  142080. */
  142081. get worldPosition(): NodeMaterialConnectionPoint;
  142082. /**
  142083. * Gets the world normal input component
  142084. */
  142085. get worldNormal(): NodeMaterialConnectionPoint;
  142086. /**
  142087. * Gets the world tangent input component
  142088. */
  142089. get worldTangent(): NodeMaterialConnectionPoint;
  142090. /**
  142091. * Gets the uv input component
  142092. */
  142093. get uv(): NodeMaterialConnectionPoint;
  142094. /**
  142095. * Gets the normal map color input component
  142096. */
  142097. get normalMapColor(): NodeMaterialConnectionPoint;
  142098. /**
  142099. * Gets the strength input component
  142100. */
  142101. get strength(): NodeMaterialConnectionPoint;
  142102. /**
  142103. * Gets the output component
  142104. */
  142105. get output(): NodeMaterialConnectionPoint;
  142106. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142107. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142108. autoConfigure(material: NodeMaterial): void;
  142109. protected _buildBlock(state: NodeMaterialBuildState): this;
  142110. protected _dumpPropertiesCode(): string;
  142111. serialize(): any;
  142112. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142113. }
  142114. }
  142115. declare module BABYLON {
  142116. /**
  142117. * Block used to discard a pixel if a value is smaller than a cutoff
  142118. */
  142119. export class DiscardBlock extends NodeMaterialBlock {
  142120. /**
  142121. * Create a new DiscardBlock
  142122. * @param name defines the block name
  142123. */
  142124. constructor(name: string);
  142125. /**
  142126. * Gets the current class name
  142127. * @returns the class name
  142128. */
  142129. getClassName(): string;
  142130. /**
  142131. * Gets the color input component
  142132. */
  142133. get value(): NodeMaterialConnectionPoint;
  142134. /**
  142135. * Gets the cutoff input component
  142136. */
  142137. get cutoff(): NodeMaterialConnectionPoint;
  142138. protected _buildBlock(state: NodeMaterialBuildState): this;
  142139. }
  142140. }
  142141. declare module BABYLON {
  142142. /**
  142143. * Block used to test if the fragment shader is front facing
  142144. */
  142145. export class FrontFacingBlock extends NodeMaterialBlock {
  142146. /**
  142147. * Creates a new FrontFacingBlock
  142148. * @param name defines the block name
  142149. */
  142150. constructor(name: string);
  142151. /**
  142152. * Gets the current class name
  142153. * @returns the class name
  142154. */
  142155. getClassName(): string;
  142156. /**
  142157. * Gets the output component
  142158. */
  142159. get output(): NodeMaterialConnectionPoint;
  142160. protected _buildBlock(state: NodeMaterialBuildState): this;
  142161. }
  142162. }
  142163. declare module BABYLON {
  142164. /**
  142165. * Block used to get the derivative value on x and y of a given input
  142166. */
  142167. export class DerivativeBlock extends NodeMaterialBlock {
  142168. /**
  142169. * Create a new DerivativeBlock
  142170. * @param name defines the block name
  142171. */
  142172. constructor(name: string);
  142173. /**
  142174. * Gets the current class name
  142175. * @returns the class name
  142176. */
  142177. getClassName(): string;
  142178. /**
  142179. * Gets the input component
  142180. */
  142181. get input(): NodeMaterialConnectionPoint;
  142182. /**
  142183. * Gets the derivative output on x
  142184. */
  142185. get dx(): NodeMaterialConnectionPoint;
  142186. /**
  142187. * Gets the derivative output on y
  142188. */
  142189. get dy(): NodeMaterialConnectionPoint;
  142190. protected _buildBlock(state: NodeMaterialBuildState): this;
  142191. }
  142192. }
  142193. declare module BABYLON {
  142194. /**
  142195. * Block used to make gl_FragCoord available
  142196. */
  142197. export class FragCoordBlock extends NodeMaterialBlock {
  142198. /**
  142199. * Creates a new FragCoordBlock
  142200. * @param name defines the block name
  142201. */
  142202. constructor(name: string);
  142203. /**
  142204. * Gets the current class name
  142205. * @returns the class name
  142206. */
  142207. getClassName(): string;
  142208. /**
  142209. * Gets the xy component
  142210. */
  142211. get xy(): NodeMaterialConnectionPoint;
  142212. /**
  142213. * Gets the xyz component
  142214. */
  142215. get xyz(): NodeMaterialConnectionPoint;
  142216. /**
  142217. * Gets the xyzw component
  142218. */
  142219. get xyzw(): NodeMaterialConnectionPoint;
  142220. /**
  142221. * Gets the x component
  142222. */
  142223. get x(): NodeMaterialConnectionPoint;
  142224. /**
  142225. * Gets the y component
  142226. */
  142227. get y(): NodeMaterialConnectionPoint;
  142228. /**
  142229. * Gets the z component
  142230. */
  142231. get z(): NodeMaterialConnectionPoint;
  142232. /**
  142233. * Gets the w component
  142234. */
  142235. get output(): NodeMaterialConnectionPoint;
  142236. protected writeOutputs(state: NodeMaterialBuildState): string;
  142237. protected _buildBlock(state: NodeMaterialBuildState): this;
  142238. }
  142239. }
  142240. declare module BABYLON {
  142241. /**
  142242. * Block used to get the screen sizes
  142243. */
  142244. export class ScreenSizeBlock extends NodeMaterialBlock {
  142245. private _varName;
  142246. private _scene;
  142247. /**
  142248. * Creates a new ScreenSizeBlock
  142249. * @param name defines the block name
  142250. */
  142251. constructor(name: string);
  142252. /**
  142253. * Gets the current class name
  142254. * @returns the class name
  142255. */
  142256. getClassName(): string;
  142257. /**
  142258. * Gets the xy component
  142259. */
  142260. get xy(): NodeMaterialConnectionPoint;
  142261. /**
  142262. * Gets the x component
  142263. */
  142264. get x(): NodeMaterialConnectionPoint;
  142265. /**
  142266. * Gets the y component
  142267. */
  142268. get y(): NodeMaterialConnectionPoint;
  142269. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142270. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  142271. protected _buildBlock(state: NodeMaterialBuildState): this;
  142272. }
  142273. }
  142274. declare module BABYLON {
  142275. /**
  142276. * Block used to add support for scene fog
  142277. */
  142278. export class FogBlock extends NodeMaterialBlock {
  142279. private _fogDistanceName;
  142280. private _fogParameters;
  142281. /**
  142282. * Create a new FogBlock
  142283. * @param name defines the block name
  142284. */
  142285. constructor(name: string);
  142286. /**
  142287. * Gets the current class name
  142288. * @returns the class name
  142289. */
  142290. getClassName(): string;
  142291. /**
  142292. * Gets the world position input component
  142293. */
  142294. get worldPosition(): NodeMaterialConnectionPoint;
  142295. /**
  142296. * Gets the view input component
  142297. */
  142298. get view(): NodeMaterialConnectionPoint;
  142299. /**
  142300. * Gets the color input component
  142301. */
  142302. get input(): NodeMaterialConnectionPoint;
  142303. /**
  142304. * Gets the fog color input component
  142305. */
  142306. get fogColor(): NodeMaterialConnectionPoint;
  142307. /**
  142308. * Gets the output component
  142309. */
  142310. get output(): NodeMaterialConnectionPoint;
  142311. autoConfigure(material: NodeMaterial): void;
  142312. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142313. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142314. protected _buildBlock(state: NodeMaterialBuildState): this;
  142315. }
  142316. }
  142317. declare module BABYLON {
  142318. /**
  142319. * Block used to add light in the fragment shader
  142320. */
  142321. export class LightBlock extends NodeMaterialBlock {
  142322. private _lightId;
  142323. /**
  142324. * Gets or sets the light associated with this block
  142325. */
  142326. light: Nullable<Light>;
  142327. /**
  142328. * Create a new LightBlock
  142329. * @param name defines the block name
  142330. */
  142331. constructor(name: string);
  142332. /**
  142333. * Gets the current class name
  142334. * @returns the class name
  142335. */
  142336. getClassName(): string;
  142337. /**
  142338. * Gets the world position input component
  142339. */
  142340. get worldPosition(): NodeMaterialConnectionPoint;
  142341. /**
  142342. * Gets the world normal input component
  142343. */
  142344. get worldNormal(): NodeMaterialConnectionPoint;
  142345. /**
  142346. * Gets the camera (or eye) position component
  142347. */
  142348. get cameraPosition(): NodeMaterialConnectionPoint;
  142349. /**
  142350. * Gets the glossiness component
  142351. */
  142352. get glossiness(): NodeMaterialConnectionPoint;
  142353. /**
  142354. * Gets the glossinness power component
  142355. */
  142356. get glossPower(): NodeMaterialConnectionPoint;
  142357. /**
  142358. * Gets the diffuse color component
  142359. */
  142360. get diffuseColor(): NodeMaterialConnectionPoint;
  142361. /**
  142362. * Gets the specular color component
  142363. */
  142364. get specularColor(): NodeMaterialConnectionPoint;
  142365. /**
  142366. * Gets the diffuse output component
  142367. */
  142368. get diffuseOutput(): NodeMaterialConnectionPoint;
  142369. /**
  142370. * Gets the specular output component
  142371. */
  142372. get specularOutput(): NodeMaterialConnectionPoint;
  142373. /**
  142374. * Gets the shadow output component
  142375. */
  142376. get shadow(): NodeMaterialConnectionPoint;
  142377. autoConfigure(material: NodeMaterial): void;
  142378. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142379. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  142380. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142381. private _injectVertexCode;
  142382. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  142383. serialize(): any;
  142384. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142385. }
  142386. }
  142387. declare module BABYLON {
  142388. /**
  142389. * Block used to read a reflection texture from a sampler
  142390. */
  142391. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  142392. /**
  142393. * Create a new ReflectionTextureBlock
  142394. * @param name defines the block name
  142395. */
  142396. constructor(name: string);
  142397. /**
  142398. * Gets the current class name
  142399. * @returns the class name
  142400. */
  142401. getClassName(): string;
  142402. /**
  142403. * Gets the world position input component
  142404. */
  142405. get position(): NodeMaterialConnectionPoint;
  142406. /**
  142407. * Gets the world position input component
  142408. */
  142409. get worldPosition(): NodeMaterialConnectionPoint;
  142410. /**
  142411. * Gets the world normal input component
  142412. */
  142413. get worldNormal(): NodeMaterialConnectionPoint;
  142414. /**
  142415. * Gets the world input component
  142416. */
  142417. get world(): NodeMaterialConnectionPoint;
  142418. /**
  142419. * Gets the camera (or eye) position component
  142420. */
  142421. get cameraPosition(): NodeMaterialConnectionPoint;
  142422. /**
  142423. * Gets the view input component
  142424. */
  142425. get view(): NodeMaterialConnectionPoint;
  142426. /**
  142427. * Gets the rgb output component
  142428. */
  142429. get rgb(): NodeMaterialConnectionPoint;
  142430. /**
  142431. * Gets the rgba output component
  142432. */
  142433. get rgba(): NodeMaterialConnectionPoint;
  142434. /**
  142435. * Gets the r output component
  142436. */
  142437. get r(): NodeMaterialConnectionPoint;
  142438. /**
  142439. * Gets the g output component
  142440. */
  142441. get g(): NodeMaterialConnectionPoint;
  142442. /**
  142443. * Gets the b output component
  142444. */
  142445. get b(): NodeMaterialConnectionPoint;
  142446. /**
  142447. * Gets the a output component
  142448. */
  142449. get a(): NodeMaterialConnectionPoint;
  142450. autoConfigure(material: NodeMaterial): void;
  142451. protected _buildBlock(state: NodeMaterialBuildState): this;
  142452. }
  142453. }
  142454. declare module BABYLON {
  142455. /**
  142456. * Block used to add 2 vectors
  142457. */
  142458. export class AddBlock extends NodeMaterialBlock {
  142459. /**
  142460. * Creates a new AddBlock
  142461. * @param name defines the block name
  142462. */
  142463. constructor(name: string);
  142464. /**
  142465. * Gets the current class name
  142466. * @returns the class name
  142467. */
  142468. getClassName(): string;
  142469. /**
  142470. * Gets the left operand input component
  142471. */
  142472. get left(): NodeMaterialConnectionPoint;
  142473. /**
  142474. * Gets the right operand input component
  142475. */
  142476. get right(): NodeMaterialConnectionPoint;
  142477. /**
  142478. * Gets the output component
  142479. */
  142480. get output(): NodeMaterialConnectionPoint;
  142481. protected _buildBlock(state: NodeMaterialBuildState): this;
  142482. }
  142483. }
  142484. declare module BABYLON {
  142485. /**
  142486. * Block used to scale a vector by a float
  142487. */
  142488. export class ScaleBlock extends NodeMaterialBlock {
  142489. /**
  142490. * Creates a new ScaleBlock
  142491. * @param name defines the block name
  142492. */
  142493. constructor(name: string);
  142494. /**
  142495. * Gets the current class name
  142496. * @returns the class name
  142497. */
  142498. getClassName(): string;
  142499. /**
  142500. * Gets the input component
  142501. */
  142502. get input(): NodeMaterialConnectionPoint;
  142503. /**
  142504. * Gets the factor input component
  142505. */
  142506. get factor(): NodeMaterialConnectionPoint;
  142507. /**
  142508. * Gets the output component
  142509. */
  142510. get output(): NodeMaterialConnectionPoint;
  142511. protected _buildBlock(state: NodeMaterialBuildState): this;
  142512. }
  142513. }
  142514. declare module BABYLON {
  142515. /**
  142516. * Block used to clamp a float
  142517. */
  142518. export class ClampBlock extends NodeMaterialBlock {
  142519. /** Gets or sets the minimum range */
  142520. minimum: number;
  142521. /** Gets or sets the maximum range */
  142522. maximum: number;
  142523. /**
  142524. * Creates a new ClampBlock
  142525. * @param name defines the block name
  142526. */
  142527. constructor(name: string);
  142528. /**
  142529. * Gets the current class name
  142530. * @returns the class name
  142531. */
  142532. getClassName(): string;
  142533. /**
  142534. * Gets the value input component
  142535. */
  142536. get value(): NodeMaterialConnectionPoint;
  142537. /**
  142538. * Gets the output component
  142539. */
  142540. get output(): NodeMaterialConnectionPoint;
  142541. protected _buildBlock(state: NodeMaterialBuildState): this;
  142542. protected _dumpPropertiesCode(): string;
  142543. serialize(): any;
  142544. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142545. }
  142546. }
  142547. declare module BABYLON {
  142548. /**
  142549. * Block used to apply a cross product between 2 vectors
  142550. */
  142551. export class CrossBlock extends NodeMaterialBlock {
  142552. /**
  142553. * Creates a new CrossBlock
  142554. * @param name defines the block name
  142555. */
  142556. constructor(name: string);
  142557. /**
  142558. * Gets the current class name
  142559. * @returns the class name
  142560. */
  142561. getClassName(): string;
  142562. /**
  142563. * Gets the left operand input component
  142564. */
  142565. get left(): NodeMaterialConnectionPoint;
  142566. /**
  142567. * Gets the right operand input component
  142568. */
  142569. get right(): NodeMaterialConnectionPoint;
  142570. /**
  142571. * Gets the output component
  142572. */
  142573. get output(): NodeMaterialConnectionPoint;
  142574. protected _buildBlock(state: NodeMaterialBuildState): this;
  142575. }
  142576. }
  142577. declare module BABYLON {
  142578. /**
  142579. * Block used to apply a dot product between 2 vectors
  142580. */
  142581. export class DotBlock extends NodeMaterialBlock {
  142582. /**
  142583. * Creates a new DotBlock
  142584. * @param name defines the block name
  142585. */
  142586. constructor(name: string);
  142587. /**
  142588. * Gets the current class name
  142589. * @returns the class name
  142590. */
  142591. getClassName(): string;
  142592. /**
  142593. * Gets the left operand input component
  142594. */
  142595. get left(): NodeMaterialConnectionPoint;
  142596. /**
  142597. * Gets the right operand input component
  142598. */
  142599. get right(): NodeMaterialConnectionPoint;
  142600. /**
  142601. * Gets the output component
  142602. */
  142603. get output(): NodeMaterialConnectionPoint;
  142604. protected _buildBlock(state: NodeMaterialBuildState): this;
  142605. }
  142606. }
  142607. declare module BABYLON {
  142608. /**
  142609. * Block used to normalize a vector
  142610. */
  142611. export class NormalizeBlock extends NodeMaterialBlock {
  142612. /**
  142613. * Creates a new NormalizeBlock
  142614. * @param name defines the block name
  142615. */
  142616. constructor(name: string);
  142617. /**
  142618. * Gets the current class name
  142619. * @returns the class name
  142620. */
  142621. getClassName(): string;
  142622. /**
  142623. * Gets the input component
  142624. */
  142625. get input(): NodeMaterialConnectionPoint;
  142626. /**
  142627. * Gets the output component
  142628. */
  142629. get output(): NodeMaterialConnectionPoint;
  142630. protected _buildBlock(state: NodeMaterialBuildState): this;
  142631. }
  142632. }
  142633. declare module BABYLON {
  142634. /**
  142635. * Operations supported by the Trigonometry block
  142636. */
  142637. export enum TrigonometryBlockOperations {
  142638. /** Cos */
  142639. Cos = 0,
  142640. /** Sin */
  142641. Sin = 1,
  142642. /** Abs */
  142643. Abs = 2,
  142644. /** Exp */
  142645. Exp = 3,
  142646. /** Exp2 */
  142647. Exp2 = 4,
  142648. /** Round */
  142649. Round = 5,
  142650. /** Floor */
  142651. Floor = 6,
  142652. /** Ceiling */
  142653. Ceiling = 7,
  142654. /** Square root */
  142655. Sqrt = 8,
  142656. /** Log */
  142657. Log = 9,
  142658. /** Tangent */
  142659. Tan = 10,
  142660. /** Arc tangent */
  142661. ArcTan = 11,
  142662. /** Arc cosinus */
  142663. ArcCos = 12,
  142664. /** Arc sinus */
  142665. ArcSin = 13,
  142666. /** Fraction */
  142667. Fract = 14,
  142668. /** Sign */
  142669. Sign = 15,
  142670. /** To radians (from degrees) */
  142671. Radians = 16,
  142672. /** To degrees (from radians) */
  142673. Degrees = 17
  142674. }
  142675. /**
  142676. * Block used to apply trigonometry operation to floats
  142677. */
  142678. export class TrigonometryBlock extends NodeMaterialBlock {
  142679. /**
  142680. * Gets or sets the operation applied by the block
  142681. */
  142682. operation: TrigonometryBlockOperations;
  142683. /**
  142684. * Creates a new TrigonometryBlock
  142685. * @param name defines the block name
  142686. */
  142687. constructor(name: string);
  142688. /**
  142689. * Gets the current class name
  142690. * @returns the class name
  142691. */
  142692. getClassName(): string;
  142693. /**
  142694. * Gets the input component
  142695. */
  142696. get input(): NodeMaterialConnectionPoint;
  142697. /**
  142698. * Gets the output component
  142699. */
  142700. get output(): NodeMaterialConnectionPoint;
  142701. protected _buildBlock(state: NodeMaterialBuildState): this;
  142702. serialize(): any;
  142703. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142704. protected _dumpPropertiesCode(): string;
  142705. }
  142706. }
  142707. declare module BABYLON {
  142708. /**
  142709. * Block used to create a Color3/4 out of individual inputs (one for each component)
  142710. */
  142711. export class ColorMergerBlock extends NodeMaterialBlock {
  142712. /**
  142713. * Create a new ColorMergerBlock
  142714. * @param name defines the block name
  142715. */
  142716. constructor(name: string);
  142717. /**
  142718. * Gets the current class name
  142719. * @returns the class name
  142720. */
  142721. getClassName(): string;
  142722. /**
  142723. * Gets the rgb component (input)
  142724. */
  142725. get rgbIn(): NodeMaterialConnectionPoint;
  142726. /**
  142727. * Gets the r component (input)
  142728. */
  142729. get r(): NodeMaterialConnectionPoint;
  142730. /**
  142731. * Gets the g component (input)
  142732. */
  142733. get g(): NodeMaterialConnectionPoint;
  142734. /**
  142735. * Gets the b component (input)
  142736. */
  142737. get b(): NodeMaterialConnectionPoint;
  142738. /**
  142739. * Gets the a component (input)
  142740. */
  142741. get a(): NodeMaterialConnectionPoint;
  142742. /**
  142743. * Gets the rgba component (output)
  142744. */
  142745. get rgba(): NodeMaterialConnectionPoint;
  142746. /**
  142747. * Gets the rgb component (output)
  142748. */
  142749. get rgbOut(): NodeMaterialConnectionPoint;
  142750. /**
  142751. * Gets the rgb component (output)
  142752. * @deprecated Please use rgbOut instead.
  142753. */
  142754. get rgb(): NodeMaterialConnectionPoint;
  142755. protected _buildBlock(state: NodeMaterialBuildState): this;
  142756. }
  142757. }
  142758. declare module BABYLON {
  142759. /**
  142760. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  142761. */
  142762. export class VectorSplitterBlock extends NodeMaterialBlock {
  142763. /**
  142764. * Create a new VectorSplitterBlock
  142765. * @param name defines the block name
  142766. */
  142767. constructor(name: string);
  142768. /**
  142769. * Gets the current class name
  142770. * @returns the class name
  142771. */
  142772. getClassName(): string;
  142773. /**
  142774. * Gets the xyzw component (input)
  142775. */
  142776. get xyzw(): NodeMaterialConnectionPoint;
  142777. /**
  142778. * Gets the xyz component (input)
  142779. */
  142780. get xyzIn(): NodeMaterialConnectionPoint;
  142781. /**
  142782. * Gets the xy component (input)
  142783. */
  142784. get xyIn(): NodeMaterialConnectionPoint;
  142785. /**
  142786. * Gets the xyz component (output)
  142787. */
  142788. get xyzOut(): NodeMaterialConnectionPoint;
  142789. /**
  142790. * Gets the xy component (output)
  142791. */
  142792. get xyOut(): NodeMaterialConnectionPoint;
  142793. /**
  142794. * Gets the x component (output)
  142795. */
  142796. get x(): NodeMaterialConnectionPoint;
  142797. /**
  142798. * Gets the y component (output)
  142799. */
  142800. get y(): NodeMaterialConnectionPoint;
  142801. /**
  142802. * Gets the z component (output)
  142803. */
  142804. get z(): NodeMaterialConnectionPoint;
  142805. /**
  142806. * Gets the w component (output)
  142807. */
  142808. get w(): NodeMaterialConnectionPoint;
  142809. protected _inputRename(name: string): string;
  142810. protected _outputRename(name: string): string;
  142811. protected _buildBlock(state: NodeMaterialBuildState): this;
  142812. }
  142813. }
  142814. declare module BABYLON {
  142815. /**
  142816. * Block used to lerp between 2 values
  142817. */
  142818. export class LerpBlock extends NodeMaterialBlock {
  142819. /**
  142820. * Creates a new LerpBlock
  142821. * @param name defines the block name
  142822. */
  142823. constructor(name: string);
  142824. /**
  142825. * Gets the current class name
  142826. * @returns the class name
  142827. */
  142828. getClassName(): string;
  142829. /**
  142830. * Gets the left operand input component
  142831. */
  142832. get left(): NodeMaterialConnectionPoint;
  142833. /**
  142834. * Gets the right operand input component
  142835. */
  142836. get right(): NodeMaterialConnectionPoint;
  142837. /**
  142838. * Gets the gradient operand input component
  142839. */
  142840. get gradient(): NodeMaterialConnectionPoint;
  142841. /**
  142842. * Gets the output component
  142843. */
  142844. get output(): NodeMaterialConnectionPoint;
  142845. protected _buildBlock(state: NodeMaterialBuildState): this;
  142846. }
  142847. }
  142848. declare module BABYLON {
  142849. /**
  142850. * Block used to divide 2 vectors
  142851. */
  142852. export class DivideBlock extends NodeMaterialBlock {
  142853. /**
  142854. * Creates a new DivideBlock
  142855. * @param name defines the block name
  142856. */
  142857. constructor(name: string);
  142858. /**
  142859. * Gets the current class name
  142860. * @returns the class name
  142861. */
  142862. getClassName(): string;
  142863. /**
  142864. * Gets the left operand input component
  142865. */
  142866. get left(): NodeMaterialConnectionPoint;
  142867. /**
  142868. * Gets the right operand input component
  142869. */
  142870. get right(): NodeMaterialConnectionPoint;
  142871. /**
  142872. * Gets the output component
  142873. */
  142874. get output(): NodeMaterialConnectionPoint;
  142875. protected _buildBlock(state: NodeMaterialBuildState): this;
  142876. }
  142877. }
  142878. declare module BABYLON {
  142879. /**
  142880. * Block used to subtract 2 vectors
  142881. */
  142882. export class SubtractBlock extends NodeMaterialBlock {
  142883. /**
  142884. * Creates a new SubtractBlock
  142885. * @param name defines the block name
  142886. */
  142887. constructor(name: string);
  142888. /**
  142889. * Gets the current class name
  142890. * @returns the class name
  142891. */
  142892. getClassName(): string;
  142893. /**
  142894. * Gets the left operand input component
  142895. */
  142896. get left(): NodeMaterialConnectionPoint;
  142897. /**
  142898. * Gets the right operand input component
  142899. */
  142900. get right(): NodeMaterialConnectionPoint;
  142901. /**
  142902. * Gets the output component
  142903. */
  142904. get output(): NodeMaterialConnectionPoint;
  142905. protected _buildBlock(state: NodeMaterialBuildState): this;
  142906. }
  142907. }
  142908. declare module BABYLON {
  142909. /**
  142910. * Block used to step a value
  142911. */
  142912. export class StepBlock extends NodeMaterialBlock {
  142913. /**
  142914. * Creates a new StepBlock
  142915. * @param name defines the block name
  142916. */
  142917. constructor(name: string);
  142918. /**
  142919. * Gets the current class name
  142920. * @returns the class name
  142921. */
  142922. getClassName(): string;
  142923. /**
  142924. * Gets the value operand input component
  142925. */
  142926. get value(): NodeMaterialConnectionPoint;
  142927. /**
  142928. * Gets the edge operand input component
  142929. */
  142930. get edge(): NodeMaterialConnectionPoint;
  142931. /**
  142932. * Gets the output component
  142933. */
  142934. get output(): NodeMaterialConnectionPoint;
  142935. protected _buildBlock(state: NodeMaterialBuildState): this;
  142936. }
  142937. }
  142938. declare module BABYLON {
  142939. /**
  142940. * Block used to get the opposite (1 - x) of a value
  142941. */
  142942. export class OneMinusBlock extends NodeMaterialBlock {
  142943. /**
  142944. * Creates a new OneMinusBlock
  142945. * @param name defines the block name
  142946. */
  142947. constructor(name: string);
  142948. /**
  142949. * Gets the current class name
  142950. * @returns the class name
  142951. */
  142952. getClassName(): string;
  142953. /**
  142954. * Gets the input component
  142955. */
  142956. get input(): NodeMaterialConnectionPoint;
  142957. /**
  142958. * Gets the output component
  142959. */
  142960. get output(): NodeMaterialConnectionPoint;
  142961. protected _buildBlock(state: NodeMaterialBuildState): this;
  142962. }
  142963. }
  142964. declare module BABYLON {
  142965. /**
  142966. * Block used to get the view direction
  142967. */
  142968. export class ViewDirectionBlock extends NodeMaterialBlock {
  142969. /**
  142970. * Creates a new ViewDirectionBlock
  142971. * @param name defines the block name
  142972. */
  142973. constructor(name: string);
  142974. /**
  142975. * Gets the current class name
  142976. * @returns the class name
  142977. */
  142978. getClassName(): string;
  142979. /**
  142980. * Gets the world position component
  142981. */
  142982. get worldPosition(): NodeMaterialConnectionPoint;
  142983. /**
  142984. * Gets the camera position component
  142985. */
  142986. get cameraPosition(): NodeMaterialConnectionPoint;
  142987. /**
  142988. * Gets the output component
  142989. */
  142990. get output(): NodeMaterialConnectionPoint;
  142991. autoConfigure(material: NodeMaterial): void;
  142992. protected _buildBlock(state: NodeMaterialBuildState): this;
  142993. }
  142994. }
  142995. declare module BABYLON {
  142996. /**
  142997. * Block used to compute fresnel value
  142998. */
  142999. export class FresnelBlock extends NodeMaterialBlock {
  143000. /**
  143001. * Create a new FresnelBlock
  143002. * @param name defines the block name
  143003. */
  143004. constructor(name: string);
  143005. /**
  143006. * Gets the current class name
  143007. * @returns the class name
  143008. */
  143009. getClassName(): string;
  143010. /**
  143011. * Gets the world normal input component
  143012. */
  143013. get worldNormal(): NodeMaterialConnectionPoint;
  143014. /**
  143015. * Gets the view direction input component
  143016. */
  143017. get viewDirection(): NodeMaterialConnectionPoint;
  143018. /**
  143019. * Gets the bias input component
  143020. */
  143021. get bias(): NodeMaterialConnectionPoint;
  143022. /**
  143023. * Gets the camera (or eye) position component
  143024. */
  143025. get power(): NodeMaterialConnectionPoint;
  143026. /**
  143027. * Gets the fresnel output component
  143028. */
  143029. get fresnel(): NodeMaterialConnectionPoint;
  143030. autoConfigure(material: NodeMaterial): void;
  143031. protected _buildBlock(state: NodeMaterialBuildState): this;
  143032. }
  143033. }
  143034. declare module BABYLON {
  143035. /**
  143036. * Block used to get the max of 2 values
  143037. */
  143038. export class MaxBlock extends NodeMaterialBlock {
  143039. /**
  143040. * Creates a new MaxBlock
  143041. * @param name defines the block name
  143042. */
  143043. constructor(name: string);
  143044. /**
  143045. * Gets the current class name
  143046. * @returns the class name
  143047. */
  143048. getClassName(): string;
  143049. /**
  143050. * Gets the left operand input component
  143051. */
  143052. get left(): NodeMaterialConnectionPoint;
  143053. /**
  143054. * Gets the right operand input component
  143055. */
  143056. get right(): NodeMaterialConnectionPoint;
  143057. /**
  143058. * Gets the output component
  143059. */
  143060. get output(): NodeMaterialConnectionPoint;
  143061. protected _buildBlock(state: NodeMaterialBuildState): this;
  143062. }
  143063. }
  143064. declare module BABYLON {
  143065. /**
  143066. * Block used to get the min of 2 values
  143067. */
  143068. export class MinBlock extends NodeMaterialBlock {
  143069. /**
  143070. * Creates a new MinBlock
  143071. * @param name defines the block name
  143072. */
  143073. constructor(name: string);
  143074. /**
  143075. * Gets the current class name
  143076. * @returns the class name
  143077. */
  143078. getClassName(): string;
  143079. /**
  143080. * Gets the left operand input component
  143081. */
  143082. get left(): NodeMaterialConnectionPoint;
  143083. /**
  143084. * Gets the right operand input component
  143085. */
  143086. get right(): NodeMaterialConnectionPoint;
  143087. /**
  143088. * Gets the output component
  143089. */
  143090. get output(): NodeMaterialConnectionPoint;
  143091. protected _buildBlock(state: NodeMaterialBuildState): this;
  143092. }
  143093. }
  143094. declare module BABYLON {
  143095. /**
  143096. * Block used to get the distance between 2 values
  143097. */
  143098. export class DistanceBlock extends NodeMaterialBlock {
  143099. /**
  143100. * Creates a new DistanceBlock
  143101. * @param name defines the block name
  143102. */
  143103. constructor(name: string);
  143104. /**
  143105. * Gets the current class name
  143106. * @returns the class name
  143107. */
  143108. getClassName(): string;
  143109. /**
  143110. * Gets the left operand input component
  143111. */
  143112. get left(): NodeMaterialConnectionPoint;
  143113. /**
  143114. * Gets the right operand input component
  143115. */
  143116. get right(): NodeMaterialConnectionPoint;
  143117. /**
  143118. * Gets the output component
  143119. */
  143120. get output(): NodeMaterialConnectionPoint;
  143121. protected _buildBlock(state: NodeMaterialBuildState): this;
  143122. }
  143123. }
  143124. declare module BABYLON {
  143125. /**
  143126. * Block used to get the length of a vector
  143127. */
  143128. export class LengthBlock extends NodeMaterialBlock {
  143129. /**
  143130. * Creates a new LengthBlock
  143131. * @param name defines the block name
  143132. */
  143133. constructor(name: string);
  143134. /**
  143135. * Gets the current class name
  143136. * @returns the class name
  143137. */
  143138. getClassName(): string;
  143139. /**
  143140. * Gets the value input component
  143141. */
  143142. get value(): NodeMaterialConnectionPoint;
  143143. /**
  143144. * Gets the output component
  143145. */
  143146. get output(): NodeMaterialConnectionPoint;
  143147. protected _buildBlock(state: NodeMaterialBuildState): this;
  143148. }
  143149. }
  143150. declare module BABYLON {
  143151. /**
  143152. * Block used to get negative version of a value (i.e. x * -1)
  143153. */
  143154. export class NegateBlock extends NodeMaterialBlock {
  143155. /**
  143156. * Creates a new NegateBlock
  143157. * @param name defines the block name
  143158. */
  143159. constructor(name: string);
  143160. /**
  143161. * Gets the current class name
  143162. * @returns the class name
  143163. */
  143164. getClassName(): string;
  143165. /**
  143166. * Gets the value input component
  143167. */
  143168. get value(): NodeMaterialConnectionPoint;
  143169. /**
  143170. * Gets the output component
  143171. */
  143172. get output(): NodeMaterialConnectionPoint;
  143173. protected _buildBlock(state: NodeMaterialBuildState): this;
  143174. }
  143175. }
  143176. declare module BABYLON {
  143177. /**
  143178. * Block used to get the value of the first parameter raised to the power of the second
  143179. */
  143180. export class PowBlock extends NodeMaterialBlock {
  143181. /**
  143182. * Creates a new PowBlock
  143183. * @param name defines the block name
  143184. */
  143185. constructor(name: string);
  143186. /**
  143187. * Gets the current class name
  143188. * @returns the class name
  143189. */
  143190. getClassName(): string;
  143191. /**
  143192. * Gets the value operand input component
  143193. */
  143194. get value(): NodeMaterialConnectionPoint;
  143195. /**
  143196. * Gets the power operand input component
  143197. */
  143198. get power(): NodeMaterialConnectionPoint;
  143199. /**
  143200. * Gets the output component
  143201. */
  143202. get output(): NodeMaterialConnectionPoint;
  143203. protected _buildBlock(state: NodeMaterialBuildState): this;
  143204. }
  143205. }
  143206. declare module BABYLON {
  143207. /**
  143208. * Block used to get a random number
  143209. */
  143210. export class RandomNumberBlock extends NodeMaterialBlock {
  143211. /**
  143212. * Creates a new RandomNumberBlock
  143213. * @param name defines the block name
  143214. */
  143215. constructor(name: string);
  143216. /**
  143217. * Gets the current class name
  143218. * @returns the class name
  143219. */
  143220. getClassName(): string;
  143221. /**
  143222. * Gets the seed input component
  143223. */
  143224. get seed(): NodeMaterialConnectionPoint;
  143225. /**
  143226. * Gets the output component
  143227. */
  143228. get output(): NodeMaterialConnectionPoint;
  143229. protected _buildBlock(state: NodeMaterialBuildState): this;
  143230. }
  143231. }
  143232. declare module BABYLON {
  143233. /**
  143234. * Block used to compute arc tangent of 2 values
  143235. */
  143236. export class ArcTan2Block extends NodeMaterialBlock {
  143237. /**
  143238. * Creates a new ArcTan2Block
  143239. * @param name defines the block name
  143240. */
  143241. constructor(name: string);
  143242. /**
  143243. * Gets the current class name
  143244. * @returns the class name
  143245. */
  143246. getClassName(): string;
  143247. /**
  143248. * Gets the x operand input component
  143249. */
  143250. get x(): NodeMaterialConnectionPoint;
  143251. /**
  143252. * Gets the y operand input component
  143253. */
  143254. get y(): NodeMaterialConnectionPoint;
  143255. /**
  143256. * Gets the output component
  143257. */
  143258. get output(): NodeMaterialConnectionPoint;
  143259. protected _buildBlock(state: NodeMaterialBuildState): this;
  143260. }
  143261. }
  143262. declare module BABYLON {
  143263. /**
  143264. * Block used to smooth step a value
  143265. */
  143266. export class SmoothStepBlock extends NodeMaterialBlock {
  143267. /**
  143268. * Creates a new SmoothStepBlock
  143269. * @param name defines the block name
  143270. */
  143271. constructor(name: string);
  143272. /**
  143273. * Gets the current class name
  143274. * @returns the class name
  143275. */
  143276. getClassName(): string;
  143277. /**
  143278. * Gets the value operand input component
  143279. */
  143280. get value(): NodeMaterialConnectionPoint;
  143281. /**
  143282. * Gets the first edge operand input component
  143283. */
  143284. get edge0(): NodeMaterialConnectionPoint;
  143285. /**
  143286. * Gets the second edge operand input component
  143287. */
  143288. get edge1(): NodeMaterialConnectionPoint;
  143289. /**
  143290. * Gets the output component
  143291. */
  143292. get output(): NodeMaterialConnectionPoint;
  143293. protected _buildBlock(state: NodeMaterialBuildState): this;
  143294. }
  143295. }
  143296. declare module BABYLON {
  143297. /**
  143298. * Block used to get the reciprocal (1 / x) of a value
  143299. */
  143300. export class ReciprocalBlock extends NodeMaterialBlock {
  143301. /**
  143302. * Creates a new ReciprocalBlock
  143303. * @param name defines the block name
  143304. */
  143305. constructor(name: string);
  143306. /**
  143307. * Gets the current class name
  143308. * @returns the class name
  143309. */
  143310. getClassName(): string;
  143311. /**
  143312. * Gets the input component
  143313. */
  143314. get input(): NodeMaterialConnectionPoint;
  143315. /**
  143316. * Gets the output component
  143317. */
  143318. get output(): NodeMaterialConnectionPoint;
  143319. protected _buildBlock(state: NodeMaterialBuildState): this;
  143320. }
  143321. }
  143322. declare module BABYLON {
  143323. /**
  143324. * Block used to replace a color by another one
  143325. */
  143326. export class ReplaceColorBlock extends NodeMaterialBlock {
  143327. /**
  143328. * Creates a new ReplaceColorBlock
  143329. * @param name defines the block name
  143330. */
  143331. constructor(name: string);
  143332. /**
  143333. * Gets the current class name
  143334. * @returns the class name
  143335. */
  143336. getClassName(): string;
  143337. /**
  143338. * Gets the value input component
  143339. */
  143340. get value(): NodeMaterialConnectionPoint;
  143341. /**
  143342. * Gets the reference input component
  143343. */
  143344. get reference(): NodeMaterialConnectionPoint;
  143345. /**
  143346. * Gets the distance input component
  143347. */
  143348. get distance(): NodeMaterialConnectionPoint;
  143349. /**
  143350. * Gets the replacement input component
  143351. */
  143352. get replacement(): NodeMaterialConnectionPoint;
  143353. /**
  143354. * Gets the output component
  143355. */
  143356. get output(): NodeMaterialConnectionPoint;
  143357. protected _buildBlock(state: NodeMaterialBuildState): this;
  143358. }
  143359. }
  143360. declare module BABYLON {
  143361. /**
  143362. * Block used to posterize a value
  143363. * @see https://en.wikipedia.org/wiki/Posterization
  143364. */
  143365. export class PosterizeBlock extends NodeMaterialBlock {
  143366. /**
  143367. * Creates a new PosterizeBlock
  143368. * @param name defines the block name
  143369. */
  143370. constructor(name: string);
  143371. /**
  143372. * Gets the current class name
  143373. * @returns the class name
  143374. */
  143375. getClassName(): string;
  143376. /**
  143377. * Gets the value input component
  143378. */
  143379. get value(): NodeMaterialConnectionPoint;
  143380. /**
  143381. * Gets the steps input component
  143382. */
  143383. get steps(): NodeMaterialConnectionPoint;
  143384. /**
  143385. * Gets the output component
  143386. */
  143387. get output(): NodeMaterialConnectionPoint;
  143388. protected _buildBlock(state: NodeMaterialBuildState): this;
  143389. }
  143390. }
  143391. declare module BABYLON {
  143392. /**
  143393. * Operations supported by the Wave block
  143394. */
  143395. export enum WaveBlockKind {
  143396. /** SawTooth */
  143397. SawTooth = 0,
  143398. /** Square */
  143399. Square = 1,
  143400. /** Triangle */
  143401. Triangle = 2
  143402. }
  143403. /**
  143404. * Block used to apply wave operation to floats
  143405. */
  143406. export class WaveBlock extends NodeMaterialBlock {
  143407. /**
  143408. * Gets or sets the kibnd of wave to be applied by the block
  143409. */
  143410. kind: WaveBlockKind;
  143411. /**
  143412. * Creates a new WaveBlock
  143413. * @param name defines the block name
  143414. */
  143415. constructor(name: string);
  143416. /**
  143417. * Gets the current class name
  143418. * @returns the class name
  143419. */
  143420. getClassName(): string;
  143421. /**
  143422. * Gets the input component
  143423. */
  143424. get input(): NodeMaterialConnectionPoint;
  143425. /**
  143426. * Gets the output component
  143427. */
  143428. get output(): NodeMaterialConnectionPoint;
  143429. protected _buildBlock(state: NodeMaterialBuildState): this;
  143430. serialize(): any;
  143431. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143432. }
  143433. }
  143434. declare module BABYLON {
  143435. /**
  143436. * Class used to store a color step for the GradientBlock
  143437. */
  143438. export class GradientBlockColorStep {
  143439. /**
  143440. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143441. */
  143442. step: number;
  143443. /**
  143444. * Gets or sets the color associated with this step
  143445. */
  143446. color: Color3;
  143447. /**
  143448. * Creates a new GradientBlockColorStep
  143449. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  143450. * @param color defines the color associated with this step
  143451. */
  143452. constructor(
  143453. /**
  143454. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143455. */
  143456. step: number,
  143457. /**
  143458. * Gets or sets the color associated with this step
  143459. */
  143460. color: Color3);
  143461. }
  143462. /**
  143463. * Block used to return a color from a gradient based on an input value between 0 and 1
  143464. */
  143465. export class GradientBlock extends NodeMaterialBlock {
  143466. /**
  143467. * Gets or sets the list of color steps
  143468. */
  143469. colorSteps: GradientBlockColorStep[];
  143470. /**
  143471. * Creates a new GradientBlock
  143472. * @param name defines the block name
  143473. */
  143474. constructor(name: string);
  143475. /**
  143476. * Gets the current class name
  143477. * @returns the class name
  143478. */
  143479. getClassName(): string;
  143480. /**
  143481. * Gets the gradient input component
  143482. */
  143483. get gradient(): NodeMaterialConnectionPoint;
  143484. /**
  143485. * Gets the output component
  143486. */
  143487. get output(): NodeMaterialConnectionPoint;
  143488. private _writeColorConstant;
  143489. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143490. serialize(): any;
  143491. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143492. protected _dumpPropertiesCode(): string;
  143493. }
  143494. }
  143495. declare module BABYLON {
  143496. /**
  143497. * Block used to normalize lerp between 2 values
  143498. */
  143499. export class NLerpBlock extends NodeMaterialBlock {
  143500. /**
  143501. * Creates a new NLerpBlock
  143502. * @param name defines the block name
  143503. */
  143504. constructor(name: string);
  143505. /**
  143506. * Gets the current class name
  143507. * @returns the class name
  143508. */
  143509. getClassName(): string;
  143510. /**
  143511. * Gets the left operand input component
  143512. */
  143513. get left(): NodeMaterialConnectionPoint;
  143514. /**
  143515. * Gets the right operand input component
  143516. */
  143517. get right(): NodeMaterialConnectionPoint;
  143518. /**
  143519. * Gets the gradient operand input component
  143520. */
  143521. get gradient(): NodeMaterialConnectionPoint;
  143522. /**
  143523. * Gets the output component
  143524. */
  143525. get output(): NodeMaterialConnectionPoint;
  143526. protected _buildBlock(state: NodeMaterialBuildState): this;
  143527. }
  143528. }
  143529. declare module BABYLON {
  143530. /**
  143531. * block used to Generate a Worley Noise 3D Noise Pattern
  143532. */
  143533. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  143534. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  143535. manhattanDistance: boolean;
  143536. /**
  143537. * Creates a new WorleyNoise3DBlock
  143538. * @param name defines the block name
  143539. */
  143540. constructor(name: string);
  143541. /**
  143542. * Gets the current class name
  143543. * @returns the class name
  143544. */
  143545. getClassName(): string;
  143546. /**
  143547. * Gets the seed input component
  143548. */
  143549. get seed(): NodeMaterialConnectionPoint;
  143550. /**
  143551. * Gets the jitter input component
  143552. */
  143553. get jitter(): NodeMaterialConnectionPoint;
  143554. /**
  143555. * Gets the output component
  143556. */
  143557. get output(): NodeMaterialConnectionPoint;
  143558. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143559. /**
  143560. * Exposes the properties to the UI?
  143561. */
  143562. protected _dumpPropertiesCode(): string;
  143563. /**
  143564. * Exposes the properties to the Seralize?
  143565. */
  143566. serialize(): any;
  143567. /**
  143568. * Exposes the properties to the deseralize?
  143569. */
  143570. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143571. }
  143572. }
  143573. declare module BABYLON {
  143574. /**
  143575. * block used to Generate a Simplex Perlin 3d Noise Pattern
  143576. */
  143577. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  143578. /**
  143579. * Creates a new SimplexPerlin3DBlock
  143580. * @param name defines the block name
  143581. */
  143582. constructor(name: string);
  143583. /**
  143584. * Gets the current class name
  143585. * @returns the class name
  143586. */
  143587. getClassName(): string;
  143588. /**
  143589. * Gets the seed operand input component
  143590. */
  143591. get seed(): NodeMaterialConnectionPoint;
  143592. /**
  143593. * Gets the output component
  143594. */
  143595. get output(): NodeMaterialConnectionPoint;
  143596. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143597. }
  143598. }
  143599. declare module BABYLON {
  143600. /**
  143601. * Block used to blend normals
  143602. */
  143603. export class NormalBlendBlock extends NodeMaterialBlock {
  143604. /**
  143605. * Creates a new NormalBlendBlock
  143606. * @param name defines the block name
  143607. */
  143608. constructor(name: string);
  143609. /**
  143610. * Gets the current class name
  143611. * @returns the class name
  143612. */
  143613. getClassName(): string;
  143614. /**
  143615. * Gets the first input component
  143616. */
  143617. get normalMap0(): NodeMaterialConnectionPoint;
  143618. /**
  143619. * Gets the second input component
  143620. */
  143621. get normalMap1(): NodeMaterialConnectionPoint;
  143622. /**
  143623. * Gets the output component
  143624. */
  143625. get output(): NodeMaterialConnectionPoint;
  143626. protected _buildBlock(state: NodeMaterialBuildState): this;
  143627. }
  143628. }
  143629. declare module BABYLON {
  143630. /**
  143631. * Block used to rotate a 2d vector by a given angle
  143632. */
  143633. export class Rotate2dBlock extends NodeMaterialBlock {
  143634. /**
  143635. * Creates a new Rotate2dBlock
  143636. * @param name defines the block name
  143637. */
  143638. constructor(name: string);
  143639. /**
  143640. * Gets the current class name
  143641. * @returns the class name
  143642. */
  143643. getClassName(): string;
  143644. /**
  143645. * Gets the input vector
  143646. */
  143647. get input(): NodeMaterialConnectionPoint;
  143648. /**
  143649. * Gets the input angle
  143650. */
  143651. get angle(): NodeMaterialConnectionPoint;
  143652. /**
  143653. * Gets the output component
  143654. */
  143655. get output(): NodeMaterialConnectionPoint;
  143656. autoConfigure(material: NodeMaterial): void;
  143657. protected _buildBlock(state: NodeMaterialBuildState): this;
  143658. }
  143659. }
  143660. declare module BABYLON {
  143661. /**
  143662. * Block used to get the reflected vector from a direction and a normal
  143663. */
  143664. export class ReflectBlock extends NodeMaterialBlock {
  143665. /**
  143666. * Creates a new ReflectBlock
  143667. * @param name defines the block name
  143668. */
  143669. constructor(name: string);
  143670. /**
  143671. * Gets the current class name
  143672. * @returns the class name
  143673. */
  143674. getClassName(): string;
  143675. /**
  143676. * Gets the incident component
  143677. */
  143678. get incident(): NodeMaterialConnectionPoint;
  143679. /**
  143680. * Gets the normal component
  143681. */
  143682. get normal(): NodeMaterialConnectionPoint;
  143683. /**
  143684. * Gets the output component
  143685. */
  143686. get output(): NodeMaterialConnectionPoint;
  143687. protected _buildBlock(state: NodeMaterialBuildState): this;
  143688. }
  143689. }
  143690. declare module BABYLON {
  143691. /**
  143692. * Block used to get the refracted vector from a direction and a normal
  143693. */
  143694. export class RefractBlock extends NodeMaterialBlock {
  143695. /**
  143696. * Creates a new RefractBlock
  143697. * @param name defines the block name
  143698. */
  143699. constructor(name: string);
  143700. /**
  143701. * Gets the current class name
  143702. * @returns the class name
  143703. */
  143704. getClassName(): string;
  143705. /**
  143706. * Gets the incident component
  143707. */
  143708. get incident(): NodeMaterialConnectionPoint;
  143709. /**
  143710. * Gets the normal component
  143711. */
  143712. get normal(): NodeMaterialConnectionPoint;
  143713. /**
  143714. * Gets the index of refraction component
  143715. */
  143716. get ior(): NodeMaterialConnectionPoint;
  143717. /**
  143718. * Gets the output component
  143719. */
  143720. get output(): NodeMaterialConnectionPoint;
  143721. protected _buildBlock(state: NodeMaterialBuildState): this;
  143722. }
  143723. }
  143724. declare module BABYLON {
  143725. /**
  143726. * Block used to desaturate a color
  143727. */
  143728. export class DesaturateBlock extends NodeMaterialBlock {
  143729. /**
  143730. * Creates a new DesaturateBlock
  143731. * @param name defines the block name
  143732. */
  143733. constructor(name: string);
  143734. /**
  143735. * Gets the current class name
  143736. * @returns the class name
  143737. */
  143738. getClassName(): string;
  143739. /**
  143740. * Gets the color operand input component
  143741. */
  143742. get color(): NodeMaterialConnectionPoint;
  143743. /**
  143744. * Gets the level operand input component
  143745. */
  143746. get level(): NodeMaterialConnectionPoint;
  143747. /**
  143748. * Gets the output component
  143749. */
  143750. get output(): NodeMaterialConnectionPoint;
  143751. protected _buildBlock(state: NodeMaterialBuildState): this;
  143752. }
  143753. }
  143754. declare module BABYLON {
  143755. /**
  143756. * Block used to implement the ambient occlusion module of the PBR material
  143757. */
  143758. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  143759. /**
  143760. * Create a new AmbientOcclusionBlock
  143761. * @param name defines the block name
  143762. */
  143763. constructor(name: string);
  143764. /**
  143765. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  143766. */
  143767. useAmbientInGrayScale: boolean;
  143768. /**
  143769. * Initialize the block and prepare the context for build
  143770. * @param state defines the state that will be used for the build
  143771. */
  143772. initialize(state: NodeMaterialBuildState): void;
  143773. /**
  143774. * Gets the current class name
  143775. * @returns the class name
  143776. */
  143777. getClassName(): string;
  143778. /**
  143779. * Gets the texture input component
  143780. */
  143781. get texture(): NodeMaterialConnectionPoint;
  143782. /**
  143783. * Gets the texture intensity component
  143784. */
  143785. get intensity(): NodeMaterialConnectionPoint;
  143786. /**
  143787. * Gets the direct light intensity input component
  143788. */
  143789. get directLightIntensity(): NodeMaterialConnectionPoint;
  143790. /**
  143791. * Gets the ambient occlusion object output component
  143792. */
  143793. get ambientOcclusion(): NodeMaterialConnectionPoint;
  143794. /**
  143795. * Gets the main code of the block (fragment side)
  143796. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  143797. * @returns the shader code
  143798. */
  143799. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  143800. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143801. protected _buildBlock(state: NodeMaterialBuildState): this;
  143802. protected _dumpPropertiesCode(): string;
  143803. serialize(): any;
  143804. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143805. }
  143806. }
  143807. declare module BABYLON {
  143808. /**
  143809. * Block used to implement the reflection module of the PBR material
  143810. */
  143811. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  143812. /** @hidden */
  143813. _defineLODReflectionAlpha: string;
  143814. /** @hidden */
  143815. _defineLinearSpecularReflection: string;
  143816. private _vEnvironmentIrradianceName;
  143817. /** @hidden */
  143818. _vReflectionMicrosurfaceInfosName: string;
  143819. /** @hidden */
  143820. _vReflectionInfosName: string;
  143821. /** @hidden */
  143822. _vReflectionFilteringInfoName: string;
  143823. private _scene;
  143824. /**
  143825. * The three properties below are set by the main PBR block prior to calling methods of this class.
  143826. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  143827. * It's less burden on the user side in the editor part.
  143828. */
  143829. /** @hidden */
  143830. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  143831. /** @hidden */
  143832. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  143833. /** @hidden */
  143834. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  143835. /**
  143836. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  143837. * diffuse part of the IBL.
  143838. */
  143839. useSphericalHarmonics: boolean;
  143840. /**
  143841. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  143842. */
  143843. forceIrradianceInFragment: boolean;
  143844. /**
  143845. * Create a new ReflectionBlock
  143846. * @param name defines the block name
  143847. */
  143848. constructor(name: string);
  143849. /**
  143850. * Gets the current class name
  143851. * @returns the class name
  143852. */
  143853. getClassName(): string;
  143854. /**
  143855. * Gets the position input component
  143856. */
  143857. get position(): NodeMaterialConnectionPoint;
  143858. /**
  143859. * Gets the world position input component
  143860. */
  143861. get worldPosition(): NodeMaterialConnectionPoint;
  143862. /**
  143863. * Gets the world normal input component
  143864. */
  143865. get worldNormal(): NodeMaterialConnectionPoint;
  143866. /**
  143867. * Gets the world input component
  143868. */
  143869. get world(): NodeMaterialConnectionPoint;
  143870. /**
  143871. * Gets the camera (or eye) position component
  143872. */
  143873. get cameraPosition(): NodeMaterialConnectionPoint;
  143874. /**
  143875. * Gets the view input component
  143876. */
  143877. get view(): NodeMaterialConnectionPoint;
  143878. /**
  143879. * Gets the color input component
  143880. */
  143881. get color(): NodeMaterialConnectionPoint;
  143882. /**
  143883. * Gets the reflection object output component
  143884. */
  143885. get reflection(): NodeMaterialConnectionPoint;
  143886. /**
  143887. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  143888. */
  143889. get hasTexture(): boolean;
  143890. /**
  143891. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  143892. */
  143893. get reflectionColor(): string;
  143894. protected _getTexture(): Nullable<BaseTexture>;
  143895. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143896. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  143897. /**
  143898. * Gets the code to inject in the vertex shader
  143899. * @param state current state of the node material building
  143900. * @returns the shader code
  143901. */
  143902. handleVertexSide(state: NodeMaterialBuildState): string;
  143903. /**
  143904. * Gets the main code of the block (fragment side)
  143905. * @param state current state of the node material building
  143906. * @param normalVarName name of the existing variable corresponding to the normal
  143907. * @returns the shader code
  143908. */
  143909. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  143910. protected _buildBlock(state: NodeMaterialBuildState): this;
  143911. protected _dumpPropertiesCode(): string;
  143912. serialize(): any;
  143913. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143914. }
  143915. }
  143916. declare module BABYLON {
  143917. /**
  143918. * Block used to implement the sheen module of the PBR material
  143919. */
  143920. export class SheenBlock extends NodeMaterialBlock {
  143921. /**
  143922. * Create a new SheenBlock
  143923. * @param name defines the block name
  143924. */
  143925. constructor(name: string);
  143926. /**
  143927. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  143928. * It allows the strength of the sheen effect to not depend on the base color of the material,
  143929. * making it easier to setup and tweak the effect
  143930. */
  143931. albedoScaling: boolean;
  143932. /**
  143933. * Defines if the sheen is linked to the sheen color.
  143934. */
  143935. linkSheenWithAlbedo: boolean;
  143936. /**
  143937. * Initialize the block and prepare the context for build
  143938. * @param state defines the state that will be used for the build
  143939. */
  143940. initialize(state: NodeMaterialBuildState): void;
  143941. /**
  143942. * Gets the current class name
  143943. * @returns the class name
  143944. */
  143945. getClassName(): string;
  143946. /**
  143947. * Gets the intensity input component
  143948. */
  143949. get intensity(): NodeMaterialConnectionPoint;
  143950. /**
  143951. * Gets the color input component
  143952. */
  143953. get color(): NodeMaterialConnectionPoint;
  143954. /**
  143955. * Gets the roughness input component
  143956. */
  143957. get roughness(): NodeMaterialConnectionPoint;
  143958. /**
  143959. * Gets the sheen object output component
  143960. */
  143961. get sheen(): NodeMaterialConnectionPoint;
  143962. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143963. /**
  143964. * Gets the main code of the block (fragment side)
  143965. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  143966. * @returns the shader code
  143967. */
  143968. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  143969. protected _buildBlock(state: NodeMaterialBuildState): this;
  143970. protected _dumpPropertiesCode(): string;
  143971. serialize(): any;
  143972. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143973. }
  143974. }
  143975. declare module BABYLON {
  143976. /**
  143977. * Block used to implement the reflectivity module of the PBR material
  143978. */
  143979. export class ReflectivityBlock extends NodeMaterialBlock {
  143980. private _metallicReflectanceColor;
  143981. private _metallicF0Factor;
  143982. /** @hidden */
  143983. _vMetallicReflectanceFactorsName: string;
  143984. /**
  143985. * The property below is set by the main PBR block prior to calling methods of this class.
  143986. */
  143987. /** @hidden */
  143988. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  143989. /**
  143990. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  143991. */
  143992. useAmbientOcclusionFromMetallicTextureRed: boolean;
  143993. /**
  143994. * Specifies if the metallic texture contains the metallness information in its blue channel.
  143995. */
  143996. useMetallnessFromMetallicTextureBlue: boolean;
  143997. /**
  143998. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  143999. */
  144000. useRoughnessFromMetallicTextureAlpha: boolean;
  144001. /**
  144002. * Specifies if the metallic texture contains the roughness information in its green channel.
  144003. */
  144004. useRoughnessFromMetallicTextureGreen: boolean;
  144005. /**
  144006. * Create a new ReflectivityBlock
  144007. * @param name defines the block name
  144008. */
  144009. constructor(name: string);
  144010. /**
  144011. * Initialize the block and prepare the context for build
  144012. * @param state defines the state that will be used for the build
  144013. */
  144014. initialize(state: NodeMaterialBuildState): void;
  144015. /**
  144016. * Gets the current class name
  144017. * @returns the class name
  144018. */
  144019. getClassName(): string;
  144020. /**
  144021. * Gets the metallic input component
  144022. */
  144023. get metallic(): NodeMaterialConnectionPoint;
  144024. /**
  144025. * Gets the roughness input component
  144026. */
  144027. get roughness(): NodeMaterialConnectionPoint;
  144028. /**
  144029. * Gets the texture input component
  144030. */
  144031. get texture(): NodeMaterialConnectionPoint;
  144032. /**
  144033. * Gets the reflectivity object output component
  144034. */
  144035. get reflectivity(): NodeMaterialConnectionPoint;
  144036. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144037. /**
  144038. * Gets the main code of the block (fragment side)
  144039. * @param state current state of the node material building
  144040. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  144041. * @returns the shader code
  144042. */
  144043. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  144044. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144045. protected _buildBlock(state: NodeMaterialBuildState): this;
  144046. protected _dumpPropertiesCode(): string;
  144047. serialize(): any;
  144048. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144049. }
  144050. }
  144051. declare module BABYLON {
  144052. /**
  144053. * Block used to implement the anisotropy module of the PBR material
  144054. */
  144055. export class AnisotropyBlock extends NodeMaterialBlock {
  144056. /**
  144057. * The two properties below are set by the main PBR block prior to calling methods of this class.
  144058. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  144059. * It's less burden on the user side in the editor part.
  144060. */
  144061. /** @hidden */
  144062. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  144063. /** @hidden */
  144064. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  144065. /**
  144066. * Create a new AnisotropyBlock
  144067. * @param name defines the block name
  144068. */
  144069. constructor(name: string);
  144070. /**
  144071. * Initialize the block and prepare the context for build
  144072. * @param state defines the state that will be used for the build
  144073. */
  144074. initialize(state: NodeMaterialBuildState): void;
  144075. /**
  144076. * Gets the current class name
  144077. * @returns the class name
  144078. */
  144079. getClassName(): string;
  144080. /**
  144081. * Gets the intensity input component
  144082. */
  144083. get intensity(): NodeMaterialConnectionPoint;
  144084. /**
  144085. * Gets the direction input component
  144086. */
  144087. get direction(): NodeMaterialConnectionPoint;
  144088. /**
  144089. * Gets the texture input component
  144090. */
  144091. get texture(): NodeMaterialConnectionPoint;
  144092. /**
  144093. * Gets the uv input component
  144094. */
  144095. get uv(): NodeMaterialConnectionPoint;
  144096. /**
  144097. * Gets the worldTangent input component
  144098. */
  144099. get worldTangent(): NodeMaterialConnectionPoint;
  144100. /**
  144101. * Gets the anisotropy object output component
  144102. */
  144103. get anisotropy(): NodeMaterialConnectionPoint;
  144104. private _generateTBNSpace;
  144105. /**
  144106. * Gets the main code of the block (fragment side)
  144107. * @param state current state of the node material building
  144108. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144109. * @returns the shader code
  144110. */
  144111. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  144112. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144113. protected _buildBlock(state: NodeMaterialBuildState): this;
  144114. }
  144115. }
  144116. declare module BABYLON {
  144117. /**
  144118. * Block used to implement the clear coat module of the PBR material
  144119. */
  144120. export class ClearCoatBlock extends NodeMaterialBlock {
  144121. private _scene;
  144122. /**
  144123. * Create a new ClearCoatBlock
  144124. * @param name defines the block name
  144125. */
  144126. constructor(name: string);
  144127. /**
  144128. * Initialize the block and prepare the context for build
  144129. * @param state defines the state that will be used for the build
  144130. */
  144131. initialize(state: NodeMaterialBuildState): void;
  144132. /**
  144133. * Gets the current class name
  144134. * @returns the class name
  144135. */
  144136. getClassName(): string;
  144137. /**
  144138. * Gets the intensity input component
  144139. */
  144140. get intensity(): NodeMaterialConnectionPoint;
  144141. /**
  144142. * Gets the roughness input component
  144143. */
  144144. get roughness(): NodeMaterialConnectionPoint;
  144145. /**
  144146. * Gets the ior input component
  144147. */
  144148. get ior(): NodeMaterialConnectionPoint;
  144149. /**
  144150. * Gets the texture input component
  144151. */
  144152. get texture(): NodeMaterialConnectionPoint;
  144153. /**
  144154. * Gets the bump texture input component
  144155. */
  144156. get bumpTexture(): NodeMaterialConnectionPoint;
  144157. /**
  144158. * Gets the uv input component
  144159. */
  144160. get uv(): NodeMaterialConnectionPoint;
  144161. /**
  144162. * Gets the tint color input component
  144163. */
  144164. get tintColor(): NodeMaterialConnectionPoint;
  144165. /**
  144166. * Gets the tint "at distance" input component
  144167. */
  144168. get tintAtDistance(): NodeMaterialConnectionPoint;
  144169. /**
  144170. * Gets the tint thickness input component
  144171. */
  144172. get tintThickness(): NodeMaterialConnectionPoint;
  144173. /**
  144174. * Gets the world tangent input component
  144175. */
  144176. get worldTangent(): NodeMaterialConnectionPoint;
  144177. /**
  144178. * Gets the clear coat object output component
  144179. */
  144180. get clearcoat(): NodeMaterialConnectionPoint;
  144181. autoConfigure(material: NodeMaterial): void;
  144182. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144183. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144184. private _generateTBNSpace;
  144185. /**
  144186. * Gets the main code of the block (fragment side)
  144187. * @param state current state of the node material building
  144188. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  144189. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144190. * @param worldPosVarName name of the variable holding the world position
  144191. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144192. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  144193. * @param worldNormalVarName name of the variable holding the world normal
  144194. * @returns the shader code
  144195. */
  144196. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  144197. protected _buildBlock(state: NodeMaterialBuildState): this;
  144198. }
  144199. }
  144200. declare module BABYLON {
  144201. /**
  144202. * Block used to implement the sub surface module of the PBR material
  144203. */
  144204. export class SubSurfaceBlock extends NodeMaterialBlock {
  144205. /**
  144206. * Create a new SubSurfaceBlock
  144207. * @param name defines the block name
  144208. */
  144209. constructor(name: string);
  144210. /**
  144211. * Stores the intensity of the different subsurface effects in the thickness texture.
  144212. * * the green channel is the translucency intensity.
  144213. * * the blue channel is the scattering intensity.
  144214. * * the alpha channel is the refraction intensity.
  144215. */
  144216. useMaskFromThicknessTexture: boolean;
  144217. /**
  144218. * Initialize the block and prepare the context for build
  144219. * @param state defines the state that will be used for the build
  144220. */
  144221. initialize(state: NodeMaterialBuildState): void;
  144222. /**
  144223. * Gets the current class name
  144224. * @returns the class name
  144225. */
  144226. getClassName(): string;
  144227. /**
  144228. * Gets the min thickness input component
  144229. */
  144230. get minThickness(): NodeMaterialConnectionPoint;
  144231. /**
  144232. * Gets the max thickness input component
  144233. */
  144234. get maxThickness(): NodeMaterialConnectionPoint;
  144235. /**
  144236. * Gets the thickness texture component
  144237. */
  144238. get thicknessTexture(): NodeMaterialConnectionPoint;
  144239. /**
  144240. * Gets the tint color input component
  144241. */
  144242. get tintColor(): NodeMaterialConnectionPoint;
  144243. /**
  144244. * Gets the translucency intensity input component
  144245. */
  144246. get translucencyIntensity(): NodeMaterialConnectionPoint;
  144247. /**
  144248. * Gets the translucency diffusion distance input component
  144249. */
  144250. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  144251. /**
  144252. * Gets the refraction object parameters
  144253. */
  144254. get refraction(): NodeMaterialConnectionPoint;
  144255. /**
  144256. * Gets the sub surface object output component
  144257. */
  144258. get subsurface(): NodeMaterialConnectionPoint;
  144259. autoConfigure(material: NodeMaterial): void;
  144260. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144261. /**
  144262. * Gets the main code of the block (fragment side)
  144263. * @param state current state of the node material building
  144264. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  144265. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144266. * @param worldPosVarName name of the variable holding the world position
  144267. * @returns the shader code
  144268. */
  144269. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  144270. protected _buildBlock(state: NodeMaterialBuildState): this;
  144271. }
  144272. }
  144273. declare module BABYLON {
  144274. /**
  144275. * Block used to implement the PBR metallic/roughness model
  144276. */
  144277. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  144278. /**
  144279. * Gets or sets the light associated with this block
  144280. */
  144281. light: Nullable<Light>;
  144282. private _lightId;
  144283. private _scene;
  144284. private _environmentBRDFTexture;
  144285. private _environmentBrdfSamplerName;
  144286. private _vNormalWName;
  144287. private _invertNormalName;
  144288. /**
  144289. * Create a new ReflectionBlock
  144290. * @param name defines the block name
  144291. */
  144292. constructor(name: string);
  144293. /**
  144294. * Intensity of the direct lights e.g. the four lights available in your scene.
  144295. * This impacts both the direct diffuse and specular highlights.
  144296. */
  144297. directIntensity: number;
  144298. /**
  144299. * Intensity of the environment e.g. how much the environment will light the object
  144300. * either through harmonics for rough material or through the refelction for shiny ones.
  144301. */
  144302. environmentIntensity: number;
  144303. /**
  144304. * This is a special control allowing the reduction of the specular highlights coming from the
  144305. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  144306. */
  144307. specularIntensity: number;
  144308. /**
  144309. * Defines the falloff type used in this material.
  144310. * It by default is Physical.
  144311. */
  144312. lightFalloff: number;
  144313. /**
  144314. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  144315. */
  144316. useAlphaFromAlbedoTexture: boolean;
  144317. /**
  144318. * Specifies that alpha test should be used
  144319. */
  144320. useAlphaTest: boolean;
  144321. /**
  144322. * Defines the alpha limits in alpha test mode.
  144323. */
  144324. alphaTestCutoff: number;
  144325. /**
  144326. * Specifies that alpha blending should be used
  144327. */
  144328. useAlphaBlending: boolean;
  144329. /**
  144330. * Defines if the alpha value should be determined via the rgb values.
  144331. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  144332. */
  144333. opacityRGB: boolean;
  144334. /**
  144335. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  144336. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  144337. */
  144338. useRadianceOverAlpha: boolean;
  144339. /**
  144340. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  144341. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  144342. */
  144343. useSpecularOverAlpha: boolean;
  144344. /**
  144345. * Enables specular anti aliasing in the PBR shader.
  144346. * It will both interacts on the Geometry for analytical and IBL lighting.
  144347. * It also prefilter the roughness map based on the bump values.
  144348. */
  144349. enableSpecularAntiAliasing: boolean;
  144350. /**
  144351. * Enables realtime filtering on the texture.
  144352. */
  144353. realTimeFiltering: boolean;
  144354. /**
  144355. * Quality switch for realtime filtering
  144356. */
  144357. realTimeFilteringQuality: number;
  144358. /**
  144359. * Defines if the material uses energy conservation.
  144360. */
  144361. useEnergyConservation: boolean;
  144362. /**
  144363. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  144364. * too much the area relying on ambient texture to define their ambient occlusion.
  144365. */
  144366. useRadianceOcclusion: boolean;
  144367. /**
  144368. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  144369. * makes the reflect vector face the model (under horizon).
  144370. */
  144371. useHorizonOcclusion: boolean;
  144372. /**
  144373. * If set to true, no lighting calculations will be applied.
  144374. */
  144375. unlit: boolean;
  144376. /**
  144377. * Force normal to face away from face.
  144378. */
  144379. forceNormalForward: boolean;
  144380. /**
  144381. * Defines the material debug mode.
  144382. * It helps seeing only some components of the material while troubleshooting.
  144383. */
  144384. debugMode: number;
  144385. /**
  144386. * Specify from where on screen the debug mode should start.
  144387. * The value goes from -1 (full screen) to 1 (not visible)
  144388. * It helps with side by side comparison against the final render
  144389. * This defaults to 0
  144390. */
  144391. debugLimit: number;
  144392. /**
  144393. * As the default viewing range might not be enough (if the ambient is really small for instance)
  144394. * You can use the factor to better multiply the final value.
  144395. */
  144396. debugFactor: number;
  144397. /**
  144398. * Initialize the block and prepare the context for build
  144399. * @param state defines the state that will be used for the build
  144400. */
  144401. initialize(state: NodeMaterialBuildState): void;
  144402. /**
  144403. * Gets the current class name
  144404. * @returns the class name
  144405. */
  144406. getClassName(): string;
  144407. /**
  144408. * Gets the world position input component
  144409. */
  144410. get worldPosition(): NodeMaterialConnectionPoint;
  144411. /**
  144412. * Gets the world normal input component
  144413. */
  144414. get worldNormal(): NodeMaterialConnectionPoint;
  144415. /**
  144416. * Gets the perturbed normal input component
  144417. */
  144418. get perturbedNormal(): NodeMaterialConnectionPoint;
  144419. /**
  144420. * Gets the camera position input component
  144421. */
  144422. get cameraPosition(): NodeMaterialConnectionPoint;
  144423. /**
  144424. * Gets the base color input component
  144425. */
  144426. get baseColor(): NodeMaterialConnectionPoint;
  144427. /**
  144428. * Gets the opacity texture input component
  144429. */
  144430. get opacityTexture(): NodeMaterialConnectionPoint;
  144431. /**
  144432. * Gets the ambient color input component
  144433. */
  144434. get ambientColor(): NodeMaterialConnectionPoint;
  144435. /**
  144436. * Gets the reflectivity object parameters
  144437. */
  144438. get reflectivity(): NodeMaterialConnectionPoint;
  144439. /**
  144440. * Gets the ambient occlusion object parameters
  144441. */
  144442. get ambientOcclusion(): NodeMaterialConnectionPoint;
  144443. /**
  144444. * Gets the reflection object parameters
  144445. */
  144446. get reflection(): NodeMaterialConnectionPoint;
  144447. /**
  144448. * Gets the sheen object parameters
  144449. */
  144450. get sheen(): NodeMaterialConnectionPoint;
  144451. /**
  144452. * Gets the clear coat object parameters
  144453. */
  144454. get clearcoat(): NodeMaterialConnectionPoint;
  144455. /**
  144456. * Gets the sub surface object parameters
  144457. */
  144458. get subsurface(): NodeMaterialConnectionPoint;
  144459. /**
  144460. * Gets the anisotropy object parameters
  144461. */
  144462. get anisotropy(): NodeMaterialConnectionPoint;
  144463. /**
  144464. * Gets the ambient output component
  144465. */
  144466. get ambient(): NodeMaterialConnectionPoint;
  144467. /**
  144468. * Gets the diffuse output component
  144469. */
  144470. get diffuse(): NodeMaterialConnectionPoint;
  144471. /**
  144472. * Gets the specular output component
  144473. */
  144474. get specular(): NodeMaterialConnectionPoint;
  144475. /**
  144476. * Gets the sheen output component
  144477. */
  144478. get sheenDir(): NodeMaterialConnectionPoint;
  144479. /**
  144480. * Gets the clear coat output component
  144481. */
  144482. get clearcoatDir(): NodeMaterialConnectionPoint;
  144483. /**
  144484. * Gets the indirect diffuse output component
  144485. */
  144486. get diffuseIndirect(): NodeMaterialConnectionPoint;
  144487. /**
  144488. * Gets the indirect specular output component
  144489. */
  144490. get specularIndirect(): NodeMaterialConnectionPoint;
  144491. /**
  144492. * Gets the indirect sheen output component
  144493. */
  144494. get sheenIndirect(): NodeMaterialConnectionPoint;
  144495. /**
  144496. * Gets the indirect clear coat output component
  144497. */
  144498. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  144499. /**
  144500. * Gets the refraction output component
  144501. */
  144502. get refraction(): NodeMaterialConnectionPoint;
  144503. /**
  144504. * Gets the global lighting output component
  144505. */
  144506. get lighting(): NodeMaterialConnectionPoint;
  144507. /**
  144508. * Gets the shadow output component
  144509. */
  144510. get shadow(): NodeMaterialConnectionPoint;
  144511. /**
  144512. * Gets the alpha output component
  144513. */
  144514. get alpha(): NodeMaterialConnectionPoint;
  144515. autoConfigure(material: NodeMaterial): void;
  144516. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144517. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  144518. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144519. private _injectVertexCode;
  144520. /**
  144521. * Gets the code corresponding to the albedo/opacity module
  144522. * @returns the shader code
  144523. */
  144524. getAlbedoOpacityCode(): string;
  144525. protected _buildBlock(state: NodeMaterialBuildState): this;
  144526. protected _dumpPropertiesCode(): string;
  144527. serialize(): any;
  144528. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144529. }
  144530. }
  144531. declare module BABYLON {
  144532. /**
  144533. * Block used to compute value of one parameter modulo another
  144534. */
  144535. export class ModBlock extends NodeMaterialBlock {
  144536. /**
  144537. * Creates a new ModBlock
  144538. * @param name defines the block name
  144539. */
  144540. constructor(name: string);
  144541. /**
  144542. * Gets the current class name
  144543. * @returns the class name
  144544. */
  144545. getClassName(): string;
  144546. /**
  144547. * Gets the left operand input component
  144548. */
  144549. get left(): NodeMaterialConnectionPoint;
  144550. /**
  144551. * Gets the right operand input component
  144552. */
  144553. get right(): NodeMaterialConnectionPoint;
  144554. /**
  144555. * Gets the output component
  144556. */
  144557. get output(): NodeMaterialConnectionPoint;
  144558. protected _buildBlock(state: NodeMaterialBuildState): this;
  144559. }
  144560. }
  144561. declare module BABYLON {
  144562. /**
  144563. * Helper class to push actions to a pool of workers.
  144564. */
  144565. export class WorkerPool implements IDisposable {
  144566. private _workerInfos;
  144567. private _pendingActions;
  144568. /**
  144569. * Constructor
  144570. * @param workers Array of workers to use for actions
  144571. */
  144572. constructor(workers: Array<Worker>);
  144573. /**
  144574. * Terminates all workers and clears any pending actions.
  144575. */
  144576. dispose(): void;
  144577. /**
  144578. * Pushes an action to the worker pool. If all the workers are active, the action will be
  144579. * pended until a worker has completed its action.
  144580. * @param action The action to perform. Call onComplete when the action is complete.
  144581. */
  144582. push(action: (worker: Worker, onComplete: () => void) => void): void;
  144583. private _execute;
  144584. }
  144585. }
  144586. declare module BABYLON {
  144587. /**
  144588. * Configuration for Draco compression
  144589. */
  144590. export interface IDracoCompressionConfiguration {
  144591. /**
  144592. * Configuration for the decoder.
  144593. */
  144594. decoder: {
  144595. /**
  144596. * The url to the WebAssembly module.
  144597. */
  144598. wasmUrl?: string;
  144599. /**
  144600. * The url to the WebAssembly binary.
  144601. */
  144602. wasmBinaryUrl?: string;
  144603. /**
  144604. * The url to the fallback JavaScript module.
  144605. */
  144606. fallbackUrl?: string;
  144607. };
  144608. }
  144609. /**
  144610. * Draco compression (https://google.github.io/draco/)
  144611. *
  144612. * This class wraps the Draco module.
  144613. *
  144614. * **Encoder**
  144615. *
  144616. * The encoder is not currently implemented.
  144617. *
  144618. * **Decoder**
  144619. *
  144620. * 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.
  144621. *
  144622. * To update the configuration, use the following code:
  144623. * ```javascript
  144624. * DracoCompression.Configuration = {
  144625. * decoder: {
  144626. * wasmUrl: "<url to the WebAssembly library>",
  144627. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  144628. * fallbackUrl: "<url to the fallback JavaScript library>",
  144629. * }
  144630. * };
  144631. * ```
  144632. *
  144633. * 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.
  144634. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  144635. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  144636. *
  144637. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  144638. * ```javascript
  144639. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  144640. * ```
  144641. *
  144642. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  144643. */
  144644. export class DracoCompression implements IDisposable {
  144645. private _workerPoolPromise?;
  144646. private _decoderModulePromise?;
  144647. /**
  144648. * The configuration. Defaults to the following urls:
  144649. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  144650. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  144651. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  144652. */
  144653. static Configuration: IDracoCompressionConfiguration;
  144654. /**
  144655. * Returns true if the decoder configuration is available.
  144656. */
  144657. static get DecoderAvailable(): boolean;
  144658. /**
  144659. * Default number of workers to create when creating the draco compression object.
  144660. */
  144661. static DefaultNumWorkers: number;
  144662. private static GetDefaultNumWorkers;
  144663. private static _Default;
  144664. /**
  144665. * Default instance for the draco compression object.
  144666. */
  144667. static get Default(): DracoCompression;
  144668. /**
  144669. * Constructor
  144670. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  144671. */
  144672. constructor(numWorkers?: number);
  144673. /**
  144674. * Stop all async operations and release resources.
  144675. */
  144676. dispose(): void;
  144677. /**
  144678. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  144679. * @returns a promise that resolves when ready
  144680. */
  144681. whenReadyAsync(): Promise<void>;
  144682. /**
  144683. * Decode Draco compressed mesh data to vertex data.
  144684. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  144685. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  144686. * @returns A promise that resolves with the decoded vertex data
  144687. */
  144688. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  144689. [kind: string]: number;
  144690. }): Promise<VertexData>;
  144691. }
  144692. }
  144693. declare module BABYLON {
  144694. /**
  144695. * Class for building Constructive Solid Geometry
  144696. */
  144697. export class CSG {
  144698. private polygons;
  144699. /**
  144700. * The world matrix
  144701. */
  144702. matrix: Matrix;
  144703. /**
  144704. * Stores the position
  144705. */
  144706. position: Vector3;
  144707. /**
  144708. * Stores the rotation
  144709. */
  144710. rotation: Vector3;
  144711. /**
  144712. * Stores the rotation quaternion
  144713. */
  144714. rotationQuaternion: Nullable<Quaternion>;
  144715. /**
  144716. * Stores the scaling vector
  144717. */
  144718. scaling: Vector3;
  144719. /**
  144720. * Convert the Mesh to CSG
  144721. * @param mesh The Mesh to convert to CSG
  144722. * @returns A new CSG from the Mesh
  144723. */
  144724. static FromMesh(mesh: Mesh): CSG;
  144725. /**
  144726. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  144727. * @param polygons Polygons used to construct a CSG solid
  144728. */
  144729. private static FromPolygons;
  144730. /**
  144731. * Clones, or makes a deep copy, of the CSG
  144732. * @returns A new CSG
  144733. */
  144734. clone(): CSG;
  144735. /**
  144736. * Unions this CSG with another CSG
  144737. * @param csg The CSG to union against this CSG
  144738. * @returns The unioned CSG
  144739. */
  144740. union(csg: CSG): CSG;
  144741. /**
  144742. * Unions this CSG with another CSG in place
  144743. * @param csg The CSG to union against this CSG
  144744. */
  144745. unionInPlace(csg: CSG): void;
  144746. /**
  144747. * Subtracts this CSG with another CSG
  144748. * @param csg The CSG to subtract against this CSG
  144749. * @returns A new CSG
  144750. */
  144751. subtract(csg: CSG): CSG;
  144752. /**
  144753. * Subtracts this CSG with another CSG in place
  144754. * @param csg The CSG to subtact against this CSG
  144755. */
  144756. subtractInPlace(csg: CSG): void;
  144757. /**
  144758. * Intersect this CSG with another CSG
  144759. * @param csg The CSG to intersect against this CSG
  144760. * @returns A new CSG
  144761. */
  144762. intersect(csg: CSG): CSG;
  144763. /**
  144764. * Intersects this CSG with another CSG in place
  144765. * @param csg The CSG to intersect against this CSG
  144766. */
  144767. intersectInPlace(csg: CSG): void;
  144768. /**
  144769. * Return a new CSG solid with solid and empty space switched. This solid is
  144770. * not modified.
  144771. * @returns A new CSG solid with solid and empty space switched
  144772. */
  144773. inverse(): CSG;
  144774. /**
  144775. * Inverses the CSG in place
  144776. */
  144777. inverseInPlace(): void;
  144778. /**
  144779. * This is used to keep meshes transformations so they can be restored
  144780. * when we build back a Babylon Mesh
  144781. * NB : All CSG operations are performed in world coordinates
  144782. * @param csg The CSG to copy the transform attributes from
  144783. * @returns This CSG
  144784. */
  144785. copyTransformAttributes(csg: CSG): CSG;
  144786. /**
  144787. * Build Raw mesh from CSG
  144788. * Coordinates here are in world space
  144789. * @param name The name of the mesh geometry
  144790. * @param scene The Scene
  144791. * @param keepSubMeshes Specifies if the submeshes should be kept
  144792. * @returns A new Mesh
  144793. */
  144794. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144795. /**
  144796. * Build Mesh from CSG taking material and transforms into account
  144797. * @param name The name of the Mesh
  144798. * @param material The material of the Mesh
  144799. * @param scene The Scene
  144800. * @param keepSubMeshes Specifies if submeshes should be kept
  144801. * @returns The new Mesh
  144802. */
  144803. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144804. }
  144805. }
  144806. declare module BABYLON {
  144807. /**
  144808. * Class used to create a trail following a mesh
  144809. */
  144810. export class TrailMesh extends Mesh {
  144811. private _generator;
  144812. private _autoStart;
  144813. private _running;
  144814. private _diameter;
  144815. private _length;
  144816. private _sectionPolygonPointsCount;
  144817. private _sectionVectors;
  144818. private _sectionNormalVectors;
  144819. private _beforeRenderObserver;
  144820. /**
  144821. * @constructor
  144822. * @param name The value used by scene.getMeshByName() to do a lookup.
  144823. * @param generator The mesh or transform node to generate a trail.
  144824. * @param scene The scene to add this mesh to.
  144825. * @param diameter Diameter of trailing mesh. Default is 1.
  144826. * @param length Length of trailing mesh. Default is 60.
  144827. * @param autoStart Automatically start trailing mesh. Default true.
  144828. */
  144829. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  144830. /**
  144831. * "TrailMesh"
  144832. * @returns "TrailMesh"
  144833. */
  144834. getClassName(): string;
  144835. private _createMesh;
  144836. /**
  144837. * Start trailing mesh.
  144838. */
  144839. start(): void;
  144840. /**
  144841. * Stop trailing mesh.
  144842. */
  144843. stop(): void;
  144844. /**
  144845. * Update trailing mesh geometry.
  144846. */
  144847. update(): void;
  144848. /**
  144849. * Returns a new TrailMesh object.
  144850. * @param name is a string, the name given to the new mesh
  144851. * @param newGenerator use new generator object for cloned trail mesh
  144852. * @returns a new mesh
  144853. */
  144854. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  144855. /**
  144856. * Serializes this trail mesh
  144857. * @param serializationObject object to write serialization to
  144858. */
  144859. serialize(serializationObject: any): void;
  144860. /**
  144861. * Parses a serialized trail mesh
  144862. * @param parsedMesh the serialized mesh
  144863. * @param scene the scene to create the trail mesh in
  144864. * @returns the created trail mesh
  144865. */
  144866. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  144867. }
  144868. }
  144869. declare module BABYLON {
  144870. /**
  144871. * Class containing static functions to help procedurally build meshes
  144872. */
  144873. export class TiledBoxBuilder {
  144874. /**
  144875. * Creates a box mesh
  144876. * 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)
  144877. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  144878. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144879. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144880. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144881. * @param name defines the name of the mesh
  144882. * @param options defines the options used to create the mesh
  144883. * @param scene defines the hosting scene
  144884. * @returns the box mesh
  144885. */
  144886. static CreateTiledBox(name: string, options: {
  144887. pattern?: number;
  144888. width?: number;
  144889. height?: number;
  144890. depth?: number;
  144891. tileSize?: number;
  144892. tileWidth?: number;
  144893. tileHeight?: number;
  144894. alignHorizontal?: number;
  144895. alignVertical?: number;
  144896. faceUV?: Vector4[];
  144897. faceColors?: Color4[];
  144898. sideOrientation?: number;
  144899. updatable?: boolean;
  144900. }, scene?: Nullable<Scene>): Mesh;
  144901. }
  144902. }
  144903. declare module BABYLON {
  144904. /**
  144905. * Class containing static functions to help procedurally build meshes
  144906. */
  144907. export class TorusKnotBuilder {
  144908. /**
  144909. * Creates a torus knot mesh
  144910. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  144911. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  144912. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  144913. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  144914. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144915. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144916. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144917. * @param name defines the name of the mesh
  144918. * @param options defines the options used to create the mesh
  144919. * @param scene defines the hosting scene
  144920. * @returns the torus knot mesh
  144921. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  144922. */
  144923. static CreateTorusKnot(name: string, options: {
  144924. radius?: number;
  144925. tube?: number;
  144926. radialSegments?: number;
  144927. tubularSegments?: number;
  144928. p?: number;
  144929. q?: number;
  144930. updatable?: boolean;
  144931. sideOrientation?: number;
  144932. frontUVs?: Vector4;
  144933. backUVs?: Vector4;
  144934. }, scene: any): Mesh;
  144935. }
  144936. }
  144937. declare module BABYLON {
  144938. /**
  144939. * Polygon
  144940. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  144941. */
  144942. export class Polygon {
  144943. /**
  144944. * Creates a rectangle
  144945. * @param xmin bottom X coord
  144946. * @param ymin bottom Y coord
  144947. * @param xmax top X coord
  144948. * @param ymax top Y coord
  144949. * @returns points that make the resulting rectation
  144950. */
  144951. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  144952. /**
  144953. * Creates a circle
  144954. * @param radius radius of circle
  144955. * @param cx scale in x
  144956. * @param cy scale in y
  144957. * @param numberOfSides number of sides that make up the circle
  144958. * @returns points that make the resulting circle
  144959. */
  144960. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  144961. /**
  144962. * Creates a polygon from input string
  144963. * @param input Input polygon data
  144964. * @returns the parsed points
  144965. */
  144966. static Parse(input: string): Vector2[];
  144967. /**
  144968. * Starts building a polygon from x and y coordinates
  144969. * @param x x coordinate
  144970. * @param y y coordinate
  144971. * @returns the started path2
  144972. */
  144973. static StartingAt(x: number, y: number): Path2;
  144974. }
  144975. /**
  144976. * Builds a polygon
  144977. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  144978. */
  144979. export class PolygonMeshBuilder {
  144980. private _points;
  144981. private _outlinepoints;
  144982. private _holes;
  144983. private _name;
  144984. private _scene;
  144985. private _epoints;
  144986. private _eholes;
  144987. private _addToepoint;
  144988. /**
  144989. * Babylon reference to the earcut plugin.
  144990. */
  144991. bjsEarcut: any;
  144992. /**
  144993. * Creates a PolygonMeshBuilder
  144994. * @param name name of the builder
  144995. * @param contours Path of the polygon
  144996. * @param scene scene to add to when creating the mesh
  144997. * @param earcutInjection can be used to inject your own earcut reference
  144998. */
  144999. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  145000. /**
  145001. * Adds a whole within the polygon
  145002. * @param hole Array of points defining the hole
  145003. * @returns this
  145004. */
  145005. addHole(hole: Vector2[]): PolygonMeshBuilder;
  145006. /**
  145007. * Creates the polygon
  145008. * @param updatable If the mesh should be updatable
  145009. * @param depth The depth of the mesh created
  145010. * @returns the created mesh
  145011. */
  145012. build(updatable?: boolean, depth?: number): Mesh;
  145013. /**
  145014. * Creates the polygon
  145015. * @param depth The depth of the mesh created
  145016. * @returns the created VertexData
  145017. */
  145018. buildVertexData(depth?: number): VertexData;
  145019. /**
  145020. * Adds a side to the polygon
  145021. * @param positions points that make the polygon
  145022. * @param normals normals of the polygon
  145023. * @param uvs uvs of the polygon
  145024. * @param indices indices of the polygon
  145025. * @param bounds bounds of the polygon
  145026. * @param points points of the polygon
  145027. * @param depth depth of the polygon
  145028. * @param flip flip of the polygon
  145029. */
  145030. private addSide;
  145031. }
  145032. }
  145033. declare module BABYLON {
  145034. /**
  145035. * Class containing static functions to help procedurally build meshes
  145036. */
  145037. export class PolygonBuilder {
  145038. /**
  145039. * Creates a polygon mesh
  145040. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145041. * * 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
  145042. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145043. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145044. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  145045. * * Remember you can only change the shape positions, not their number when updating a polygon
  145046. * @param name defines the name of the mesh
  145047. * @param options defines the options used to create the mesh
  145048. * @param scene defines the hosting scene
  145049. * @param earcutInjection can be used to inject your own earcut reference
  145050. * @returns the polygon mesh
  145051. */
  145052. static CreatePolygon(name: string, options: {
  145053. shape: Vector3[];
  145054. holes?: Vector3[][];
  145055. depth?: number;
  145056. faceUV?: Vector4[];
  145057. faceColors?: Color4[];
  145058. updatable?: boolean;
  145059. sideOrientation?: number;
  145060. frontUVs?: Vector4;
  145061. backUVs?: Vector4;
  145062. wrap?: boolean;
  145063. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145064. /**
  145065. * Creates an extruded polygon mesh, with depth in the Y direction.
  145066. * * 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)
  145067. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145068. * @param name defines the name of the mesh
  145069. * @param options defines the options used to create the mesh
  145070. * @param scene defines the hosting scene
  145071. * @param earcutInjection can be used to inject your own earcut reference
  145072. * @returns the polygon mesh
  145073. */
  145074. static ExtrudePolygon(name: string, options: {
  145075. shape: Vector3[];
  145076. holes?: Vector3[][];
  145077. depth?: number;
  145078. faceUV?: Vector4[];
  145079. faceColors?: Color4[];
  145080. updatable?: boolean;
  145081. sideOrientation?: number;
  145082. frontUVs?: Vector4;
  145083. backUVs?: Vector4;
  145084. wrap?: boolean;
  145085. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145086. }
  145087. }
  145088. declare module BABYLON {
  145089. /**
  145090. * Class containing static functions to help procedurally build meshes
  145091. */
  145092. export class LatheBuilder {
  145093. /**
  145094. * Creates lathe mesh.
  145095. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145096. * * 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
  145097. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145098. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145099. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145100. * * 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
  145101. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145102. * * 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
  145103. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145104. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145105. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145106. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145107. * @param name defines the name of the mesh
  145108. * @param options defines the options used to create the mesh
  145109. * @param scene defines the hosting scene
  145110. * @returns the lathe mesh
  145111. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145112. */
  145113. static CreateLathe(name: string, options: {
  145114. shape: Vector3[];
  145115. radius?: number;
  145116. tessellation?: number;
  145117. clip?: number;
  145118. arc?: number;
  145119. closed?: boolean;
  145120. updatable?: boolean;
  145121. sideOrientation?: number;
  145122. frontUVs?: Vector4;
  145123. backUVs?: Vector4;
  145124. cap?: number;
  145125. invertUV?: boolean;
  145126. }, scene?: Nullable<Scene>): Mesh;
  145127. }
  145128. }
  145129. declare module BABYLON {
  145130. /**
  145131. * Class containing static functions to help procedurally build meshes
  145132. */
  145133. export class TiledPlaneBuilder {
  145134. /**
  145135. * Creates a tiled plane mesh
  145136. * * The parameter `pattern` will, depending on value, do nothing or
  145137. * * * flip (reflect about central vertical) alternate tiles across and up
  145138. * * * flip every tile on alternate rows
  145139. * * * rotate (180 degs) alternate tiles across and up
  145140. * * * rotate every tile on alternate rows
  145141. * * * flip and rotate alternate tiles across and up
  145142. * * * flip and rotate every tile on alternate rows
  145143. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  145144. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  145145. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145146. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145147. * * 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)
  145148. * * 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)
  145149. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145150. * @param name defines the name of the mesh
  145151. * @param options defines the options used to create the mesh
  145152. * @param scene defines the hosting scene
  145153. * @returns the box mesh
  145154. */
  145155. static CreateTiledPlane(name: string, options: {
  145156. pattern?: number;
  145157. tileSize?: number;
  145158. tileWidth?: number;
  145159. tileHeight?: number;
  145160. size?: number;
  145161. width?: number;
  145162. height?: number;
  145163. alignHorizontal?: number;
  145164. alignVertical?: number;
  145165. sideOrientation?: number;
  145166. frontUVs?: Vector4;
  145167. backUVs?: Vector4;
  145168. updatable?: boolean;
  145169. }, scene?: Nullable<Scene>): Mesh;
  145170. }
  145171. }
  145172. declare module BABYLON {
  145173. /**
  145174. * Class containing static functions to help procedurally build meshes
  145175. */
  145176. export class TubeBuilder {
  145177. /**
  145178. * Creates a tube mesh.
  145179. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145180. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145181. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145182. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145183. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145184. * * 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)
  145185. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145186. * * 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
  145187. * * 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
  145188. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145189. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145190. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145191. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145192. * @param name defines the name of the mesh
  145193. * @param options defines the options used to create the mesh
  145194. * @param scene defines the hosting scene
  145195. * @returns the tube mesh
  145196. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145197. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145198. */
  145199. static CreateTube(name: string, options: {
  145200. path: Vector3[];
  145201. radius?: number;
  145202. tessellation?: number;
  145203. radiusFunction?: {
  145204. (i: number, distance: number): number;
  145205. };
  145206. cap?: number;
  145207. arc?: number;
  145208. updatable?: boolean;
  145209. sideOrientation?: number;
  145210. frontUVs?: Vector4;
  145211. backUVs?: Vector4;
  145212. instance?: Mesh;
  145213. invertUV?: boolean;
  145214. }, scene?: Nullable<Scene>): Mesh;
  145215. }
  145216. }
  145217. declare module BABYLON {
  145218. /**
  145219. * Class containing static functions to help procedurally build meshes
  145220. */
  145221. export class IcoSphereBuilder {
  145222. /**
  145223. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145224. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145225. * * 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`)
  145226. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145227. * * 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
  145228. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145229. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145230. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145231. * @param name defines the name of the mesh
  145232. * @param options defines the options used to create the mesh
  145233. * @param scene defines the hosting scene
  145234. * @returns the icosahedron mesh
  145235. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145236. */
  145237. static CreateIcoSphere(name: string, options: {
  145238. radius?: number;
  145239. radiusX?: number;
  145240. radiusY?: number;
  145241. radiusZ?: number;
  145242. flat?: boolean;
  145243. subdivisions?: number;
  145244. sideOrientation?: number;
  145245. frontUVs?: Vector4;
  145246. backUVs?: Vector4;
  145247. updatable?: boolean;
  145248. }, scene?: Nullable<Scene>): Mesh;
  145249. }
  145250. }
  145251. declare module BABYLON {
  145252. /**
  145253. * Class containing static functions to help procedurally build meshes
  145254. */
  145255. export class DecalBuilder {
  145256. /**
  145257. * Creates a decal mesh.
  145258. * 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
  145259. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145260. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145261. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145262. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145263. * @param name defines the name of the mesh
  145264. * @param sourceMesh defines the mesh where the decal must be applied
  145265. * @param options defines the options used to create the mesh
  145266. * @param scene defines the hosting scene
  145267. * @returns the decal mesh
  145268. * @see https://doc.babylonjs.com/how_to/decals
  145269. */
  145270. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  145271. position?: Vector3;
  145272. normal?: Vector3;
  145273. size?: Vector3;
  145274. angle?: number;
  145275. }): Mesh;
  145276. }
  145277. }
  145278. declare module BABYLON {
  145279. /**
  145280. * Class containing static functions to help procedurally build meshes
  145281. */
  145282. export class MeshBuilder {
  145283. /**
  145284. * Creates a box mesh
  145285. * * The parameter `size` sets the size (float) of each box side (default 1)
  145286. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  145287. * * 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)
  145288. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145289. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145290. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145291. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145292. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145293. * @param name defines the name of the mesh
  145294. * @param options defines the options used to create the mesh
  145295. * @param scene defines the hosting scene
  145296. * @returns the box mesh
  145297. */
  145298. static CreateBox(name: string, options: {
  145299. size?: number;
  145300. width?: number;
  145301. height?: number;
  145302. depth?: number;
  145303. faceUV?: Vector4[];
  145304. faceColors?: Color4[];
  145305. sideOrientation?: number;
  145306. frontUVs?: Vector4;
  145307. backUVs?: Vector4;
  145308. wrap?: boolean;
  145309. topBaseAt?: number;
  145310. bottomBaseAt?: number;
  145311. updatable?: boolean;
  145312. }, scene?: Nullable<Scene>): Mesh;
  145313. /**
  145314. * Creates a tiled box mesh
  145315. * * faceTiles sets the pattern, tile size and number of tiles for a face
  145316. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145317. * @param name defines the name of the mesh
  145318. * @param options defines the options used to create the mesh
  145319. * @param scene defines the hosting scene
  145320. * @returns the tiled box mesh
  145321. */
  145322. static CreateTiledBox(name: string, options: {
  145323. pattern?: number;
  145324. size?: number;
  145325. width?: number;
  145326. height?: number;
  145327. depth: number;
  145328. tileSize?: number;
  145329. tileWidth?: number;
  145330. tileHeight?: number;
  145331. faceUV?: Vector4[];
  145332. faceColors?: Color4[];
  145333. alignHorizontal?: number;
  145334. alignVertical?: number;
  145335. sideOrientation?: number;
  145336. updatable?: boolean;
  145337. }, scene?: Nullable<Scene>): Mesh;
  145338. /**
  145339. * Creates a sphere mesh
  145340. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  145341. * * 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`)
  145342. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  145343. * * 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
  145344. * * 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)
  145345. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145346. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145347. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145348. * @param name defines the name of the mesh
  145349. * @param options defines the options used to create the mesh
  145350. * @param scene defines the hosting scene
  145351. * @returns the sphere mesh
  145352. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  145353. */
  145354. static CreateSphere(name: string, options: {
  145355. segments?: number;
  145356. diameter?: number;
  145357. diameterX?: number;
  145358. diameterY?: number;
  145359. diameterZ?: number;
  145360. arc?: number;
  145361. slice?: number;
  145362. sideOrientation?: number;
  145363. frontUVs?: Vector4;
  145364. backUVs?: Vector4;
  145365. updatable?: boolean;
  145366. }, scene?: Nullable<Scene>): Mesh;
  145367. /**
  145368. * Creates a plane polygonal mesh. By default, this is a disc
  145369. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  145370. * * 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
  145371. * * 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
  145372. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145373. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145374. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145375. * @param name defines the name of the mesh
  145376. * @param options defines the options used to create the mesh
  145377. * @param scene defines the hosting scene
  145378. * @returns the plane polygonal mesh
  145379. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  145380. */
  145381. static CreateDisc(name: string, options: {
  145382. radius?: number;
  145383. tessellation?: number;
  145384. arc?: number;
  145385. updatable?: boolean;
  145386. sideOrientation?: number;
  145387. frontUVs?: Vector4;
  145388. backUVs?: Vector4;
  145389. }, scene?: Nullable<Scene>): Mesh;
  145390. /**
  145391. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145392. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145393. * * 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`)
  145394. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145395. * * 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
  145396. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145397. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145398. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145399. * @param name defines the name of the mesh
  145400. * @param options defines the options used to create the mesh
  145401. * @param scene defines the hosting scene
  145402. * @returns the icosahedron mesh
  145403. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145404. */
  145405. static CreateIcoSphere(name: string, options: {
  145406. radius?: number;
  145407. radiusX?: number;
  145408. radiusY?: number;
  145409. radiusZ?: number;
  145410. flat?: boolean;
  145411. subdivisions?: number;
  145412. sideOrientation?: number;
  145413. frontUVs?: Vector4;
  145414. backUVs?: Vector4;
  145415. updatable?: boolean;
  145416. }, scene?: Nullable<Scene>): Mesh;
  145417. /**
  145418. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145419. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  145420. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  145421. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  145422. * * 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
  145423. * * 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
  145424. * * 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
  145425. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145426. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145427. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145428. * * 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
  145429. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  145430. * * 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
  145431. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  145432. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145433. * @param name defines the name of the mesh
  145434. * @param options defines the options used to create the mesh
  145435. * @param scene defines the hosting scene
  145436. * @returns the ribbon mesh
  145437. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  145438. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145439. */
  145440. static CreateRibbon(name: string, options: {
  145441. pathArray: Vector3[][];
  145442. closeArray?: boolean;
  145443. closePath?: boolean;
  145444. offset?: number;
  145445. updatable?: boolean;
  145446. sideOrientation?: number;
  145447. frontUVs?: Vector4;
  145448. backUVs?: Vector4;
  145449. instance?: Mesh;
  145450. invertUV?: boolean;
  145451. uvs?: Vector2[];
  145452. colors?: Color4[];
  145453. }, scene?: Nullable<Scene>): Mesh;
  145454. /**
  145455. * Creates a cylinder or a cone mesh
  145456. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  145457. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  145458. * * 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.
  145459. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  145460. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  145461. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  145462. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  145463. * * 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).
  145464. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  145465. * * 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).
  145466. * * 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
  145467. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  145468. * * 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
  145469. * * 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.
  145470. * * If `enclose` is false, a ring surface is one element.
  145471. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  145472. * * 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
  145473. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145474. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145475. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145476. * @param name defines the name of the mesh
  145477. * @param options defines the options used to create the mesh
  145478. * @param scene defines the hosting scene
  145479. * @returns the cylinder mesh
  145480. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  145481. */
  145482. static CreateCylinder(name: string, options: {
  145483. height?: number;
  145484. diameterTop?: number;
  145485. diameterBottom?: number;
  145486. diameter?: number;
  145487. tessellation?: number;
  145488. subdivisions?: number;
  145489. arc?: number;
  145490. faceColors?: Color4[];
  145491. faceUV?: Vector4[];
  145492. updatable?: boolean;
  145493. hasRings?: boolean;
  145494. enclose?: boolean;
  145495. cap?: number;
  145496. sideOrientation?: number;
  145497. frontUVs?: Vector4;
  145498. backUVs?: Vector4;
  145499. }, scene?: Nullable<Scene>): Mesh;
  145500. /**
  145501. * Creates a torus mesh
  145502. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  145503. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  145504. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  145505. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145506. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145507. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145508. * @param name defines the name of the mesh
  145509. * @param options defines the options used to create the mesh
  145510. * @param scene defines the hosting scene
  145511. * @returns the torus mesh
  145512. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  145513. */
  145514. static CreateTorus(name: string, options: {
  145515. diameter?: number;
  145516. thickness?: number;
  145517. tessellation?: number;
  145518. updatable?: boolean;
  145519. sideOrientation?: number;
  145520. frontUVs?: Vector4;
  145521. backUVs?: Vector4;
  145522. }, scene?: Nullable<Scene>): Mesh;
  145523. /**
  145524. * Creates a torus knot mesh
  145525. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  145526. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  145527. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  145528. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  145529. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145530. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145531. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145532. * @param name defines the name of the mesh
  145533. * @param options defines the options used to create the mesh
  145534. * @param scene defines the hosting scene
  145535. * @returns the torus knot mesh
  145536. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  145537. */
  145538. static CreateTorusKnot(name: string, options: {
  145539. radius?: number;
  145540. tube?: number;
  145541. radialSegments?: number;
  145542. tubularSegments?: number;
  145543. p?: number;
  145544. q?: number;
  145545. updatable?: boolean;
  145546. sideOrientation?: number;
  145547. frontUVs?: Vector4;
  145548. backUVs?: Vector4;
  145549. }, scene?: Nullable<Scene>): Mesh;
  145550. /**
  145551. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  145552. * * 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
  145553. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  145554. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  145555. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  145556. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  145557. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  145558. * * 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
  145559. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  145560. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145561. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  145562. * @param name defines the name of the new line system
  145563. * @param options defines the options used to create the line system
  145564. * @param scene defines the hosting scene
  145565. * @returns a new line system mesh
  145566. */
  145567. static CreateLineSystem(name: string, options: {
  145568. lines: Vector3[][];
  145569. updatable?: boolean;
  145570. instance?: Nullable<LinesMesh>;
  145571. colors?: Nullable<Color4[][]>;
  145572. useVertexAlpha?: boolean;
  145573. }, scene: Nullable<Scene>): LinesMesh;
  145574. /**
  145575. * Creates a line mesh
  145576. * 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
  145577. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145578. * * The parameter `points` is an array successive Vector3
  145579. * * 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
  145580. * * The optional parameter `colors` is an array of successive Color4, one per line point
  145581. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  145582. * * When updating an instance, remember that only point positions can change, not the number of points
  145583. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145584. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  145585. * @param name defines the name of the new line system
  145586. * @param options defines the options used to create the line system
  145587. * @param scene defines the hosting scene
  145588. * @returns a new line mesh
  145589. */
  145590. static CreateLines(name: string, options: {
  145591. points: Vector3[];
  145592. updatable?: boolean;
  145593. instance?: Nullable<LinesMesh>;
  145594. colors?: Color4[];
  145595. useVertexAlpha?: boolean;
  145596. }, scene?: Nullable<Scene>): LinesMesh;
  145597. /**
  145598. * Creates a dashed line mesh
  145599. * * 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
  145600. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145601. * * The parameter `points` is an array successive Vector3
  145602. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  145603. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  145604. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  145605. * * 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
  145606. * * When updating an instance, remember that only point positions can change, not the number of points
  145607. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145608. * @param name defines the name of the mesh
  145609. * @param options defines the options used to create the mesh
  145610. * @param scene defines the hosting scene
  145611. * @returns the dashed line mesh
  145612. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  145613. */
  145614. static CreateDashedLines(name: string, options: {
  145615. points: Vector3[];
  145616. dashSize?: number;
  145617. gapSize?: number;
  145618. dashNb?: number;
  145619. updatable?: boolean;
  145620. instance?: LinesMesh;
  145621. }, scene?: Nullable<Scene>): LinesMesh;
  145622. /**
  145623. * 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.
  145624. * * 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.
  145625. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145626. * * 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.
  145627. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  145628. * * 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
  145629. * * 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
  145630. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  145631. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145632. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145633. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  145634. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145635. * @param name defines the name of the mesh
  145636. * @param options defines the options used to create the mesh
  145637. * @param scene defines the hosting scene
  145638. * @returns the extruded shape mesh
  145639. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145640. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145641. */
  145642. static ExtrudeShape(name: string, options: {
  145643. shape: Vector3[];
  145644. path: Vector3[];
  145645. scale?: number;
  145646. rotation?: number;
  145647. cap?: number;
  145648. updatable?: boolean;
  145649. sideOrientation?: number;
  145650. frontUVs?: Vector4;
  145651. backUVs?: Vector4;
  145652. instance?: Mesh;
  145653. invertUV?: boolean;
  145654. }, scene?: Nullable<Scene>): Mesh;
  145655. /**
  145656. * Creates an custom extruded shape mesh.
  145657. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  145658. * * 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.
  145659. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145660. * * 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
  145661. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  145662. * * 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
  145663. * * It must returns a float value that will be the scale value applied to the shape on each path point
  145664. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  145665. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  145666. * * 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
  145667. * * 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
  145668. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  145669. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145670. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145671. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145672. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145673. * @param name defines the name of the mesh
  145674. * @param options defines the options used to create the mesh
  145675. * @param scene defines the hosting scene
  145676. * @returns the custom extruded shape mesh
  145677. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  145678. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145679. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145680. */
  145681. static ExtrudeShapeCustom(name: string, options: {
  145682. shape: Vector3[];
  145683. path: Vector3[];
  145684. scaleFunction?: any;
  145685. rotationFunction?: any;
  145686. ribbonCloseArray?: boolean;
  145687. ribbonClosePath?: boolean;
  145688. cap?: number;
  145689. updatable?: boolean;
  145690. sideOrientation?: number;
  145691. frontUVs?: Vector4;
  145692. backUVs?: Vector4;
  145693. instance?: Mesh;
  145694. invertUV?: boolean;
  145695. }, scene?: Nullable<Scene>): Mesh;
  145696. /**
  145697. * Creates lathe mesh.
  145698. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145699. * * 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
  145700. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145701. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145702. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145703. * * 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
  145704. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145705. * * 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
  145706. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145707. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145708. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145709. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145710. * @param name defines the name of the mesh
  145711. * @param options defines the options used to create the mesh
  145712. * @param scene defines the hosting scene
  145713. * @returns the lathe mesh
  145714. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145715. */
  145716. static CreateLathe(name: string, options: {
  145717. shape: Vector3[];
  145718. radius?: number;
  145719. tessellation?: number;
  145720. clip?: number;
  145721. arc?: number;
  145722. closed?: boolean;
  145723. updatable?: boolean;
  145724. sideOrientation?: number;
  145725. frontUVs?: Vector4;
  145726. backUVs?: Vector4;
  145727. cap?: number;
  145728. invertUV?: boolean;
  145729. }, scene?: Nullable<Scene>): Mesh;
  145730. /**
  145731. * Creates a tiled plane mesh
  145732. * * You can set a limited pattern arrangement with the tiles
  145733. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145734. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145735. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145736. * @param name defines the name of the mesh
  145737. * @param options defines the options used to create the mesh
  145738. * @param scene defines the hosting scene
  145739. * @returns the plane mesh
  145740. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145741. */
  145742. static CreateTiledPlane(name: string, options: {
  145743. pattern?: number;
  145744. tileSize?: number;
  145745. tileWidth?: number;
  145746. tileHeight?: number;
  145747. size?: number;
  145748. width?: number;
  145749. height?: number;
  145750. alignHorizontal?: number;
  145751. alignVertical?: number;
  145752. sideOrientation?: number;
  145753. frontUVs?: Vector4;
  145754. backUVs?: Vector4;
  145755. updatable?: boolean;
  145756. }, scene?: Nullable<Scene>): Mesh;
  145757. /**
  145758. * Creates a plane mesh
  145759. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  145760. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  145761. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  145762. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145763. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145764. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145765. * @param name defines the name of the mesh
  145766. * @param options defines the options used to create the mesh
  145767. * @param scene defines the hosting scene
  145768. * @returns the plane mesh
  145769. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145770. */
  145771. static CreatePlane(name: string, options: {
  145772. size?: number;
  145773. width?: number;
  145774. height?: number;
  145775. sideOrientation?: number;
  145776. frontUVs?: Vector4;
  145777. backUVs?: Vector4;
  145778. updatable?: boolean;
  145779. sourcePlane?: Plane;
  145780. }, scene?: Nullable<Scene>): Mesh;
  145781. /**
  145782. * Creates a ground mesh
  145783. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  145784. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  145785. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145786. * @param name defines the name of the mesh
  145787. * @param options defines the options used to create the mesh
  145788. * @param scene defines the hosting scene
  145789. * @returns the ground mesh
  145790. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  145791. */
  145792. static CreateGround(name: string, options: {
  145793. width?: number;
  145794. height?: number;
  145795. subdivisions?: number;
  145796. subdivisionsX?: number;
  145797. subdivisionsY?: number;
  145798. updatable?: boolean;
  145799. }, scene?: Nullable<Scene>): Mesh;
  145800. /**
  145801. * Creates a tiled ground mesh
  145802. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  145803. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  145804. * * 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
  145805. * * 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
  145806. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145807. * @param name defines the name of the mesh
  145808. * @param options defines the options used to create the mesh
  145809. * @param scene defines the hosting scene
  145810. * @returns the tiled ground mesh
  145811. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  145812. */
  145813. static CreateTiledGround(name: string, options: {
  145814. xmin: number;
  145815. zmin: number;
  145816. xmax: number;
  145817. zmax: number;
  145818. subdivisions?: {
  145819. w: number;
  145820. h: number;
  145821. };
  145822. precision?: {
  145823. w: number;
  145824. h: number;
  145825. };
  145826. updatable?: boolean;
  145827. }, scene?: Nullable<Scene>): Mesh;
  145828. /**
  145829. * Creates a ground mesh from a height map
  145830. * * The parameter `url` sets the URL of the height map image resource.
  145831. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  145832. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  145833. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  145834. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  145835. * * 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.
  145836. * * 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).
  145837. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  145838. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145839. * @param name defines the name of the mesh
  145840. * @param url defines the url to the height map
  145841. * @param options defines the options used to create the mesh
  145842. * @param scene defines the hosting scene
  145843. * @returns the ground mesh
  145844. * @see https://doc.babylonjs.com/babylon101/height_map
  145845. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  145846. */
  145847. static CreateGroundFromHeightMap(name: string, url: string, options: {
  145848. width?: number;
  145849. height?: number;
  145850. subdivisions?: number;
  145851. minHeight?: number;
  145852. maxHeight?: number;
  145853. colorFilter?: Color3;
  145854. alphaFilter?: number;
  145855. updatable?: boolean;
  145856. onReady?: (mesh: GroundMesh) => void;
  145857. }, scene?: Nullable<Scene>): GroundMesh;
  145858. /**
  145859. * Creates a polygon mesh
  145860. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145861. * * 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
  145862. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145863. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145864. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  145865. * * Remember you can only change the shape positions, not their number when updating a polygon
  145866. * @param name defines the name of the mesh
  145867. * @param options defines the options used to create the mesh
  145868. * @param scene defines the hosting scene
  145869. * @param earcutInjection can be used to inject your own earcut reference
  145870. * @returns the polygon mesh
  145871. */
  145872. static CreatePolygon(name: string, options: {
  145873. shape: Vector3[];
  145874. holes?: Vector3[][];
  145875. depth?: number;
  145876. faceUV?: Vector4[];
  145877. faceColors?: Color4[];
  145878. updatable?: boolean;
  145879. sideOrientation?: number;
  145880. frontUVs?: Vector4;
  145881. backUVs?: Vector4;
  145882. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145883. /**
  145884. * Creates an extruded polygon mesh, with depth in the Y direction.
  145885. * * 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)
  145886. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145887. * @param name defines the name of the mesh
  145888. * @param options defines the options used to create the mesh
  145889. * @param scene defines the hosting scene
  145890. * @param earcutInjection can be used to inject your own earcut reference
  145891. * @returns the polygon mesh
  145892. */
  145893. static ExtrudePolygon(name: string, options: {
  145894. shape: Vector3[];
  145895. holes?: Vector3[][];
  145896. depth?: number;
  145897. faceUV?: Vector4[];
  145898. faceColors?: Color4[];
  145899. updatable?: boolean;
  145900. sideOrientation?: number;
  145901. frontUVs?: Vector4;
  145902. backUVs?: Vector4;
  145903. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145904. /**
  145905. * Creates a tube mesh.
  145906. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145907. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145908. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145909. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145910. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145911. * * 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)
  145912. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145913. * * 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
  145914. * * 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
  145915. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145916. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145917. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145918. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145919. * @param name defines the name of the mesh
  145920. * @param options defines the options used to create the mesh
  145921. * @param scene defines the hosting scene
  145922. * @returns the tube mesh
  145923. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145924. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145925. */
  145926. static CreateTube(name: string, options: {
  145927. path: Vector3[];
  145928. radius?: number;
  145929. tessellation?: number;
  145930. radiusFunction?: {
  145931. (i: number, distance: number): number;
  145932. };
  145933. cap?: number;
  145934. arc?: number;
  145935. updatable?: boolean;
  145936. sideOrientation?: number;
  145937. frontUVs?: Vector4;
  145938. backUVs?: Vector4;
  145939. instance?: Mesh;
  145940. invertUV?: boolean;
  145941. }, scene?: Nullable<Scene>): Mesh;
  145942. /**
  145943. * Creates a polyhedron mesh
  145944. * * 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
  145945. * * The parameter `size` (positive float, default 1) sets the polygon size
  145946. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  145947. * * 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`
  145948. * * 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
  145949. * * 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)`)
  145950. * * 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
  145951. * * 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
  145952. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145953. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145954. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145955. * @param name defines the name of the mesh
  145956. * @param options defines the options used to create the mesh
  145957. * @param scene defines the hosting scene
  145958. * @returns the polyhedron mesh
  145959. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  145960. */
  145961. static CreatePolyhedron(name: string, options: {
  145962. type?: number;
  145963. size?: number;
  145964. sizeX?: number;
  145965. sizeY?: number;
  145966. sizeZ?: number;
  145967. custom?: any;
  145968. faceUV?: Vector4[];
  145969. faceColors?: Color4[];
  145970. flat?: boolean;
  145971. updatable?: boolean;
  145972. sideOrientation?: number;
  145973. frontUVs?: Vector4;
  145974. backUVs?: Vector4;
  145975. }, scene?: Nullable<Scene>): Mesh;
  145976. /**
  145977. * Creates a decal mesh.
  145978. * 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
  145979. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145980. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145981. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145982. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145983. * @param name defines the name of the mesh
  145984. * @param sourceMesh defines the mesh where the decal must be applied
  145985. * @param options defines the options used to create the mesh
  145986. * @param scene defines the hosting scene
  145987. * @returns the decal mesh
  145988. * @see https://doc.babylonjs.com/how_to/decals
  145989. */
  145990. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  145991. position?: Vector3;
  145992. normal?: Vector3;
  145993. size?: Vector3;
  145994. angle?: number;
  145995. }): Mesh;
  145996. }
  145997. }
  145998. declare module BABYLON {
  145999. /**
  146000. * A simplifier interface for future simplification implementations
  146001. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146002. */
  146003. export interface ISimplifier {
  146004. /**
  146005. * Simplification of a given mesh according to the given settings.
  146006. * Since this requires computation, it is assumed that the function runs async.
  146007. * @param settings The settings of the simplification, including quality and distance
  146008. * @param successCallback A callback that will be called after the mesh was simplified.
  146009. * @param errorCallback in case of an error, this callback will be called. optional.
  146010. */
  146011. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  146012. }
  146013. /**
  146014. * Expected simplification settings.
  146015. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  146016. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146017. */
  146018. export interface ISimplificationSettings {
  146019. /**
  146020. * Gets or sets the expected quality
  146021. */
  146022. quality: number;
  146023. /**
  146024. * Gets or sets the distance when this optimized version should be used
  146025. */
  146026. distance: number;
  146027. /**
  146028. * Gets an already optimized mesh
  146029. */
  146030. optimizeMesh?: boolean;
  146031. }
  146032. /**
  146033. * Class used to specify simplification options
  146034. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146035. */
  146036. export class SimplificationSettings implements ISimplificationSettings {
  146037. /** expected quality */
  146038. quality: number;
  146039. /** distance when this optimized version should be used */
  146040. distance: number;
  146041. /** already optimized mesh */
  146042. optimizeMesh?: boolean | undefined;
  146043. /**
  146044. * Creates a SimplificationSettings
  146045. * @param quality expected quality
  146046. * @param distance distance when this optimized version should be used
  146047. * @param optimizeMesh already optimized mesh
  146048. */
  146049. constructor(
  146050. /** expected quality */
  146051. quality: number,
  146052. /** distance when this optimized version should be used */
  146053. distance: number,
  146054. /** already optimized mesh */
  146055. optimizeMesh?: boolean | undefined);
  146056. }
  146057. /**
  146058. * Interface used to define a simplification task
  146059. */
  146060. export interface ISimplificationTask {
  146061. /**
  146062. * Array of settings
  146063. */
  146064. settings: Array<ISimplificationSettings>;
  146065. /**
  146066. * Simplification type
  146067. */
  146068. simplificationType: SimplificationType;
  146069. /**
  146070. * Mesh to simplify
  146071. */
  146072. mesh: Mesh;
  146073. /**
  146074. * Callback called on success
  146075. */
  146076. successCallback?: () => void;
  146077. /**
  146078. * Defines if parallel processing can be used
  146079. */
  146080. parallelProcessing: boolean;
  146081. }
  146082. /**
  146083. * Queue used to order the simplification tasks
  146084. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146085. */
  146086. export class SimplificationQueue {
  146087. private _simplificationArray;
  146088. /**
  146089. * Gets a boolean indicating that the process is still running
  146090. */
  146091. running: boolean;
  146092. /**
  146093. * Creates a new queue
  146094. */
  146095. constructor();
  146096. /**
  146097. * Adds a new simplification task
  146098. * @param task defines a task to add
  146099. */
  146100. addTask(task: ISimplificationTask): void;
  146101. /**
  146102. * Execute next task
  146103. */
  146104. executeNext(): void;
  146105. /**
  146106. * Execute a simplification task
  146107. * @param task defines the task to run
  146108. */
  146109. runSimplification(task: ISimplificationTask): void;
  146110. private getSimplifier;
  146111. }
  146112. /**
  146113. * The implemented types of simplification
  146114. * At the moment only Quadratic Error Decimation is implemented
  146115. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146116. */
  146117. export enum SimplificationType {
  146118. /** Quadratic error decimation */
  146119. QUADRATIC = 0
  146120. }
  146121. /**
  146122. * An implementation of the Quadratic Error simplification algorithm.
  146123. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  146124. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  146125. * @author RaananW
  146126. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146127. */
  146128. export class QuadraticErrorSimplification implements ISimplifier {
  146129. private _mesh;
  146130. private triangles;
  146131. private vertices;
  146132. private references;
  146133. private _reconstructedMesh;
  146134. /** Gets or sets the number pf sync interations */
  146135. syncIterations: number;
  146136. /** Gets or sets the aggressiveness of the simplifier */
  146137. aggressiveness: number;
  146138. /** Gets or sets the number of allowed iterations for decimation */
  146139. decimationIterations: number;
  146140. /** Gets or sets the espilon to use for bounding box computation */
  146141. boundingBoxEpsilon: number;
  146142. /**
  146143. * Creates a new QuadraticErrorSimplification
  146144. * @param _mesh defines the target mesh
  146145. */
  146146. constructor(_mesh: Mesh);
  146147. /**
  146148. * Simplification of a given mesh according to the given settings.
  146149. * Since this requires computation, it is assumed that the function runs async.
  146150. * @param settings The settings of the simplification, including quality and distance
  146151. * @param successCallback A callback that will be called after the mesh was simplified.
  146152. */
  146153. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  146154. private runDecimation;
  146155. private initWithMesh;
  146156. private init;
  146157. private reconstructMesh;
  146158. private initDecimatedMesh;
  146159. private isFlipped;
  146160. private updateTriangles;
  146161. private identifyBorder;
  146162. private updateMesh;
  146163. private vertexError;
  146164. private calculateError;
  146165. }
  146166. }
  146167. declare module BABYLON {
  146168. interface Scene {
  146169. /** @hidden (Backing field) */
  146170. _simplificationQueue: SimplificationQueue;
  146171. /**
  146172. * Gets or sets the simplification queue attached to the scene
  146173. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146174. */
  146175. simplificationQueue: SimplificationQueue;
  146176. }
  146177. interface Mesh {
  146178. /**
  146179. * Simplify the mesh according to the given array of settings.
  146180. * Function will return immediately and will simplify async
  146181. * @param settings a collection of simplification settings
  146182. * @param parallelProcessing should all levels calculate parallel or one after the other
  146183. * @param simplificationType the type of simplification to run
  146184. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  146185. * @returns the current mesh
  146186. */
  146187. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  146188. }
  146189. /**
  146190. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  146191. * created in a scene
  146192. */
  146193. export class SimplicationQueueSceneComponent implements ISceneComponent {
  146194. /**
  146195. * The component name helpfull to identify the component in the list of scene components.
  146196. */
  146197. readonly name: string;
  146198. /**
  146199. * The scene the component belongs to.
  146200. */
  146201. scene: Scene;
  146202. /**
  146203. * Creates a new instance of the component for the given scene
  146204. * @param scene Defines the scene to register the component in
  146205. */
  146206. constructor(scene: Scene);
  146207. /**
  146208. * Registers the component in a given scene
  146209. */
  146210. register(): void;
  146211. /**
  146212. * Rebuilds the elements related to this component in case of
  146213. * context lost for instance.
  146214. */
  146215. rebuild(): void;
  146216. /**
  146217. * Disposes the component and the associated ressources
  146218. */
  146219. dispose(): void;
  146220. private _beforeCameraUpdate;
  146221. }
  146222. }
  146223. declare module BABYLON {
  146224. interface Mesh {
  146225. /**
  146226. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  146227. */
  146228. thinInstanceEnablePicking: boolean;
  146229. /**
  146230. * Creates a new thin instance
  146231. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  146232. * @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
  146233. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  146234. */
  146235. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  146236. /**
  146237. * Adds the transformation (matrix) of the current mesh as a thin instance
  146238. * @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
  146239. * @returns the thin instance index number
  146240. */
  146241. thinInstanceAddSelf(refresh: boolean): number;
  146242. /**
  146243. * Registers a custom attribute to be used with thin instances
  146244. * @param kind name of the attribute
  146245. * @param stride size in floats of the attribute
  146246. */
  146247. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  146248. /**
  146249. * Sets the matrix of a thin instance
  146250. * @param index index of the thin instance
  146251. * @param matrix matrix to set
  146252. * @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
  146253. */
  146254. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  146255. /**
  146256. * Sets the value of a custom attribute for a thin instance
  146257. * @param kind name of the attribute
  146258. * @param index index of the thin instance
  146259. * @param value value to set
  146260. * @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
  146261. */
  146262. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  146263. /**
  146264. * 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.
  146265. */
  146266. thinInstanceCount: number;
  146267. /**
  146268. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  146269. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  146270. * @param buffer buffer to set
  146271. * @param stride size in floats of each value of the buffer
  146272. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  146273. */
  146274. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  146275. /**
  146276. * Gets the list of world matrices
  146277. * @return an array containing all the world matrices from the thin instances
  146278. */
  146279. thinInstanceGetWorldMatrices(): Matrix[];
  146280. /**
  146281. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  146282. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  146283. */
  146284. thinInstanceBufferUpdated(kind: string): void;
  146285. /**
  146286. * Refreshes the bounding info, taking into account all the thin instances defined
  146287. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  146288. */
  146289. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  146290. /** @hidden */
  146291. _thinInstanceInitializeUserStorage(): void;
  146292. /** @hidden */
  146293. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  146294. /** @hidden */
  146295. _userThinInstanceBuffersStorage: {
  146296. data: {
  146297. [key: string]: Float32Array;
  146298. };
  146299. sizes: {
  146300. [key: string]: number;
  146301. };
  146302. vertexBuffers: {
  146303. [key: string]: Nullable<VertexBuffer>;
  146304. };
  146305. strides: {
  146306. [key: string]: number;
  146307. };
  146308. };
  146309. }
  146310. }
  146311. declare module BABYLON {
  146312. /**
  146313. * Navigation plugin interface to add navigation constrained by a navigation mesh
  146314. */
  146315. export interface INavigationEnginePlugin {
  146316. /**
  146317. * plugin name
  146318. */
  146319. name: string;
  146320. /**
  146321. * Creates a navigation mesh
  146322. * @param meshes array of all the geometry used to compute the navigatio mesh
  146323. * @param parameters bunch of parameters used to filter geometry
  146324. */
  146325. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146326. /**
  146327. * Create a navigation mesh debug mesh
  146328. * @param scene is where the mesh will be added
  146329. * @returns debug display mesh
  146330. */
  146331. createDebugNavMesh(scene: Scene): Mesh;
  146332. /**
  146333. * Get a navigation mesh constrained position, closest to the parameter position
  146334. * @param position world position
  146335. * @returns the closest point to position constrained by the navigation mesh
  146336. */
  146337. getClosestPoint(position: Vector3): Vector3;
  146338. /**
  146339. * Get a navigation mesh constrained position, closest to the parameter position
  146340. * @param position world position
  146341. * @param result output the closest point to position constrained by the navigation mesh
  146342. */
  146343. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146344. /**
  146345. * Get a navigation mesh constrained position, within a particular radius
  146346. * @param position world position
  146347. * @param maxRadius the maximum distance to the constrained world position
  146348. * @returns the closest point to position constrained by the navigation mesh
  146349. */
  146350. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146351. /**
  146352. * Get a navigation mesh constrained position, within a particular radius
  146353. * @param position world position
  146354. * @param maxRadius the maximum distance to the constrained world position
  146355. * @param result output the closest point to position constrained by the navigation mesh
  146356. */
  146357. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146358. /**
  146359. * Compute the final position from a segment made of destination-position
  146360. * @param position world position
  146361. * @param destination world position
  146362. * @returns the resulting point along the navmesh
  146363. */
  146364. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146365. /**
  146366. * Compute the final position from a segment made of destination-position
  146367. * @param position world position
  146368. * @param destination world position
  146369. * @param result output the resulting point along the navmesh
  146370. */
  146371. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146372. /**
  146373. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146374. * @param start world position
  146375. * @param end world position
  146376. * @returns array containing world position composing the path
  146377. */
  146378. computePath(start: Vector3, end: Vector3): Vector3[];
  146379. /**
  146380. * If this plugin is supported
  146381. * @returns true if plugin is supported
  146382. */
  146383. isSupported(): boolean;
  146384. /**
  146385. * Create a new Crowd so you can add agents
  146386. * @param maxAgents the maximum agent count in the crowd
  146387. * @param maxAgentRadius the maximum radius an agent can have
  146388. * @param scene to attach the crowd to
  146389. * @returns the crowd you can add agents to
  146390. */
  146391. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146392. /**
  146393. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146394. * The queries will try to find a solution within those bounds
  146395. * default is (1,1,1)
  146396. * @param extent x,y,z value that define the extent around the queries point of reference
  146397. */
  146398. setDefaultQueryExtent(extent: Vector3): void;
  146399. /**
  146400. * Get the Bounding box extent specified by setDefaultQueryExtent
  146401. * @returns the box extent values
  146402. */
  146403. getDefaultQueryExtent(): Vector3;
  146404. /**
  146405. * build the navmesh from a previously saved state using getNavmeshData
  146406. * @param data the Uint8Array returned by getNavmeshData
  146407. */
  146408. buildFromNavmeshData(data: Uint8Array): void;
  146409. /**
  146410. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146411. * @returns data the Uint8Array that can be saved and reused
  146412. */
  146413. getNavmeshData(): Uint8Array;
  146414. /**
  146415. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146416. * @param result output the box extent values
  146417. */
  146418. getDefaultQueryExtentToRef(result: Vector3): void;
  146419. /**
  146420. * Release all resources
  146421. */
  146422. dispose(): void;
  146423. }
  146424. /**
  146425. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  146426. */
  146427. export interface ICrowd {
  146428. /**
  146429. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146430. * You can attach anything to that node. The node position is updated in the scene update tick.
  146431. * @param pos world position that will be constrained by the navigation mesh
  146432. * @param parameters agent parameters
  146433. * @param transform hooked to the agent that will be update by the scene
  146434. * @returns agent index
  146435. */
  146436. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146437. /**
  146438. * Returns the agent position in world space
  146439. * @param index agent index returned by addAgent
  146440. * @returns world space position
  146441. */
  146442. getAgentPosition(index: number): Vector3;
  146443. /**
  146444. * Gets the agent position result in world space
  146445. * @param index agent index returned by addAgent
  146446. * @param result output world space position
  146447. */
  146448. getAgentPositionToRef(index: number, result: Vector3): void;
  146449. /**
  146450. * Gets the agent velocity in world space
  146451. * @param index agent index returned by addAgent
  146452. * @returns world space velocity
  146453. */
  146454. getAgentVelocity(index: number): Vector3;
  146455. /**
  146456. * Gets the agent velocity result in world space
  146457. * @param index agent index returned by addAgent
  146458. * @param result output world space velocity
  146459. */
  146460. getAgentVelocityToRef(index: number, result: Vector3): void;
  146461. /**
  146462. * remove a particular agent previously created
  146463. * @param index agent index returned by addAgent
  146464. */
  146465. removeAgent(index: number): void;
  146466. /**
  146467. * get the list of all agents attached to this crowd
  146468. * @returns list of agent indices
  146469. */
  146470. getAgents(): number[];
  146471. /**
  146472. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146473. * @param deltaTime in seconds
  146474. */
  146475. update(deltaTime: number): void;
  146476. /**
  146477. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146478. * @param index agent index returned by addAgent
  146479. * @param destination targeted world position
  146480. */
  146481. agentGoto(index: number, destination: Vector3): void;
  146482. /**
  146483. * Teleport the agent to a new position
  146484. * @param index agent index returned by addAgent
  146485. * @param destination targeted world position
  146486. */
  146487. agentTeleport(index: number, destination: Vector3): void;
  146488. /**
  146489. * Update agent parameters
  146490. * @param index agent index returned by addAgent
  146491. * @param parameters agent parameters
  146492. */
  146493. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146494. /**
  146495. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146496. * The queries will try to find a solution within those bounds
  146497. * default is (1,1,1)
  146498. * @param extent x,y,z value that define the extent around the queries point of reference
  146499. */
  146500. setDefaultQueryExtent(extent: Vector3): void;
  146501. /**
  146502. * Get the Bounding box extent specified by setDefaultQueryExtent
  146503. * @returns the box extent values
  146504. */
  146505. getDefaultQueryExtent(): Vector3;
  146506. /**
  146507. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146508. * @param result output the box extent values
  146509. */
  146510. getDefaultQueryExtentToRef(result: Vector3): void;
  146511. /**
  146512. * Release all resources
  146513. */
  146514. dispose(): void;
  146515. }
  146516. /**
  146517. * Configures an agent
  146518. */
  146519. export interface IAgentParameters {
  146520. /**
  146521. * Agent radius. [Limit: >= 0]
  146522. */
  146523. radius: number;
  146524. /**
  146525. * Agent height. [Limit: > 0]
  146526. */
  146527. height: number;
  146528. /**
  146529. * Maximum allowed acceleration. [Limit: >= 0]
  146530. */
  146531. maxAcceleration: number;
  146532. /**
  146533. * Maximum allowed speed. [Limit: >= 0]
  146534. */
  146535. maxSpeed: number;
  146536. /**
  146537. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  146538. */
  146539. collisionQueryRange: number;
  146540. /**
  146541. * The path visibility optimization range. [Limit: > 0]
  146542. */
  146543. pathOptimizationRange: number;
  146544. /**
  146545. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  146546. */
  146547. separationWeight: number;
  146548. }
  146549. /**
  146550. * Configures the navigation mesh creation
  146551. */
  146552. export interface INavMeshParameters {
  146553. /**
  146554. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  146555. */
  146556. cs: number;
  146557. /**
  146558. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  146559. */
  146560. ch: number;
  146561. /**
  146562. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  146563. */
  146564. walkableSlopeAngle: number;
  146565. /**
  146566. * Minimum floor to 'ceiling' height that will still allow the floor area to
  146567. * be considered walkable. [Limit: >= 3] [Units: vx]
  146568. */
  146569. walkableHeight: number;
  146570. /**
  146571. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  146572. */
  146573. walkableClimb: number;
  146574. /**
  146575. * The distance to erode/shrink the walkable area of the heightfield away from
  146576. * obstructions. [Limit: >=0] [Units: vx]
  146577. */
  146578. walkableRadius: number;
  146579. /**
  146580. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  146581. */
  146582. maxEdgeLen: number;
  146583. /**
  146584. * The maximum distance a simplfied contour's border edges should deviate
  146585. * the original raw contour. [Limit: >=0] [Units: vx]
  146586. */
  146587. maxSimplificationError: number;
  146588. /**
  146589. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  146590. */
  146591. minRegionArea: number;
  146592. /**
  146593. * Any regions with a span count smaller than this value will, if possible,
  146594. * be merged with larger regions. [Limit: >=0] [Units: vx]
  146595. */
  146596. mergeRegionArea: number;
  146597. /**
  146598. * The maximum number of vertices allowed for polygons generated during the
  146599. * contour to polygon conversion process. [Limit: >= 3]
  146600. */
  146601. maxVertsPerPoly: number;
  146602. /**
  146603. * Sets the sampling distance to use when generating the detail mesh.
  146604. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  146605. */
  146606. detailSampleDist: number;
  146607. /**
  146608. * The maximum distance the detail mesh surface should deviate from heightfield
  146609. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  146610. */
  146611. detailSampleMaxError: number;
  146612. }
  146613. }
  146614. declare module BABYLON {
  146615. /**
  146616. * RecastJS navigation plugin
  146617. */
  146618. export class RecastJSPlugin implements INavigationEnginePlugin {
  146619. /**
  146620. * Reference to the Recast library
  146621. */
  146622. bjsRECAST: any;
  146623. /**
  146624. * plugin name
  146625. */
  146626. name: string;
  146627. /**
  146628. * the first navmesh created. We might extend this to support multiple navmeshes
  146629. */
  146630. navMesh: any;
  146631. /**
  146632. * Initializes the recastJS plugin
  146633. * @param recastInjection can be used to inject your own recast reference
  146634. */
  146635. constructor(recastInjection?: any);
  146636. /**
  146637. * Creates a navigation mesh
  146638. * @param meshes array of all the geometry used to compute the navigatio mesh
  146639. * @param parameters bunch of parameters used to filter geometry
  146640. */
  146641. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146642. /**
  146643. * Create a navigation mesh debug mesh
  146644. * @param scene is where the mesh will be added
  146645. * @returns debug display mesh
  146646. */
  146647. createDebugNavMesh(scene: Scene): Mesh;
  146648. /**
  146649. * Get a navigation mesh constrained position, closest to the parameter position
  146650. * @param position world position
  146651. * @returns the closest point to position constrained by the navigation mesh
  146652. */
  146653. getClosestPoint(position: Vector3): Vector3;
  146654. /**
  146655. * Get a navigation mesh constrained position, closest to the parameter position
  146656. * @param position world position
  146657. * @param result output the closest point to position constrained by the navigation mesh
  146658. */
  146659. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146660. /**
  146661. * Get a navigation mesh constrained position, within a particular radius
  146662. * @param position world position
  146663. * @param maxRadius the maximum distance to the constrained world position
  146664. * @returns the closest point to position constrained by the navigation mesh
  146665. */
  146666. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146667. /**
  146668. * Get a navigation mesh constrained position, within a particular radius
  146669. * @param position world position
  146670. * @param maxRadius the maximum distance to the constrained world position
  146671. * @param result output the closest point to position constrained by the navigation mesh
  146672. */
  146673. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146674. /**
  146675. * Compute the final position from a segment made of destination-position
  146676. * @param position world position
  146677. * @param destination world position
  146678. * @returns the resulting point along the navmesh
  146679. */
  146680. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146681. /**
  146682. * Compute the final position from a segment made of destination-position
  146683. * @param position world position
  146684. * @param destination world position
  146685. * @param result output the resulting point along the navmesh
  146686. */
  146687. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146688. /**
  146689. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146690. * @param start world position
  146691. * @param end world position
  146692. * @returns array containing world position composing the path
  146693. */
  146694. computePath(start: Vector3, end: Vector3): Vector3[];
  146695. /**
  146696. * Create a new Crowd so you can add agents
  146697. * @param maxAgents the maximum agent count in the crowd
  146698. * @param maxAgentRadius the maximum radius an agent can have
  146699. * @param scene to attach the crowd to
  146700. * @returns the crowd you can add agents to
  146701. */
  146702. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146703. /**
  146704. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146705. * The queries will try to find a solution within those bounds
  146706. * default is (1,1,1)
  146707. * @param extent x,y,z value that define the extent around the queries point of reference
  146708. */
  146709. setDefaultQueryExtent(extent: Vector3): void;
  146710. /**
  146711. * Get the Bounding box extent specified by setDefaultQueryExtent
  146712. * @returns the box extent values
  146713. */
  146714. getDefaultQueryExtent(): Vector3;
  146715. /**
  146716. * build the navmesh from a previously saved state using getNavmeshData
  146717. * @param data the Uint8Array returned by getNavmeshData
  146718. */
  146719. buildFromNavmeshData(data: Uint8Array): void;
  146720. /**
  146721. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146722. * @returns data the Uint8Array that can be saved and reused
  146723. */
  146724. getNavmeshData(): Uint8Array;
  146725. /**
  146726. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146727. * @param result output the box extent values
  146728. */
  146729. getDefaultQueryExtentToRef(result: Vector3): void;
  146730. /**
  146731. * Disposes
  146732. */
  146733. dispose(): void;
  146734. /**
  146735. * If this plugin is supported
  146736. * @returns true if plugin is supported
  146737. */
  146738. isSupported(): boolean;
  146739. }
  146740. /**
  146741. * Recast detour crowd implementation
  146742. */
  146743. export class RecastJSCrowd implements ICrowd {
  146744. /**
  146745. * Recast/detour plugin
  146746. */
  146747. bjsRECASTPlugin: RecastJSPlugin;
  146748. /**
  146749. * Link to the detour crowd
  146750. */
  146751. recastCrowd: any;
  146752. /**
  146753. * One transform per agent
  146754. */
  146755. transforms: TransformNode[];
  146756. /**
  146757. * All agents created
  146758. */
  146759. agents: number[];
  146760. /**
  146761. * Link to the scene is kept to unregister the crowd from the scene
  146762. */
  146763. private _scene;
  146764. /**
  146765. * Observer for crowd updates
  146766. */
  146767. private _onBeforeAnimationsObserver;
  146768. /**
  146769. * Constructor
  146770. * @param plugin recastJS plugin
  146771. * @param maxAgents the maximum agent count in the crowd
  146772. * @param maxAgentRadius the maximum radius an agent can have
  146773. * @param scene to attach the crowd to
  146774. * @returns the crowd you can add agents to
  146775. */
  146776. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  146777. /**
  146778. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146779. * You can attach anything to that node. The node position is updated in the scene update tick.
  146780. * @param pos world position that will be constrained by the navigation mesh
  146781. * @param parameters agent parameters
  146782. * @param transform hooked to the agent that will be update by the scene
  146783. * @returns agent index
  146784. */
  146785. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146786. /**
  146787. * Returns the agent position in world space
  146788. * @param index agent index returned by addAgent
  146789. * @returns world space position
  146790. */
  146791. getAgentPosition(index: number): Vector3;
  146792. /**
  146793. * Returns the agent position result in world space
  146794. * @param index agent index returned by addAgent
  146795. * @param result output world space position
  146796. */
  146797. getAgentPositionToRef(index: number, result: Vector3): void;
  146798. /**
  146799. * Returns the agent velocity in world space
  146800. * @param index agent index returned by addAgent
  146801. * @returns world space velocity
  146802. */
  146803. getAgentVelocity(index: number): Vector3;
  146804. /**
  146805. * Returns the agent velocity result in world space
  146806. * @param index agent index returned by addAgent
  146807. * @param result output world space velocity
  146808. */
  146809. getAgentVelocityToRef(index: number, result: Vector3): void;
  146810. /**
  146811. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146812. * @param index agent index returned by addAgent
  146813. * @param destination targeted world position
  146814. */
  146815. agentGoto(index: number, destination: Vector3): void;
  146816. /**
  146817. * Teleport the agent to a new position
  146818. * @param index agent index returned by addAgent
  146819. * @param destination targeted world position
  146820. */
  146821. agentTeleport(index: number, destination: Vector3): void;
  146822. /**
  146823. * Update agent parameters
  146824. * @param index agent index returned by addAgent
  146825. * @param parameters agent parameters
  146826. */
  146827. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146828. /**
  146829. * remove a particular agent previously created
  146830. * @param index agent index returned by addAgent
  146831. */
  146832. removeAgent(index: number): void;
  146833. /**
  146834. * get the list of all agents attached to this crowd
  146835. * @returns list of agent indices
  146836. */
  146837. getAgents(): number[];
  146838. /**
  146839. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146840. * @param deltaTime in seconds
  146841. */
  146842. update(deltaTime: number): void;
  146843. /**
  146844. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146845. * The queries will try to find a solution within those bounds
  146846. * default is (1,1,1)
  146847. * @param extent x,y,z value that define the extent around the queries point of reference
  146848. */
  146849. setDefaultQueryExtent(extent: Vector3): void;
  146850. /**
  146851. * Get the Bounding box extent specified by setDefaultQueryExtent
  146852. * @returns the box extent values
  146853. */
  146854. getDefaultQueryExtent(): Vector3;
  146855. /**
  146856. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146857. * @param result output the box extent values
  146858. */
  146859. getDefaultQueryExtentToRef(result: Vector3): void;
  146860. /**
  146861. * Release all resources
  146862. */
  146863. dispose(): void;
  146864. }
  146865. }
  146866. declare module BABYLON {
  146867. /**
  146868. * Class used to enable access to IndexedDB
  146869. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  146870. */
  146871. export class Database implements IOfflineProvider {
  146872. private _callbackManifestChecked;
  146873. private _currentSceneUrl;
  146874. private _db;
  146875. private _enableSceneOffline;
  146876. private _enableTexturesOffline;
  146877. private _manifestVersionFound;
  146878. private _mustUpdateRessources;
  146879. private _hasReachedQuota;
  146880. private _isSupported;
  146881. private _idbFactory;
  146882. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  146883. private static IsUASupportingBlobStorage;
  146884. /**
  146885. * Gets a boolean indicating if Database storate is enabled (off by default)
  146886. */
  146887. static IDBStorageEnabled: boolean;
  146888. /**
  146889. * Gets a boolean indicating if scene must be saved in the database
  146890. */
  146891. get enableSceneOffline(): boolean;
  146892. /**
  146893. * Gets a boolean indicating if textures must be saved in the database
  146894. */
  146895. get enableTexturesOffline(): boolean;
  146896. /**
  146897. * Creates a new Database
  146898. * @param urlToScene defines the url to load the scene
  146899. * @param callbackManifestChecked defines the callback to use when manifest is checked
  146900. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  146901. */
  146902. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  146903. private static _ParseURL;
  146904. private static _ReturnFullUrlLocation;
  146905. private _checkManifestFile;
  146906. /**
  146907. * Open the database and make it available
  146908. * @param successCallback defines the callback to call on success
  146909. * @param errorCallback defines the callback to call on error
  146910. */
  146911. open(successCallback: () => void, errorCallback: () => void): void;
  146912. /**
  146913. * Loads an image from the database
  146914. * @param url defines the url to load from
  146915. * @param image defines the target DOM image
  146916. */
  146917. loadImage(url: string, image: HTMLImageElement): void;
  146918. private _loadImageFromDBAsync;
  146919. private _saveImageIntoDBAsync;
  146920. private _checkVersionFromDB;
  146921. private _loadVersionFromDBAsync;
  146922. private _saveVersionIntoDBAsync;
  146923. /**
  146924. * Loads a file from database
  146925. * @param url defines the URL to load from
  146926. * @param sceneLoaded defines a callback to call on success
  146927. * @param progressCallBack defines a callback to call when progress changed
  146928. * @param errorCallback defines a callback to call on error
  146929. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  146930. */
  146931. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  146932. private _loadFileAsync;
  146933. private _saveFileAsync;
  146934. /**
  146935. * Validates if xhr data is correct
  146936. * @param xhr defines the request to validate
  146937. * @param dataType defines the expected data type
  146938. * @returns true if data is correct
  146939. */
  146940. private static _ValidateXHRData;
  146941. }
  146942. }
  146943. declare module BABYLON {
  146944. /** @hidden */
  146945. export var gpuUpdateParticlesPixelShader: {
  146946. name: string;
  146947. shader: string;
  146948. };
  146949. }
  146950. declare module BABYLON {
  146951. /** @hidden */
  146952. export var gpuUpdateParticlesVertexShader: {
  146953. name: string;
  146954. shader: string;
  146955. };
  146956. }
  146957. declare module BABYLON {
  146958. /** @hidden */
  146959. export var clipPlaneFragmentDeclaration2: {
  146960. name: string;
  146961. shader: string;
  146962. };
  146963. }
  146964. declare module BABYLON {
  146965. /** @hidden */
  146966. export var gpuRenderParticlesPixelShader: {
  146967. name: string;
  146968. shader: string;
  146969. };
  146970. }
  146971. declare module BABYLON {
  146972. /** @hidden */
  146973. export var clipPlaneVertexDeclaration2: {
  146974. name: string;
  146975. shader: string;
  146976. };
  146977. }
  146978. declare module BABYLON {
  146979. /** @hidden */
  146980. export var gpuRenderParticlesVertexShader: {
  146981. name: string;
  146982. shader: string;
  146983. };
  146984. }
  146985. declare module BABYLON {
  146986. /**
  146987. * This represents a GPU particle system in Babylon
  146988. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  146989. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  146990. */
  146991. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  146992. /**
  146993. * The layer mask we are rendering the particles through.
  146994. */
  146995. layerMask: number;
  146996. private _capacity;
  146997. private _activeCount;
  146998. private _currentActiveCount;
  146999. private _accumulatedCount;
  147000. private _renderEffect;
  147001. private _updateEffect;
  147002. private _buffer0;
  147003. private _buffer1;
  147004. private _spriteBuffer;
  147005. private _updateVAO;
  147006. private _renderVAO;
  147007. private _targetIndex;
  147008. private _sourceBuffer;
  147009. private _targetBuffer;
  147010. private _currentRenderId;
  147011. private _started;
  147012. private _stopped;
  147013. private _timeDelta;
  147014. private _randomTexture;
  147015. private _randomTexture2;
  147016. private _attributesStrideSize;
  147017. private _updateEffectOptions;
  147018. private _randomTextureSize;
  147019. private _actualFrame;
  147020. private _customEffect;
  147021. private readonly _rawTextureWidth;
  147022. /**
  147023. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  147024. */
  147025. static get IsSupported(): boolean;
  147026. /**
  147027. * An event triggered when the system is disposed.
  147028. */
  147029. onDisposeObservable: Observable<IParticleSystem>;
  147030. /**
  147031. * Gets the maximum number of particles active at the same time.
  147032. * @returns The max number of active particles.
  147033. */
  147034. getCapacity(): number;
  147035. /**
  147036. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  147037. * to override the particles.
  147038. */
  147039. forceDepthWrite: boolean;
  147040. /**
  147041. * Gets or set the number of active particles
  147042. */
  147043. get activeParticleCount(): number;
  147044. set activeParticleCount(value: number);
  147045. private _preWarmDone;
  147046. /**
  147047. * Specifies if the particles are updated in emitter local space or world space.
  147048. */
  147049. isLocal: boolean;
  147050. /** Gets or sets a matrix to use to compute projection */
  147051. defaultProjectionMatrix: Matrix;
  147052. /**
  147053. * Is this system ready to be used/rendered
  147054. * @return true if the system is ready
  147055. */
  147056. isReady(): boolean;
  147057. /**
  147058. * Gets if the system has been started. (Note: this will still be true after stop is called)
  147059. * @returns True if it has been started, otherwise false.
  147060. */
  147061. isStarted(): boolean;
  147062. /**
  147063. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  147064. * @returns True if it has been stopped, otherwise false.
  147065. */
  147066. isStopped(): boolean;
  147067. /**
  147068. * Gets a boolean indicating that the system is stopping
  147069. * @returns true if the system is currently stopping
  147070. */
  147071. isStopping(): boolean;
  147072. /**
  147073. * Gets the number of particles active at the same time.
  147074. * @returns The number of active particles.
  147075. */
  147076. getActiveCount(): number;
  147077. /**
  147078. * Starts the particle system and begins to emit
  147079. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  147080. */
  147081. start(delay?: number): void;
  147082. /**
  147083. * Stops the particle system.
  147084. */
  147085. stop(): void;
  147086. /**
  147087. * Remove all active particles
  147088. */
  147089. reset(): void;
  147090. /**
  147091. * Returns the string "GPUParticleSystem"
  147092. * @returns a string containing the class name
  147093. */
  147094. getClassName(): string;
  147095. /**
  147096. * Gets the custom effect used to render the particles
  147097. * @param blendMode Blend mode for which the effect should be retrieved
  147098. * @returns The effect
  147099. */
  147100. getCustomEffect(blendMode?: number): Nullable<Effect>;
  147101. /**
  147102. * Sets the custom effect used to render the particles
  147103. * @param effect The effect to set
  147104. * @param blendMode Blend mode for which the effect should be set
  147105. */
  147106. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  147107. /** @hidden */
  147108. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  147109. /**
  147110. * Observable that will be called just before the particles are drawn
  147111. */
  147112. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  147113. /**
  147114. * Gets the name of the particle vertex shader
  147115. */
  147116. get vertexShaderName(): string;
  147117. private _colorGradientsTexture;
  147118. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  147119. /**
  147120. * Adds a new color gradient
  147121. * @param gradient defines the gradient to use (between 0 and 1)
  147122. * @param color1 defines the color to affect to the specified gradient
  147123. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  147124. * @returns the current particle system
  147125. */
  147126. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  147127. private _refreshColorGradient;
  147128. /** Force the system to rebuild all gradients that need to be resync */
  147129. forceRefreshGradients(): void;
  147130. /**
  147131. * Remove a specific color gradient
  147132. * @param gradient defines the gradient to remove
  147133. * @returns the current particle system
  147134. */
  147135. removeColorGradient(gradient: number): GPUParticleSystem;
  147136. private _angularSpeedGradientsTexture;
  147137. private _sizeGradientsTexture;
  147138. private _velocityGradientsTexture;
  147139. private _limitVelocityGradientsTexture;
  147140. private _dragGradientsTexture;
  147141. private _addFactorGradient;
  147142. /**
  147143. * Adds a new size gradient
  147144. * @param gradient defines the gradient to use (between 0 and 1)
  147145. * @param factor defines the size factor to affect to the specified gradient
  147146. * @returns the current particle system
  147147. */
  147148. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  147149. /**
  147150. * Remove a specific size gradient
  147151. * @param gradient defines the gradient to remove
  147152. * @returns the current particle system
  147153. */
  147154. removeSizeGradient(gradient: number): GPUParticleSystem;
  147155. private _refreshFactorGradient;
  147156. /**
  147157. * Adds a new angular speed gradient
  147158. * @param gradient defines the gradient to use (between 0 and 1)
  147159. * @param factor defines the angular speed to affect to the specified gradient
  147160. * @returns the current particle system
  147161. */
  147162. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  147163. /**
  147164. * Remove a specific angular speed gradient
  147165. * @param gradient defines the gradient to remove
  147166. * @returns the current particle system
  147167. */
  147168. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  147169. /**
  147170. * Adds a new velocity gradient
  147171. * @param gradient defines the gradient to use (between 0 and 1)
  147172. * @param factor defines the velocity to affect to the specified gradient
  147173. * @returns the current particle system
  147174. */
  147175. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147176. /**
  147177. * Remove a specific velocity gradient
  147178. * @param gradient defines the gradient to remove
  147179. * @returns the current particle system
  147180. */
  147181. removeVelocityGradient(gradient: number): GPUParticleSystem;
  147182. /**
  147183. * Adds a new limit velocity gradient
  147184. * @param gradient defines the gradient to use (between 0 and 1)
  147185. * @param factor defines the limit velocity value to affect to the specified gradient
  147186. * @returns the current particle system
  147187. */
  147188. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147189. /**
  147190. * Remove a specific limit velocity gradient
  147191. * @param gradient defines the gradient to remove
  147192. * @returns the current particle system
  147193. */
  147194. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  147195. /**
  147196. * Adds a new drag gradient
  147197. * @param gradient defines the gradient to use (between 0 and 1)
  147198. * @param factor defines the drag value to affect to the specified gradient
  147199. * @returns the current particle system
  147200. */
  147201. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  147202. /**
  147203. * Remove a specific drag gradient
  147204. * @param gradient defines the gradient to remove
  147205. * @returns the current particle system
  147206. */
  147207. removeDragGradient(gradient: number): GPUParticleSystem;
  147208. /**
  147209. * Not supported by GPUParticleSystem
  147210. * @param gradient defines the gradient to use (between 0 and 1)
  147211. * @param factor defines the emit rate value to affect to the specified gradient
  147212. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147213. * @returns the current particle system
  147214. */
  147215. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147216. /**
  147217. * Not supported by GPUParticleSystem
  147218. * @param gradient defines the gradient to remove
  147219. * @returns the current particle system
  147220. */
  147221. removeEmitRateGradient(gradient: number): IParticleSystem;
  147222. /**
  147223. * Not supported by GPUParticleSystem
  147224. * @param gradient defines the gradient to use (between 0 and 1)
  147225. * @param factor defines the start size value to affect to the specified gradient
  147226. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147227. * @returns the current particle system
  147228. */
  147229. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147230. /**
  147231. * Not supported by GPUParticleSystem
  147232. * @param gradient defines the gradient to remove
  147233. * @returns the current particle system
  147234. */
  147235. removeStartSizeGradient(gradient: number): IParticleSystem;
  147236. /**
  147237. * Not supported by GPUParticleSystem
  147238. * @param gradient defines the gradient to use (between 0 and 1)
  147239. * @param min defines the color remap minimal range
  147240. * @param max defines the color remap maximal range
  147241. * @returns the current particle system
  147242. */
  147243. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147244. /**
  147245. * Not supported by GPUParticleSystem
  147246. * @param gradient defines the gradient to remove
  147247. * @returns the current particle system
  147248. */
  147249. removeColorRemapGradient(): IParticleSystem;
  147250. /**
  147251. * Not supported by GPUParticleSystem
  147252. * @param gradient defines the gradient to use (between 0 and 1)
  147253. * @param min defines the alpha remap minimal range
  147254. * @param max defines the alpha remap maximal range
  147255. * @returns the current particle system
  147256. */
  147257. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147258. /**
  147259. * Not supported by GPUParticleSystem
  147260. * @param gradient defines the gradient to remove
  147261. * @returns the current particle system
  147262. */
  147263. removeAlphaRemapGradient(): IParticleSystem;
  147264. /**
  147265. * Not supported by GPUParticleSystem
  147266. * @param gradient defines the gradient to use (between 0 and 1)
  147267. * @param color defines the color to affect to the specified gradient
  147268. * @returns the current particle system
  147269. */
  147270. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  147271. /**
  147272. * Not supported by GPUParticleSystem
  147273. * @param gradient defines the gradient to remove
  147274. * @returns the current particle system
  147275. */
  147276. removeRampGradient(): IParticleSystem;
  147277. /**
  147278. * Not supported by GPUParticleSystem
  147279. * @returns the list of ramp gradients
  147280. */
  147281. getRampGradients(): Nullable<Array<Color3Gradient>>;
  147282. /**
  147283. * Not supported by GPUParticleSystem
  147284. * Gets or sets a boolean indicating that ramp gradients must be used
  147285. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  147286. */
  147287. get useRampGradients(): boolean;
  147288. set useRampGradients(value: boolean);
  147289. /**
  147290. * Not supported by GPUParticleSystem
  147291. * @param gradient defines the gradient to use (between 0 and 1)
  147292. * @param factor defines the life time factor to affect to the specified gradient
  147293. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147294. * @returns the current particle system
  147295. */
  147296. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147297. /**
  147298. * Not supported by GPUParticleSystem
  147299. * @param gradient defines the gradient to remove
  147300. * @returns the current particle system
  147301. */
  147302. removeLifeTimeGradient(gradient: number): IParticleSystem;
  147303. /**
  147304. * Instantiates a GPU particle system.
  147305. * 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.
  147306. * @param name The name of the particle system
  147307. * @param options The options used to create the system
  147308. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  147309. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  147310. * @param customEffect a custom effect used to change the way particles are rendered by default
  147311. */
  147312. constructor(name: string, options: Partial<{
  147313. capacity: number;
  147314. randomTextureSize: number;
  147315. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  147316. protected _reset(): void;
  147317. private _createUpdateVAO;
  147318. private _createRenderVAO;
  147319. private _initialize;
  147320. /** @hidden */
  147321. _recreateUpdateEffect(): void;
  147322. private _getEffect;
  147323. /**
  147324. * Fill the defines array according to the current settings of the particle system
  147325. * @param defines Array to be updated
  147326. * @param blendMode blend mode to take into account when updating the array
  147327. */
  147328. fillDefines(defines: Array<string>, blendMode?: number): void;
  147329. /**
  147330. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  147331. * @param uniforms Uniforms array to fill
  147332. * @param attributes Attributes array to fill
  147333. * @param samplers Samplers array to fill
  147334. */
  147335. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  147336. /** @hidden */
  147337. _recreateRenderEffect(): Effect;
  147338. /**
  147339. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  147340. * @param preWarm defines if we are in the pre-warmimg phase
  147341. */
  147342. animate(preWarm?: boolean): void;
  147343. private _createFactorGradientTexture;
  147344. private _createSizeGradientTexture;
  147345. private _createAngularSpeedGradientTexture;
  147346. private _createVelocityGradientTexture;
  147347. private _createLimitVelocityGradientTexture;
  147348. private _createDragGradientTexture;
  147349. private _createColorGradientTexture;
  147350. /**
  147351. * Renders the particle system in its current state
  147352. * @param preWarm defines if the system should only update the particles but not render them
  147353. * @returns the current number of particles
  147354. */
  147355. render(preWarm?: boolean): number;
  147356. /**
  147357. * Rebuilds the particle system
  147358. */
  147359. rebuild(): void;
  147360. private _releaseBuffers;
  147361. private _releaseVAOs;
  147362. /**
  147363. * Disposes the particle system and free the associated resources
  147364. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  147365. */
  147366. dispose(disposeTexture?: boolean): void;
  147367. /**
  147368. * Clones the particle system.
  147369. * @param name The name of the cloned object
  147370. * @param newEmitter The new emitter to use
  147371. * @returns the cloned particle system
  147372. */
  147373. clone(name: string, newEmitter: any): GPUParticleSystem;
  147374. /**
  147375. * Serializes the particle system to a JSON object
  147376. * @param serializeTexture defines if the texture must be serialized as well
  147377. * @returns the JSON object
  147378. */
  147379. serialize(serializeTexture?: boolean): any;
  147380. /**
  147381. * Parses a JSON object to create a GPU particle system.
  147382. * @param parsedParticleSystem The JSON object to parse
  147383. * @param sceneOrEngine The scene or the engine to create the particle system in
  147384. * @param rootUrl The root url to use to load external dependencies like texture
  147385. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  147386. * @returns the parsed GPU particle system
  147387. */
  147388. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  147389. }
  147390. }
  147391. declare module BABYLON {
  147392. /**
  147393. * Represents a set of particle systems working together to create a specific effect
  147394. */
  147395. export class ParticleSystemSet implements IDisposable {
  147396. /**
  147397. * Gets or sets base Assets URL
  147398. */
  147399. static BaseAssetsUrl: string;
  147400. private _emitterCreationOptions;
  147401. private _emitterNode;
  147402. /**
  147403. * Gets the particle system list
  147404. */
  147405. systems: IParticleSystem[];
  147406. /**
  147407. * Gets the emitter node used with this set
  147408. */
  147409. get emitterNode(): Nullable<TransformNode>;
  147410. /**
  147411. * Creates a new emitter mesh as a sphere
  147412. * @param options defines the options used to create the sphere
  147413. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  147414. * @param scene defines the hosting scene
  147415. */
  147416. setEmitterAsSphere(options: {
  147417. diameter: number;
  147418. segments: number;
  147419. color: Color3;
  147420. }, renderingGroupId: number, scene: Scene): void;
  147421. /**
  147422. * Starts all particle systems of the set
  147423. * @param emitter defines an optional mesh to use as emitter for the particle systems
  147424. */
  147425. start(emitter?: AbstractMesh): void;
  147426. /**
  147427. * Release all associated resources
  147428. */
  147429. dispose(): void;
  147430. /**
  147431. * Serialize the set into a JSON compatible object
  147432. * @param serializeTexture defines if the texture must be serialized as well
  147433. * @returns a JSON compatible representation of the set
  147434. */
  147435. serialize(serializeTexture?: boolean): any;
  147436. /**
  147437. * Parse a new ParticleSystemSet from a serialized source
  147438. * @param data defines a JSON compatible representation of the set
  147439. * @param scene defines the hosting scene
  147440. * @param gpu defines if we want GPU particles or CPU particles
  147441. * @returns a new ParticleSystemSet
  147442. */
  147443. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  147444. }
  147445. }
  147446. declare module BABYLON {
  147447. /**
  147448. * This class is made for on one-liner static method to help creating particle system set.
  147449. */
  147450. export class ParticleHelper {
  147451. /**
  147452. * Gets or sets base Assets URL
  147453. */
  147454. static BaseAssetsUrl: string;
  147455. /** Define the Url to load snippets */
  147456. static SnippetUrl: string;
  147457. /**
  147458. * Create a default particle system that you can tweak
  147459. * @param emitter defines the emitter to use
  147460. * @param capacity defines the system capacity (default is 500 particles)
  147461. * @param scene defines the hosting scene
  147462. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  147463. * @returns the new Particle system
  147464. */
  147465. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  147466. /**
  147467. * This is the main static method (one-liner) of this helper to create different particle systems
  147468. * @param type This string represents the type to the particle system to create
  147469. * @param scene The scene where the particle system should live
  147470. * @param gpu If the system will use gpu
  147471. * @returns the ParticleSystemSet created
  147472. */
  147473. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  147474. /**
  147475. * Static function used to export a particle system to a ParticleSystemSet variable.
  147476. * Please note that the emitter shape is not exported
  147477. * @param systems defines the particle systems to export
  147478. * @returns the created particle system set
  147479. */
  147480. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  147481. /**
  147482. * Creates a particle system from a snippet saved in a remote file
  147483. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  147484. * @param url defines the url to load from
  147485. * @param scene defines the hosting scene
  147486. * @param gpu If the system will use gpu
  147487. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147488. * @returns a promise that will resolve to the new particle system
  147489. */
  147490. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147491. /**
  147492. * Creates a particle system from a snippet saved by the particle system editor
  147493. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  147494. * @param scene defines the hosting scene
  147495. * @param gpu If the system will use gpu
  147496. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147497. * @returns a promise that will resolve to the new particle system
  147498. */
  147499. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147500. }
  147501. }
  147502. declare module BABYLON {
  147503. interface Engine {
  147504. /**
  147505. * Create an effect to use with particle systems.
  147506. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  147507. * the particle system for which you want to create a custom effect in the last parameter
  147508. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  147509. * @param uniformsNames defines a list of attribute names
  147510. * @param samplers defines an array of string used to represent textures
  147511. * @param defines defines the string containing the defines to use to compile the shaders
  147512. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  147513. * @param onCompiled defines a function to call when the effect creation is successful
  147514. * @param onError defines a function to call when the effect creation has failed
  147515. * @param particleSystem the particle system you want to create the effect for
  147516. * @returns the new Effect
  147517. */
  147518. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  147519. }
  147520. interface Mesh {
  147521. /**
  147522. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  147523. * @returns an array of IParticleSystem
  147524. */
  147525. getEmittedParticleSystems(): IParticleSystem[];
  147526. /**
  147527. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  147528. * @returns an array of IParticleSystem
  147529. */
  147530. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  147531. }
  147532. }
  147533. declare module BABYLON {
  147534. /** Defines the 4 color options */
  147535. export enum PointColor {
  147536. /** color value */
  147537. Color = 2,
  147538. /** uv value */
  147539. UV = 1,
  147540. /** random value */
  147541. Random = 0,
  147542. /** stated value */
  147543. Stated = 3
  147544. }
  147545. /**
  147546. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  147547. * 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.
  147548. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  147549. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  147550. *
  147551. * Full documentation here : TO BE ENTERED
  147552. */
  147553. export class PointsCloudSystem implements IDisposable {
  147554. /**
  147555. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  147556. * Example : var p = SPS.particles[i];
  147557. */
  147558. particles: CloudPoint[];
  147559. /**
  147560. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  147561. */
  147562. nbParticles: number;
  147563. /**
  147564. * This a counter for your own usage. It's not set by any SPS functions.
  147565. */
  147566. counter: number;
  147567. /**
  147568. * The PCS name. This name is also given to the underlying mesh.
  147569. */
  147570. name: string;
  147571. /**
  147572. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  147573. */
  147574. mesh: Mesh;
  147575. /**
  147576. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  147577. * Please read :
  147578. */
  147579. vars: any;
  147580. /**
  147581. * @hidden
  147582. */
  147583. _size: number;
  147584. private _scene;
  147585. private _promises;
  147586. private _positions;
  147587. private _indices;
  147588. private _normals;
  147589. private _colors;
  147590. private _uvs;
  147591. private _indices32;
  147592. private _positions32;
  147593. private _colors32;
  147594. private _uvs32;
  147595. private _updatable;
  147596. private _isVisibilityBoxLocked;
  147597. private _alwaysVisible;
  147598. private _groups;
  147599. private _groupCounter;
  147600. private _computeParticleColor;
  147601. private _computeParticleTexture;
  147602. private _computeParticleRotation;
  147603. private _computeBoundingBox;
  147604. private _isReady;
  147605. /**
  147606. * Creates a PCS (Points Cloud System) object
  147607. * @param name (String) is the PCS name, this will be the underlying mesh name
  147608. * @param pointSize (number) is the size for each point
  147609. * @param scene (Scene) is the scene in which the PCS is added
  147610. * @param options defines the options of the PCS e.g.
  147611. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  147612. */
  147613. constructor(name: string, pointSize: number, scene: Scene, options?: {
  147614. updatable?: boolean;
  147615. });
  147616. /**
  147617. * Builds the PCS underlying mesh. Returns a standard Mesh.
  147618. * If no points were added to the PCS, the returned mesh is just a single point.
  147619. * @returns a promise for the created mesh
  147620. */
  147621. buildMeshAsync(): Promise<Mesh>;
  147622. /**
  147623. * @hidden
  147624. */
  147625. private _buildMesh;
  147626. private _addParticle;
  147627. private _randomUnitVector;
  147628. private _getColorIndicesForCoord;
  147629. private _setPointsColorOrUV;
  147630. private _colorFromTexture;
  147631. private _calculateDensity;
  147632. /**
  147633. * Adds points to the PCS in random positions within a unit sphere
  147634. * @param nb (positive integer) the number of particles to be created from this model
  147635. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  147636. * @returns the number of groups in the system
  147637. */
  147638. addPoints(nb: number, pointFunction?: any): number;
  147639. /**
  147640. * Adds points to the PCS from the surface of the model shape
  147641. * @param mesh is any Mesh object that will be used as a surface model for the points
  147642. * @param nb (positive integer) the number of particles to be created from this model
  147643. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147644. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147645. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147646. * @returns the number of groups in the system
  147647. */
  147648. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147649. /**
  147650. * Adds points to the PCS inside the model shape
  147651. * @param mesh is any Mesh object that will be used as a surface model for the points
  147652. * @param nb (positive integer) the number of particles to be created from this model
  147653. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147654. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147655. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147656. * @returns the number of groups in the system
  147657. */
  147658. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147659. /**
  147660. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  147661. * This method calls `updateParticle()` for each particle of the SPS.
  147662. * For an animated SPS, it is usually called within the render loop.
  147663. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  147664. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  147665. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  147666. * @returns the PCS.
  147667. */
  147668. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  147669. /**
  147670. * Disposes the PCS.
  147671. */
  147672. dispose(): void;
  147673. /**
  147674. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  147675. * doc :
  147676. * @returns the PCS.
  147677. */
  147678. refreshVisibleSize(): PointsCloudSystem;
  147679. /**
  147680. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  147681. * @param size the size (float) of the visibility box
  147682. * note : this doesn't lock the PCS mesh bounding box.
  147683. * doc :
  147684. */
  147685. setVisibilityBox(size: number): void;
  147686. /**
  147687. * Gets whether the PCS is always visible or not
  147688. * doc :
  147689. */
  147690. get isAlwaysVisible(): boolean;
  147691. /**
  147692. * Sets the PCS as always visible or not
  147693. * doc :
  147694. */
  147695. set isAlwaysVisible(val: boolean);
  147696. /**
  147697. * Tells to `setParticles()` to compute the particle rotations or not
  147698. * Default value : false. The PCS is faster when it's set to false
  147699. * Note : particle rotations are only applied to parent particles
  147700. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  147701. */
  147702. set computeParticleRotation(val: boolean);
  147703. /**
  147704. * Tells to `setParticles()` to compute the particle colors or not.
  147705. * Default value : true. The PCS is faster when it's set to false.
  147706. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147707. */
  147708. set computeParticleColor(val: boolean);
  147709. set computeParticleTexture(val: boolean);
  147710. /**
  147711. * Gets if `setParticles()` computes the particle colors or not.
  147712. * Default value : false. The PCS is faster when it's set to false.
  147713. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147714. */
  147715. get computeParticleColor(): boolean;
  147716. /**
  147717. * Gets if `setParticles()` computes the particle textures or not.
  147718. * Default value : false. The PCS is faster when it's set to false.
  147719. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  147720. */
  147721. get computeParticleTexture(): boolean;
  147722. /**
  147723. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  147724. */
  147725. set computeBoundingBox(val: boolean);
  147726. /**
  147727. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  147728. */
  147729. get computeBoundingBox(): boolean;
  147730. /**
  147731. * This function does nothing. It may be overwritten to set all the particle first values.
  147732. * The PCS doesn't call this function, you may have to call it by your own.
  147733. * doc :
  147734. */
  147735. initParticles(): void;
  147736. /**
  147737. * This function does nothing. It may be overwritten to recycle a particle
  147738. * The PCS doesn't call this function, you can to call it
  147739. * doc :
  147740. * @param particle The particle to recycle
  147741. * @returns the recycled particle
  147742. */
  147743. recycleParticle(particle: CloudPoint): CloudPoint;
  147744. /**
  147745. * Updates a particle : this function should be overwritten by the user.
  147746. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  147747. * doc :
  147748. * @example : just set a particle position or velocity and recycle conditions
  147749. * @param particle The particle to update
  147750. * @returns the updated particle
  147751. */
  147752. updateParticle(particle: CloudPoint): CloudPoint;
  147753. /**
  147754. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  147755. * This does nothing and may be overwritten by the user.
  147756. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147757. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147758. * @param update the boolean update value actually passed to setParticles()
  147759. */
  147760. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147761. /**
  147762. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  147763. * This will be passed three parameters.
  147764. * This does nothing and may be overwritten by the user.
  147765. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147766. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147767. * @param update the boolean update value actually passed to setParticles()
  147768. */
  147769. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147770. }
  147771. }
  147772. declare module BABYLON {
  147773. /**
  147774. * Represents one particle of a points cloud system.
  147775. */
  147776. export class CloudPoint {
  147777. /**
  147778. * particle global index
  147779. */
  147780. idx: number;
  147781. /**
  147782. * The color of the particle
  147783. */
  147784. color: Nullable<Color4>;
  147785. /**
  147786. * The world space position of the particle.
  147787. */
  147788. position: Vector3;
  147789. /**
  147790. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  147791. */
  147792. rotation: Vector3;
  147793. /**
  147794. * The world space rotation quaternion of the particle.
  147795. */
  147796. rotationQuaternion: Nullable<Quaternion>;
  147797. /**
  147798. * The uv of the particle.
  147799. */
  147800. uv: Nullable<Vector2>;
  147801. /**
  147802. * The current speed of the particle.
  147803. */
  147804. velocity: Vector3;
  147805. /**
  147806. * The pivot point in the particle local space.
  147807. */
  147808. pivot: Vector3;
  147809. /**
  147810. * Must the particle be translated from its pivot point in its local space ?
  147811. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  147812. * Default : false
  147813. */
  147814. translateFromPivot: boolean;
  147815. /**
  147816. * Index of this particle in the global "positions" array (Internal use)
  147817. * @hidden
  147818. */
  147819. _pos: number;
  147820. /**
  147821. * @hidden Index of this particle in the global "indices" array (Internal use)
  147822. */
  147823. _ind: number;
  147824. /**
  147825. * Group this particle belongs to
  147826. */
  147827. _group: PointsGroup;
  147828. /**
  147829. * Group id of this particle
  147830. */
  147831. groupId: number;
  147832. /**
  147833. * Index of the particle in its group id (Internal use)
  147834. */
  147835. idxInGroup: number;
  147836. /**
  147837. * @hidden Particle BoundingInfo object (Internal use)
  147838. */
  147839. _boundingInfo: BoundingInfo;
  147840. /**
  147841. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  147842. */
  147843. _pcs: PointsCloudSystem;
  147844. /**
  147845. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  147846. */
  147847. _stillInvisible: boolean;
  147848. /**
  147849. * @hidden Last computed particle rotation matrix
  147850. */
  147851. _rotationMatrix: number[];
  147852. /**
  147853. * Parent particle Id, if any.
  147854. * Default null.
  147855. */
  147856. parentId: Nullable<number>;
  147857. /**
  147858. * @hidden Internal global position in the PCS.
  147859. */
  147860. _globalPosition: Vector3;
  147861. /**
  147862. * Creates a Point Cloud object.
  147863. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  147864. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  147865. * @param group (PointsGroup) is the group the particle belongs to
  147866. * @param groupId (integer) is the group identifier in the PCS.
  147867. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  147868. * @param pcs defines the PCS it is associated to
  147869. */
  147870. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  147871. /**
  147872. * get point size
  147873. */
  147874. get size(): Vector3;
  147875. /**
  147876. * Set point size
  147877. */
  147878. set size(scale: Vector3);
  147879. /**
  147880. * Legacy support, changed quaternion to rotationQuaternion
  147881. */
  147882. get quaternion(): Nullable<Quaternion>;
  147883. /**
  147884. * Legacy support, changed quaternion to rotationQuaternion
  147885. */
  147886. set quaternion(q: Nullable<Quaternion>);
  147887. /**
  147888. * Returns a boolean. True if the particle intersects a mesh, else false
  147889. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  147890. * @param target is the object (point or mesh) what the intersection is computed against
  147891. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  147892. * @returns true if it intersects
  147893. */
  147894. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  147895. /**
  147896. * get the rotation matrix of the particle
  147897. * @hidden
  147898. */
  147899. getRotationMatrix(m: Matrix): void;
  147900. }
  147901. /**
  147902. * Represents a group of points in a points cloud system
  147903. * * PCS internal tool, don't use it manually.
  147904. */
  147905. export class PointsGroup {
  147906. /**
  147907. * The group id
  147908. * @hidden
  147909. */
  147910. groupID: number;
  147911. /**
  147912. * image data for group (internal use)
  147913. * @hidden
  147914. */
  147915. _groupImageData: Nullable<ArrayBufferView>;
  147916. /**
  147917. * Image Width (internal use)
  147918. * @hidden
  147919. */
  147920. _groupImgWidth: number;
  147921. /**
  147922. * Image Height (internal use)
  147923. * @hidden
  147924. */
  147925. _groupImgHeight: number;
  147926. /**
  147927. * Custom position function (internal use)
  147928. * @hidden
  147929. */
  147930. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  147931. /**
  147932. * density per facet for surface points
  147933. * @hidden
  147934. */
  147935. _groupDensity: number[];
  147936. /**
  147937. * Only when points are colored by texture carries pointer to texture list array
  147938. * @hidden
  147939. */
  147940. _textureNb: number;
  147941. /**
  147942. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  147943. * PCS internal tool, don't use it manually.
  147944. * @hidden
  147945. */
  147946. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  147947. }
  147948. }
  147949. declare module BABYLON {
  147950. interface Scene {
  147951. /** @hidden (Backing field) */
  147952. _physicsEngine: Nullable<IPhysicsEngine>;
  147953. /** @hidden */
  147954. _physicsTimeAccumulator: number;
  147955. /**
  147956. * Gets the current physics engine
  147957. * @returns a IPhysicsEngine or null if none attached
  147958. */
  147959. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  147960. /**
  147961. * Enables physics to the current scene
  147962. * @param gravity defines the scene's gravity for the physics engine
  147963. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  147964. * @return a boolean indicating if the physics engine was initialized
  147965. */
  147966. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  147967. /**
  147968. * Disables and disposes the physics engine associated with the scene
  147969. */
  147970. disablePhysicsEngine(): void;
  147971. /**
  147972. * Gets a boolean indicating if there is an active physics engine
  147973. * @returns a boolean indicating if there is an active physics engine
  147974. */
  147975. isPhysicsEnabled(): boolean;
  147976. /**
  147977. * Deletes a physics compound impostor
  147978. * @param compound defines the compound to delete
  147979. */
  147980. deleteCompoundImpostor(compound: any): void;
  147981. /**
  147982. * An event triggered when physic simulation is about to be run
  147983. */
  147984. onBeforePhysicsObservable: Observable<Scene>;
  147985. /**
  147986. * An event triggered when physic simulation has been done
  147987. */
  147988. onAfterPhysicsObservable: Observable<Scene>;
  147989. }
  147990. interface AbstractMesh {
  147991. /** @hidden */
  147992. _physicsImpostor: Nullable<PhysicsImpostor>;
  147993. /**
  147994. * Gets or sets impostor used for physic simulation
  147995. * @see https://doc.babylonjs.com/features/physics_engine
  147996. */
  147997. physicsImpostor: Nullable<PhysicsImpostor>;
  147998. /**
  147999. * Gets the current physics impostor
  148000. * @see https://doc.babylonjs.com/features/physics_engine
  148001. * @returns a physics impostor or null
  148002. */
  148003. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  148004. /** Apply a physic impulse to the mesh
  148005. * @param force defines the force to apply
  148006. * @param contactPoint defines where to apply the force
  148007. * @returns the current mesh
  148008. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  148009. */
  148010. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  148011. /**
  148012. * Creates a physic joint between two meshes
  148013. * @param otherMesh defines the other mesh to use
  148014. * @param pivot1 defines the pivot to use on this mesh
  148015. * @param pivot2 defines the pivot to use on the other mesh
  148016. * @param options defines additional options (can be plugin dependent)
  148017. * @returns the current mesh
  148018. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  148019. */
  148020. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  148021. /** @hidden */
  148022. _disposePhysicsObserver: Nullable<Observer<Node>>;
  148023. }
  148024. /**
  148025. * Defines the physics engine scene component responsible to manage a physics engine
  148026. */
  148027. export class PhysicsEngineSceneComponent implements ISceneComponent {
  148028. /**
  148029. * The component name helpful to identify the component in the list of scene components.
  148030. */
  148031. readonly name: string;
  148032. /**
  148033. * The scene the component belongs to.
  148034. */
  148035. scene: Scene;
  148036. /**
  148037. * Creates a new instance of the component for the given scene
  148038. * @param scene Defines the scene to register the component in
  148039. */
  148040. constructor(scene: Scene);
  148041. /**
  148042. * Registers the component in a given scene
  148043. */
  148044. register(): void;
  148045. /**
  148046. * Rebuilds the elements related to this component in case of
  148047. * context lost for instance.
  148048. */
  148049. rebuild(): void;
  148050. /**
  148051. * Disposes the component and the associated ressources
  148052. */
  148053. dispose(): void;
  148054. }
  148055. }
  148056. declare module BABYLON {
  148057. /**
  148058. * A helper for physics simulations
  148059. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148060. */
  148061. export class PhysicsHelper {
  148062. private _scene;
  148063. private _physicsEngine;
  148064. /**
  148065. * Initializes the Physics helper
  148066. * @param scene Babylon.js scene
  148067. */
  148068. constructor(scene: Scene);
  148069. /**
  148070. * Applies a radial explosion impulse
  148071. * @param origin the origin of the explosion
  148072. * @param radiusOrEventOptions the radius or the options of radial explosion
  148073. * @param strength the explosion strength
  148074. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148075. * @returns A physics radial explosion event, or null
  148076. */
  148077. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148078. /**
  148079. * Applies a radial explosion force
  148080. * @param origin the origin of the explosion
  148081. * @param radiusOrEventOptions the radius or the options of radial explosion
  148082. * @param strength the explosion strength
  148083. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148084. * @returns A physics radial explosion event, or null
  148085. */
  148086. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148087. /**
  148088. * Creates a gravitational field
  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 gravitational field event, or null
  148094. */
  148095. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  148096. /**
  148097. * Creates a physics updraft event
  148098. * @param origin the origin of the updraft
  148099. * @param radiusOrEventOptions the radius or the options of the updraft
  148100. * @param strength the strength of the updraft
  148101. * @param height the height of the updraft
  148102. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  148103. * @returns A physics updraft event, or null
  148104. */
  148105. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  148106. /**
  148107. * Creates a physics vortex event
  148108. * @param origin the of the vortex
  148109. * @param radiusOrEventOptions the radius or the options of the vortex
  148110. * @param strength the strength of the vortex
  148111. * @param height the height of the vortex
  148112. * @returns a Physics vortex event, or null
  148113. * A physics vortex event or null
  148114. */
  148115. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  148116. }
  148117. /**
  148118. * Represents a physics radial explosion event
  148119. */
  148120. class PhysicsRadialExplosionEvent {
  148121. private _scene;
  148122. private _options;
  148123. private _sphere;
  148124. private _dataFetched;
  148125. /**
  148126. * Initializes a radial explosioin event
  148127. * @param _scene BabylonJS scene
  148128. * @param _options The options for the vortex event
  148129. */
  148130. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  148131. /**
  148132. * Returns the data related to the radial explosion event (sphere).
  148133. * @returns The radial explosion event data
  148134. */
  148135. getData(): PhysicsRadialExplosionEventData;
  148136. /**
  148137. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  148138. * @param impostor A physics imposter
  148139. * @param origin the origin of the explosion
  148140. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  148141. */
  148142. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  148143. /**
  148144. * Triggers affecterd impostors callbacks
  148145. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  148146. */
  148147. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  148148. /**
  148149. * Disposes the sphere.
  148150. * @param force Specifies if the sphere should be disposed by force
  148151. */
  148152. dispose(force?: boolean): void;
  148153. /*** Helpers ***/
  148154. private _prepareSphere;
  148155. private _intersectsWithSphere;
  148156. }
  148157. /**
  148158. * Represents a gravitational field event
  148159. */
  148160. class PhysicsGravitationalFieldEvent {
  148161. private _physicsHelper;
  148162. private _scene;
  148163. private _origin;
  148164. private _options;
  148165. private _tickCallback;
  148166. private _sphere;
  148167. private _dataFetched;
  148168. /**
  148169. * Initializes the physics gravitational field event
  148170. * @param _physicsHelper A physics helper
  148171. * @param _scene BabylonJS scene
  148172. * @param _origin The origin position of the gravitational field event
  148173. * @param _options The options for the vortex event
  148174. */
  148175. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  148176. /**
  148177. * Returns the data related to the gravitational field event (sphere).
  148178. * @returns A gravitational field event
  148179. */
  148180. getData(): PhysicsGravitationalFieldEventData;
  148181. /**
  148182. * Enables the gravitational field.
  148183. */
  148184. enable(): void;
  148185. /**
  148186. * Disables the gravitational field.
  148187. */
  148188. disable(): void;
  148189. /**
  148190. * Disposes the sphere.
  148191. * @param force The force to dispose from the gravitational field event
  148192. */
  148193. dispose(force?: boolean): void;
  148194. private _tick;
  148195. }
  148196. /**
  148197. * Represents a physics updraft event
  148198. */
  148199. class PhysicsUpdraftEvent {
  148200. private _scene;
  148201. private _origin;
  148202. private _options;
  148203. private _physicsEngine;
  148204. private _originTop;
  148205. private _originDirection;
  148206. private _tickCallback;
  148207. private _cylinder;
  148208. private _cylinderPosition;
  148209. private _dataFetched;
  148210. /**
  148211. * Initializes the physics updraft event
  148212. * @param _scene BabylonJS scene
  148213. * @param _origin The origin position of the updraft
  148214. * @param _options The options for the updraft event
  148215. */
  148216. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  148217. /**
  148218. * Returns the data related to the updraft event (cylinder).
  148219. * @returns A physics updraft event
  148220. */
  148221. getData(): PhysicsUpdraftEventData;
  148222. /**
  148223. * Enables the updraft.
  148224. */
  148225. enable(): void;
  148226. /**
  148227. * Disables the updraft.
  148228. */
  148229. disable(): void;
  148230. /**
  148231. * Disposes the cylinder.
  148232. * @param force Specifies if the updraft should be disposed by force
  148233. */
  148234. dispose(force?: boolean): void;
  148235. private getImpostorHitData;
  148236. private _tick;
  148237. /*** Helpers ***/
  148238. private _prepareCylinder;
  148239. private _intersectsWithCylinder;
  148240. }
  148241. /**
  148242. * Represents a physics vortex event
  148243. */
  148244. class PhysicsVortexEvent {
  148245. private _scene;
  148246. private _origin;
  148247. private _options;
  148248. private _physicsEngine;
  148249. private _originTop;
  148250. private _tickCallback;
  148251. private _cylinder;
  148252. private _cylinderPosition;
  148253. private _dataFetched;
  148254. /**
  148255. * Initializes the physics vortex event
  148256. * @param _scene The BabylonJS scene
  148257. * @param _origin The origin position of the vortex
  148258. * @param _options The options for the vortex event
  148259. */
  148260. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  148261. /**
  148262. * Returns the data related to the vortex event (cylinder).
  148263. * @returns The physics vortex event data
  148264. */
  148265. getData(): PhysicsVortexEventData;
  148266. /**
  148267. * Enables the vortex.
  148268. */
  148269. enable(): void;
  148270. /**
  148271. * Disables the cortex.
  148272. */
  148273. disable(): void;
  148274. /**
  148275. * Disposes the sphere.
  148276. * @param force
  148277. */
  148278. dispose(force?: boolean): void;
  148279. private getImpostorHitData;
  148280. private _tick;
  148281. /*** Helpers ***/
  148282. private _prepareCylinder;
  148283. private _intersectsWithCylinder;
  148284. }
  148285. /**
  148286. * Options fot the radial explosion event
  148287. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148288. */
  148289. export class PhysicsRadialExplosionEventOptions {
  148290. /**
  148291. * The radius of the sphere for the radial explosion.
  148292. */
  148293. radius: number;
  148294. /**
  148295. * The strenth of the explosion.
  148296. */
  148297. strength: number;
  148298. /**
  148299. * The strenght of the force in correspondence to the distance of the affected object
  148300. */
  148301. falloff: PhysicsRadialImpulseFalloff;
  148302. /**
  148303. * Sphere options for the radial explosion.
  148304. */
  148305. sphere: {
  148306. segments: number;
  148307. diameter: number;
  148308. };
  148309. /**
  148310. * Sphere options for the radial explosion.
  148311. */
  148312. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  148313. }
  148314. /**
  148315. * Options fot the updraft event
  148316. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148317. */
  148318. export class PhysicsUpdraftEventOptions {
  148319. /**
  148320. * The radius of the cylinder for the vortex
  148321. */
  148322. radius: number;
  148323. /**
  148324. * The strenth of the updraft.
  148325. */
  148326. strength: number;
  148327. /**
  148328. * The height of the cylinder for the updraft.
  148329. */
  148330. height: number;
  148331. /**
  148332. * The mode for the the updraft.
  148333. */
  148334. updraftMode: PhysicsUpdraftMode;
  148335. }
  148336. /**
  148337. * Options fot the vortex event
  148338. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148339. */
  148340. export class PhysicsVortexEventOptions {
  148341. /**
  148342. * The radius of the cylinder for the vortex
  148343. */
  148344. radius: number;
  148345. /**
  148346. * The strenth of the vortex.
  148347. */
  148348. strength: number;
  148349. /**
  148350. * The height of the cylinder for the vortex.
  148351. */
  148352. height: number;
  148353. /**
  148354. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  148355. */
  148356. centripetalForceThreshold: number;
  148357. /**
  148358. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  148359. */
  148360. centripetalForceMultiplier: number;
  148361. /**
  148362. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  148363. */
  148364. centrifugalForceMultiplier: number;
  148365. /**
  148366. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  148367. */
  148368. updraftForceMultiplier: number;
  148369. }
  148370. /**
  148371. * The strenght of the force in correspondence to the distance of the affected object
  148372. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148373. */
  148374. export enum PhysicsRadialImpulseFalloff {
  148375. /** Defines that impulse is constant in strength across it's whole radius */
  148376. Constant = 0,
  148377. /** Defines that impulse gets weaker if it's further from the origin */
  148378. Linear = 1
  148379. }
  148380. /**
  148381. * The strength of the force in correspondence to the distance of the affected object
  148382. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148383. */
  148384. export enum PhysicsUpdraftMode {
  148385. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  148386. Center = 0,
  148387. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  148388. Perpendicular = 1
  148389. }
  148390. /**
  148391. * Interface for a physics hit data
  148392. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148393. */
  148394. export interface PhysicsHitData {
  148395. /**
  148396. * The force applied at the contact point
  148397. */
  148398. force: Vector3;
  148399. /**
  148400. * The contact point
  148401. */
  148402. contactPoint: Vector3;
  148403. /**
  148404. * The distance from the origin to the contact point
  148405. */
  148406. distanceFromOrigin: number;
  148407. }
  148408. /**
  148409. * Interface for radial explosion event data
  148410. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148411. */
  148412. export interface PhysicsRadialExplosionEventData {
  148413. /**
  148414. * A sphere used for the radial explosion event
  148415. */
  148416. sphere: Mesh;
  148417. }
  148418. /**
  148419. * Interface for gravitational field event data
  148420. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148421. */
  148422. export interface PhysicsGravitationalFieldEventData {
  148423. /**
  148424. * A sphere mesh used for the gravitational field event
  148425. */
  148426. sphere: Mesh;
  148427. }
  148428. /**
  148429. * Interface for updraft event data
  148430. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148431. */
  148432. export interface PhysicsUpdraftEventData {
  148433. /**
  148434. * A cylinder used for the updraft event
  148435. */
  148436. cylinder: Mesh;
  148437. }
  148438. /**
  148439. * Interface for vortex event data
  148440. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148441. */
  148442. export interface PhysicsVortexEventData {
  148443. /**
  148444. * A cylinder used for the vortex event
  148445. */
  148446. cylinder: Mesh;
  148447. }
  148448. /**
  148449. * Interface for an affected physics impostor
  148450. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148451. */
  148452. export interface PhysicsAffectedImpostorWithData {
  148453. /**
  148454. * The impostor affected by the effect
  148455. */
  148456. impostor: PhysicsImpostor;
  148457. /**
  148458. * The data about the hit/horce from the explosion
  148459. */
  148460. hitData: PhysicsHitData;
  148461. }
  148462. }
  148463. declare module BABYLON {
  148464. /** @hidden */
  148465. export var blackAndWhitePixelShader: {
  148466. name: string;
  148467. shader: string;
  148468. };
  148469. }
  148470. declare module BABYLON {
  148471. /**
  148472. * Post process used to render in black and white
  148473. */
  148474. export class BlackAndWhitePostProcess extends PostProcess {
  148475. /**
  148476. * Linear about to convert he result to black and white (default: 1)
  148477. */
  148478. degree: number;
  148479. /**
  148480. * Gets a string identifying the name of the class
  148481. * @returns "BlackAndWhitePostProcess" string
  148482. */
  148483. getClassName(): string;
  148484. /**
  148485. * Creates a black and white post process
  148486. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  148487. * @param name The name of the effect.
  148488. * @param options The required width/height ratio to downsize to before computing the render pass.
  148489. * @param camera The camera to apply the render pass to.
  148490. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148491. * @param engine The engine which the post process will be applied. (default: current engine)
  148492. * @param reusable If the post process can be reused on the same frame. (default: false)
  148493. */
  148494. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148495. /** @hidden */
  148496. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  148497. }
  148498. }
  148499. declare module BABYLON {
  148500. /**
  148501. * This represents a set of one or more post processes in Babylon.
  148502. * A post process can be used to apply a shader to a texture after it is rendered.
  148503. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148504. */
  148505. export class PostProcessRenderEffect {
  148506. private _postProcesses;
  148507. private _getPostProcesses;
  148508. private _singleInstance;
  148509. private _cameras;
  148510. private _indicesForCamera;
  148511. /**
  148512. * Name of the effect
  148513. * @hidden
  148514. */
  148515. _name: string;
  148516. /**
  148517. * Instantiates a post process render effect.
  148518. * A post process can be used to apply a shader to a texture after it is rendered.
  148519. * @param engine The engine the effect is tied to
  148520. * @param name The name of the effect
  148521. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  148522. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  148523. */
  148524. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  148525. /**
  148526. * Checks if all the post processes in the effect are supported.
  148527. */
  148528. get isSupported(): boolean;
  148529. /**
  148530. * Updates the current state of the effect
  148531. * @hidden
  148532. */
  148533. _update(): void;
  148534. /**
  148535. * Attaches the effect on cameras
  148536. * @param cameras The camera to attach to.
  148537. * @hidden
  148538. */
  148539. _attachCameras(cameras: Camera): void;
  148540. /**
  148541. * Attaches the effect on cameras
  148542. * @param cameras The camera to attach to.
  148543. * @hidden
  148544. */
  148545. _attachCameras(cameras: Camera[]): void;
  148546. /**
  148547. * Detaches the effect on cameras
  148548. * @param cameras The camera to detatch from.
  148549. * @hidden
  148550. */
  148551. _detachCameras(cameras: Camera): void;
  148552. /**
  148553. * Detatches the effect on cameras
  148554. * @param cameras The camera to detatch from.
  148555. * @hidden
  148556. */
  148557. _detachCameras(cameras: Camera[]): void;
  148558. /**
  148559. * Enables the effect on given cameras
  148560. * @param cameras The camera to enable.
  148561. * @hidden
  148562. */
  148563. _enable(cameras: Camera): void;
  148564. /**
  148565. * Enables the effect on given cameras
  148566. * @param cameras The camera to enable.
  148567. * @hidden
  148568. */
  148569. _enable(cameras: Nullable<Camera[]>): void;
  148570. /**
  148571. * Disables the effect on the given cameras
  148572. * @param cameras The camera to disable.
  148573. * @hidden
  148574. */
  148575. _disable(cameras: Camera): void;
  148576. /**
  148577. * Disables the effect on the given cameras
  148578. * @param cameras The camera to disable.
  148579. * @hidden
  148580. */
  148581. _disable(cameras: Nullable<Camera[]>): void;
  148582. /**
  148583. * Gets a list of the post processes contained in the effect.
  148584. * @param camera The camera to get the post processes on.
  148585. * @returns The list of the post processes in the effect.
  148586. */
  148587. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  148588. }
  148589. }
  148590. declare module BABYLON {
  148591. /** @hidden */
  148592. export var extractHighlightsPixelShader: {
  148593. name: string;
  148594. shader: string;
  148595. };
  148596. }
  148597. declare module BABYLON {
  148598. /**
  148599. * 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.
  148600. */
  148601. export class ExtractHighlightsPostProcess extends PostProcess {
  148602. /**
  148603. * The luminance threshold, pixels below this value will be set to black.
  148604. */
  148605. threshold: number;
  148606. /** @hidden */
  148607. _exposure: number;
  148608. /**
  148609. * Post process which has the input texture to be used when performing highlight extraction
  148610. * @hidden
  148611. */
  148612. _inputPostProcess: Nullable<PostProcess>;
  148613. /**
  148614. * Gets a string identifying the name of the class
  148615. * @returns "ExtractHighlightsPostProcess" string
  148616. */
  148617. getClassName(): string;
  148618. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148619. }
  148620. }
  148621. declare module BABYLON {
  148622. /** @hidden */
  148623. export var bloomMergePixelShader: {
  148624. name: string;
  148625. shader: string;
  148626. };
  148627. }
  148628. declare module BABYLON {
  148629. /**
  148630. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148631. */
  148632. export class BloomMergePostProcess extends PostProcess {
  148633. /** Weight of the bloom to be added to the original input. */
  148634. weight: number;
  148635. /**
  148636. * Gets a string identifying the name of the class
  148637. * @returns "BloomMergePostProcess" string
  148638. */
  148639. getClassName(): string;
  148640. /**
  148641. * Creates a new instance of @see BloomMergePostProcess
  148642. * @param name The name of the effect.
  148643. * @param originalFromInput Post process which's input will be used for the merge.
  148644. * @param blurred Blurred highlights post process which's output will be used.
  148645. * @param weight Weight of the bloom to be added to the original input.
  148646. * @param options The required width/height ratio to downsize to before computing the render pass.
  148647. * @param camera The camera to apply the render pass to.
  148648. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148649. * @param engine The engine which the post process will be applied. (default: current engine)
  148650. * @param reusable If the post process can be reused on the same frame. (default: false)
  148651. * @param textureType Type of textures used when performing the post process. (default: 0)
  148652. * @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)
  148653. */
  148654. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  148655. /** Weight of the bloom to be added to the original input. */
  148656. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148657. }
  148658. }
  148659. declare module BABYLON {
  148660. /**
  148661. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  148662. */
  148663. export class BloomEffect extends PostProcessRenderEffect {
  148664. private bloomScale;
  148665. /**
  148666. * @hidden Internal
  148667. */
  148668. _effects: Array<PostProcess>;
  148669. /**
  148670. * @hidden Internal
  148671. */
  148672. _downscale: ExtractHighlightsPostProcess;
  148673. private _blurX;
  148674. private _blurY;
  148675. private _merge;
  148676. /**
  148677. * The luminance threshold to find bright areas of the image to bloom.
  148678. */
  148679. get threshold(): number;
  148680. set threshold(value: number);
  148681. /**
  148682. * The strength of the bloom.
  148683. */
  148684. get weight(): number;
  148685. set weight(value: number);
  148686. /**
  148687. * Specifies the size of the bloom blur kernel, relative to the final output size
  148688. */
  148689. get kernel(): number;
  148690. set kernel(value: number);
  148691. /**
  148692. * Creates a new instance of @see BloomEffect
  148693. * @param scene The scene the effect belongs to.
  148694. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  148695. * @param bloomKernel The size of the kernel to be used when applying the blur.
  148696. * @param bloomWeight The the strength of bloom.
  148697. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  148698. * @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)
  148699. */
  148700. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  148701. /**
  148702. * Disposes each of the internal effects for a given camera.
  148703. * @param camera The camera to dispose the effect on.
  148704. */
  148705. disposeEffects(camera: Camera): void;
  148706. /**
  148707. * @hidden Internal
  148708. */
  148709. _updateEffects(): void;
  148710. /**
  148711. * Internal
  148712. * @returns if all the contained post processes are ready.
  148713. * @hidden
  148714. */
  148715. _isReady(): boolean;
  148716. }
  148717. }
  148718. declare module BABYLON {
  148719. /** @hidden */
  148720. export var chromaticAberrationPixelShader: {
  148721. name: string;
  148722. shader: string;
  148723. };
  148724. }
  148725. declare module BABYLON {
  148726. /**
  148727. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  148728. */
  148729. export class ChromaticAberrationPostProcess extends PostProcess {
  148730. /**
  148731. * The amount of seperation of rgb channels (default: 30)
  148732. */
  148733. aberrationAmount: number;
  148734. /**
  148735. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  148736. */
  148737. radialIntensity: number;
  148738. /**
  148739. * 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))
  148740. */
  148741. direction: Vector2;
  148742. /**
  148743. * 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))
  148744. */
  148745. centerPosition: Vector2;
  148746. /** The width of the screen to apply the effect on */
  148747. screenWidth: number;
  148748. /** The height of the screen to apply the effect on */
  148749. screenHeight: number;
  148750. /**
  148751. * Gets a string identifying the name of the class
  148752. * @returns "ChromaticAberrationPostProcess" string
  148753. */
  148754. getClassName(): string;
  148755. /**
  148756. * Creates a new instance ChromaticAberrationPostProcess
  148757. * @param name The name of the effect.
  148758. * @param screenWidth The width of the screen to apply the effect on.
  148759. * @param screenHeight The height of the screen to apply the effect on.
  148760. * @param options The required width/height ratio to downsize to before computing the render pass.
  148761. * @param camera The camera to apply the render pass to.
  148762. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148763. * @param engine The engine which the post process will be applied. (default: current engine)
  148764. * @param reusable If the post process can be reused on the same frame. (default: false)
  148765. * @param textureType Type of textures used when performing the post process. (default: 0)
  148766. * @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)
  148767. */
  148768. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148769. /** @hidden */
  148770. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  148771. }
  148772. }
  148773. declare module BABYLON {
  148774. /** @hidden */
  148775. export var circleOfConfusionPixelShader: {
  148776. name: string;
  148777. shader: string;
  148778. };
  148779. }
  148780. declare module BABYLON {
  148781. /**
  148782. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  148783. */
  148784. export class CircleOfConfusionPostProcess extends PostProcess {
  148785. /**
  148786. * 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.
  148787. */
  148788. lensSize: number;
  148789. /**
  148790. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  148791. */
  148792. fStop: number;
  148793. /**
  148794. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  148795. */
  148796. focusDistance: number;
  148797. /**
  148798. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  148799. */
  148800. focalLength: number;
  148801. /**
  148802. * Gets a string identifying the name of the class
  148803. * @returns "CircleOfConfusionPostProcess" string
  148804. */
  148805. getClassName(): string;
  148806. private _depthTexture;
  148807. /**
  148808. * Creates a new instance CircleOfConfusionPostProcess
  148809. * @param name The name of the effect.
  148810. * @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.
  148811. * @param options The required width/height ratio to downsize to before computing the render pass.
  148812. * @param camera The camera to apply the render pass to.
  148813. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148814. * @param engine The engine which the post process will be applied. (default: current engine)
  148815. * @param reusable If the post process can be reused on the same frame. (default: false)
  148816. * @param textureType Type of textures used when performing the post process. (default: 0)
  148817. * @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)
  148818. */
  148819. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148820. /**
  148821. * 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.
  148822. */
  148823. set depthTexture(value: RenderTargetTexture);
  148824. }
  148825. }
  148826. declare module BABYLON {
  148827. /** @hidden */
  148828. export var colorCorrectionPixelShader: {
  148829. name: string;
  148830. shader: string;
  148831. };
  148832. }
  148833. declare module BABYLON {
  148834. /**
  148835. *
  148836. * This post-process allows the modification of rendered colors by using
  148837. * a 'look-up table' (LUT). This effect is also called Color Grading.
  148838. *
  148839. * The object needs to be provided an url to a texture containing the color
  148840. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  148841. * Use an image editing software to tweak the LUT to match your needs.
  148842. *
  148843. * For an example of a color LUT, see here:
  148844. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  148845. * For explanations on color grading, see here:
  148846. * @see http://udn.epicgames.com/Three/ColorGrading.html
  148847. *
  148848. */
  148849. export class ColorCorrectionPostProcess extends PostProcess {
  148850. private _colorTableTexture;
  148851. /**
  148852. * Gets the color table url used to create the LUT texture
  148853. */
  148854. colorTableUrl: string;
  148855. /**
  148856. * Gets a string identifying the name of the class
  148857. * @returns "ColorCorrectionPostProcess" string
  148858. */
  148859. getClassName(): string;
  148860. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148861. /** @hidden */
  148862. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  148863. }
  148864. }
  148865. declare module BABYLON {
  148866. /** @hidden */
  148867. export var convolutionPixelShader: {
  148868. name: string;
  148869. shader: string;
  148870. };
  148871. }
  148872. declare module BABYLON {
  148873. /**
  148874. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  148875. * input texture to perform effects such as edge detection or sharpening
  148876. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  148877. */
  148878. export class ConvolutionPostProcess extends PostProcess {
  148879. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  148880. kernel: number[];
  148881. /**
  148882. * Gets a string identifying the name of the class
  148883. * @returns "ConvolutionPostProcess" string
  148884. */
  148885. getClassName(): string;
  148886. /**
  148887. * Creates a new instance ConvolutionPostProcess
  148888. * @param name The name of the effect.
  148889. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  148890. * @param options The required width/height ratio to downsize to before computing the render pass.
  148891. * @param camera The camera to apply the render pass to.
  148892. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148893. * @param engine The engine which the post process will be applied. (default: current engine)
  148894. * @param reusable If the post process can be reused on the same frame. (default: false)
  148895. * @param textureType Type of textures used when performing the post process. (default: 0)
  148896. */
  148897. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  148898. /** @hidden */
  148899. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  148900. /**
  148901. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148902. */
  148903. static EdgeDetect0Kernel: number[];
  148904. /**
  148905. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148906. */
  148907. static EdgeDetect1Kernel: number[];
  148908. /**
  148909. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148910. */
  148911. static EdgeDetect2Kernel: number[];
  148912. /**
  148913. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148914. */
  148915. static SharpenKernel: number[];
  148916. /**
  148917. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148918. */
  148919. static EmbossKernel: number[];
  148920. /**
  148921. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148922. */
  148923. static GaussianKernel: number[];
  148924. }
  148925. }
  148926. declare module BABYLON {
  148927. /**
  148928. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  148929. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  148930. * based on samples that have a large difference in distance than the center pixel.
  148931. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  148932. */
  148933. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  148934. /**
  148935. * The direction the blur should be applied
  148936. */
  148937. direction: Vector2;
  148938. /**
  148939. * Gets a string identifying the name of the class
  148940. * @returns "DepthOfFieldBlurPostProcess" string
  148941. */
  148942. getClassName(): string;
  148943. /**
  148944. * Creates a new instance CircleOfConfusionPostProcess
  148945. * @param name The name of the effect.
  148946. * @param scene The scene the effect belongs to.
  148947. * @param direction The direction the blur should be applied.
  148948. * @param kernel The size of the kernel used to blur.
  148949. * @param options The required width/height ratio to downsize to before computing the render pass.
  148950. * @param camera The camera to apply the render pass to.
  148951. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  148952. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  148953. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148954. * @param engine The engine which the post process will be applied. (default: current engine)
  148955. * @param reusable If the post process can be reused on the same frame. (default: false)
  148956. * @param textureType Type of textures used when performing the post process. (default: 0)
  148957. * @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)
  148958. */
  148959. 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);
  148960. }
  148961. }
  148962. declare module BABYLON {
  148963. /** @hidden */
  148964. export var depthOfFieldMergePixelShader: {
  148965. name: string;
  148966. shader: string;
  148967. };
  148968. }
  148969. declare module BABYLON {
  148970. /**
  148971. * Options to be set when merging outputs from the default pipeline.
  148972. */
  148973. export class DepthOfFieldMergePostProcessOptions {
  148974. /**
  148975. * The original image to merge on top of
  148976. */
  148977. originalFromInput: PostProcess;
  148978. /**
  148979. * Parameters to perform the merge of the depth of field effect
  148980. */
  148981. depthOfField?: {
  148982. circleOfConfusion: PostProcess;
  148983. blurSteps: Array<PostProcess>;
  148984. };
  148985. /**
  148986. * Parameters to perform the merge of bloom effect
  148987. */
  148988. bloom?: {
  148989. blurred: PostProcess;
  148990. weight: number;
  148991. };
  148992. }
  148993. /**
  148994. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148995. */
  148996. export class DepthOfFieldMergePostProcess extends PostProcess {
  148997. private blurSteps;
  148998. /**
  148999. * Gets a string identifying the name of the class
  149000. * @returns "DepthOfFieldMergePostProcess" string
  149001. */
  149002. getClassName(): string;
  149003. /**
  149004. * Creates a new instance of DepthOfFieldMergePostProcess
  149005. * @param name The name of the effect.
  149006. * @param originalFromInput Post process which's input will be used for the merge.
  149007. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  149008. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  149009. * @param options The required width/height ratio to downsize to before computing the render pass.
  149010. * @param camera The camera to apply the render pass to.
  149011. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149012. * @param engine The engine which the post process will be applied. (default: current engine)
  149013. * @param reusable If the post process can be reused on the same frame. (default: false)
  149014. * @param textureType Type of textures used when performing the post process. (default: 0)
  149015. * @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)
  149016. */
  149017. 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);
  149018. /**
  149019. * Updates the effect with the current post process compile time values and recompiles the shader.
  149020. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  149021. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  149022. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  149023. * @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
  149024. * @param onCompiled Called when the shader has been compiled.
  149025. * @param onError Called if there is an error when compiling a shader.
  149026. */
  149027. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  149028. }
  149029. }
  149030. declare module BABYLON {
  149031. /**
  149032. * Specifies the level of max blur that should be applied when using the depth of field effect
  149033. */
  149034. export enum DepthOfFieldEffectBlurLevel {
  149035. /**
  149036. * Subtle blur
  149037. */
  149038. Low = 0,
  149039. /**
  149040. * Medium blur
  149041. */
  149042. Medium = 1,
  149043. /**
  149044. * Large blur
  149045. */
  149046. High = 2
  149047. }
  149048. /**
  149049. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  149050. */
  149051. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  149052. private _circleOfConfusion;
  149053. /**
  149054. * @hidden Internal, blurs from high to low
  149055. */
  149056. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  149057. private _depthOfFieldBlurY;
  149058. private _dofMerge;
  149059. /**
  149060. * @hidden Internal post processes in depth of field effect
  149061. */
  149062. _effects: Array<PostProcess>;
  149063. /**
  149064. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  149065. */
  149066. set focalLength(value: number);
  149067. get focalLength(): number;
  149068. /**
  149069. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  149070. */
  149071. set fStop(value: number);
  149072. get fStop(): number;
  149073. /**
  149074. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  149075. */
  149076. set focusDistance(value: number);
  149077. get focusDistance(): number;
  149078. /**
  149079. * 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.
  149080. */
  149081. set lensSize(value: number);
  149082. get lensSize(): number;
  149083. /**
  149084. * Creates a new instance DepthOfFieldEffect
  149085. * @param scene The scene the effect belongs to.
  149086. * @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.
  149087. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  149088. * @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)
  149089. */
  149090. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  149091. /**
  149092. * Get the current class name of the current effet
  149093. * @returns "DepthOfFieldEffect"
  149094. */
  149095. getClassName(): string;
  149096. /**
  149097. * 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.
  149098. */
  149099. set depthTexture(value: RenderTargetTexture);
  149100. /**
  149101. * Disposes each of the internal effects for a given camera.
  149102. * @param camera The camera to dispose the effect on.
  149103. */
  149104. disposeEffects(camera: Camera): void;
  149105. /**
  149106. * @hidden Internal
  149107. */
  149108. _updateEffects(): void;
  149109. /**
  149110. * Internal
  149111. * @returns if all the contained post processes are ready.
  149112. * @hidden
  149113. */
  149114. _isReady(): boolean;
  149115. }
  149116. }
  149117. declare module BABYLON {
  149118. /** @hidden */
  149119. export var displayPassPixelShader: {
  149120. name: string;
  149121. shader: string;
  149122. };
  149123. }
  149124. declare module BABYLON {
  149125. /**
  149126. * DisplayPassPostProcess which produces an output the same as it's input
  149127. */
  149128. export class DisplayPassPostProcess extends PostProcess {
  149129. /**
  149130. * Gets a string identifying the name of the class
  149131. * @returns "DisplayPassPostProcess" string
  149132. */
  149133. getClassName(): string;
  149134. /**
  149135. * Creates the DisplayPassPostProcess
  149136. * @param name The name of the effect.
  149137. * @param options The required width/height ratio to downsize to before computing the render pass.
  149138. * @param camera The camera to apply the render pass to.
  149139. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149140. * @param engine The engine which the post process will be applied. (default: current engine)
  149141. * @param reusable If the post process can be reused on the same frame. (default: false)
  149142. */
  149143. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149144. /** @hidden */
  149145. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  149146. }
  149147. }
  149148. declare module BABYLON {
  149149. /** @hidden */
  149150. export var filterPixelShader: {
  149151. name: string;
  149152. shader: string;
  149153. };
  149154. }
  149155. declare module BABYLON {
  149156. /**
  149157. * Applies a kernel filter to the image
  149158. */
  149159. export class FilterPostProcess extends PostProcess {
  149160. /** The matrix to be applied to the image */
  149161. kernelMatrix: Matrix;
  149162. /**
  149163. * Gets a string identifying the name of the class
  149164. * @returns "FilterPostProcess" string
  149165. */
  149166. getClassName(): string;
  149167. /**
  149168. *
  149169. * @param name The name of the effect.
  149170. * @param kernelMatrix The matrix to be applied to the image
  149171. * @param options The required width/height ratio to downsize to before computing the render pass.
  149172. * @param camera The camera to apply the render pass to.
  149173. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149174. * @param engine The engine which the post process will be applied. (default: current engine)
  149175. * @param reusable If the post process can be reused on the same frame. (default: false)
  149176. */
  149177. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149178. /** @hidden */
  149179. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  149180. }
  149181. }
  149182. declare module BABYLON {
  149183. /** @hidden */
  149184. export var fxaaPixelShader: {
  149185. name: string;
  149186. shader: string;
  149187. };
  149188. }
  149189. declare module BABYLON {
  149190. /** @hidden */
  149191. export var fxaaVertexShader: {
  149192. name: string;
  149193. shader: string;
  149194. };
  149195. }
  149196. declare module BABYLON {
  149197. /**
  149198. * Fxaa post process
  149199. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  149200. */
  149201. export class FxaaPostProcess extends PostProcess {
  149202. /**
  149203. * Gets a string identifying the name of the class
  149204. * @returns "FxaaPostProcess" string
  149205. */
  149206. getClassName(): string;
  149207. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149208. private _getDefines;
  149209. /** @hidden */
  149210. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  149211. }
  149212. }
  149213. declare module BABYLON {
  149214. /** @hidden */
  149215. export var grainPixelShader: {
  149216. name: string;
  149217. shader: string;
  149218. };
  149219. }
  149220. declare module BABYLON {
  149221. /**
  149222. * The GrainPostProcess adds noise to the image at mid luminance levels
  149223. */
  149224. export class GrainPostProcess extends PostProcess {
  149225. /**
  149226. * The intensity of the grain added (default: 30)
  149227. */
  149228. intensity: number;
  149229. /**
  149230. * If the grain should be randomized on every frame
  149231. */
  149232. animated: boolean;
  149233. /**
  149234. * Gets a string identifying the name of the class
  149235. * @returns "GrainPostProcess" string
  149236. */
  149237. getClassName(): string;
  149238. /**
  149239. * Creates a new instance of @see GrainPostProcess
  149240. * @param name The name of the effect.
  149241. * @param options The required width/height ratio to downsize to before computing the render pass.
  149242. * @param camera The camera to apply the render pass to.
  149243. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149244. * @param engine The engine which the post process will be applied. (default: current engine)
  149245. * @param reusable If the post process can be reused on the same frame. (default: false)
  149246. * @param textureType Type of textures used when performing the post process. (default: 0)
  149247. * @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)
  149248. */
  149249. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149250. /** @hidden */
  149251. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  149252. }
  149253. }
  149254. declare module BABYLON {
  149255. /** @hidden */
  149256. export var highlightsPixelShader: {
  149257. name: string;
  149258. shader: string;
  149259. };
  149260. }
  149261. declare module BABYLON {
  149262. /**
  149263. * Extracts highlights from the image
  149264. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149265. */
  149266. export class HighlightsPostProcess extends PostProcess {
  149267. /**
  149268. * Gets a string identifying the name of the class
  149269. * @returns "HighlightsPostProcess" string
  149270. */
  149271. getClassName(): string;
  149272. /**
  149273. * Extracts highlights from the image
  149274. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149275. * @param name The name of the effect.
  149276. * @param options The required width/height ratio to downsize to before computing the render pass.
  149277. * @param camera The camera to apply the render pass to.
  149278. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149279. * @param engine The engine which the post process will be applied. (default: current engine)
  149280. * @param reusable If the post process can be reused on the same frame. (default: false)
  149281. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  149282. */
  149283. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149284. }
  149285. }
  149286. declare module BABYLON {
  149287. /** @hidden */
  149288. export var mrtFragmentDeclaration: {
  149289. name: string;
  149290. shader: string;
  149291. };
  149292. }
  149293. declare module BABYLON {
  149294. /** @hidden */
  149295. export var geometryPixelShader: {
  149296. name: string;
  149297. shader: string;
  149298. };
  149299. }
  149300. declare module BABYLON {
  149301. /** @hidden */
  149302. export var geometryVertexShader: {
  149303. name: string;
  149304. shader: string;
  149305. };
  149306. }
  149307. declare module BABYLON {
  149308. /** @hidden */
  149309. interface ISavedTransformationMatrix {
  149310. world: Matrix;
  149311. viewProjection: Matrix;
  149312. }
  149313. /**
  149314. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  149315. */
  149316. export class GeometryBufferRenderer {
  149317. /**
  149318. * Constant used to retrieve the position texture index in the G-Buffer textures array
  149319. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  149320. */
  149321. static readonly POSITION_TEXTURE_TYPE: number;
  149322. /**
  149323. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  149324. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  149325. */
  149326. static readonly VELOCITY_TEXTURE_TYPE: number;
  149327. /**
  149328. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  149329. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  149330. */
  149331. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  149332. /**
  149333. * Dictionary used to store the previous transformation matrices of each rendered mesh
  149334. * in order to compute objects velocities when enableVelocity is set to "true"
  149335. * @hidden
  149336. */
  149337. _previousTransformationMatrices: {
  149338. [index: number]: ISavedTransformationMatrix;
  149339. };
  149340. /**
  149341. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  149342. * in order to compute objects velocities when enableVelocity is set to "true"
  149343. * @hidden
  149344. */
  149345. _previousBonesTransformationMatrices: {
  149346. [index: number]: Float32Array;
  149347. };
  149348. /**
  149349. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  149350. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  149351. */
  149352. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  149353. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  149354. renderTransparentMeshes: boolean;
  149355. private _scene;
  149356. private _resizeObserver;
  149357. private _multiRenderTarget;
  149358. private _ratio;
  149359. private _enablePosition;
  149360. private _enableVelocity;
  149361. private _enableReflectivity;
  149362. private _positionIndex;
  149363. private _velocityIndex;
  149364. private _reflectivityIndex;
  149365. protected _effect: Effect;
  149366. protected _cachedDefines: string;
  149367. /**
  149368. * Set the render list (meshes to be rendered) used in the G buffer.
  149369. */
  149370. set renderList(meshes: Mesh[]);
  149371. /**
  149372. * Gets wether or not G buffer are supported by the running hardware.
  149373. * This requires draw buffer supports
  149374. */
  149375. get isSupported(): boolean;
  149376. /**
  149377. * Returns the index of the given texture type in the G-Buffer textures array
  149378. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  149379. * @returns the index of the given texture type in the G-Buffer textures array
  149380. */
  149381. getTextureIndex(textureType: number): number;
  149382. /**
  149383. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  149384. */
  149385. get enablePosition(): boolean;
  149386. /**
  149387. * Sets whether or not objects positions are enabled for the G buffer.
  149388. */
  149389. set enablePosition(enable: boolean);
  149390. /**
  149391. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  149392. */
  149393. get enableVelocity(): boolean;
  149394. /**
  149395. * Sets wether or not objects velocities are enabled for the G buffer.
  149396. */
  149397. set enableVelocity(enable: boolean);
  149398. /**
  149399. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  149400. */
  149401. get enableReflectivity(): boolean;
  149402. /**
  149403. * Sets wether or not objects roughness are enabled for the G buffer.
  149404. */
  149405. set enableReflectivity(enable: boolean);
  149406. /**
  149407. * Gets the scene associated with the buffer.
  149408. */
  149409. get scene(): Scene;
  149410. /**
  149411. * Gets the ratio used by the buffer during its creation.
  149412. * How big is the buffer related to the main canvas.
  149413. */
  149414. get ratio(): number;
  149415. /** @hidden */
  149416. static _SceneComponentInitialization: (scene: Scene) => void;
  149417. /**
  149418. * Creates a new G Buffer for the scene
  149419. * @param scene The scene the buffer belongs to
  149420. * @param ratio How big is the buffer related to the main canvas.
  149421. */
  149422. constructor(scene: Scene, ratio?: number);
  149423. /**
  149424. * Checks wether everything is ready to render a submesh to the G buffer.
  149425. * @param subMesh the submesh to check readiness for
  149426. * @param useInstances is the mesh drawn using instance or not
  149427. * @returns true if ready otherwise false
  149428. */
  149429. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  149430. /**
  149431. * Gets the current underlying G Buffer.
  149432. * @returns the buffer
  149433. */
  149434. getGBuffer(): MultiRenderTarget;
  149435. /**
  149436. * Gets the number of samples used to render the buffer (anti aliasing).
  149437. */
  149438. get samples(): number;
  149439. /**
  149440. * Sets the number of samples used to render the buffer (anti aliasing).
  149441. */
  149442. set samples(value: number);
  149443. /**
  149444. * Disposes the renderer and frees up associated resources.
  149445. */
  149446. dispose(): void;
  149447. protected _createRenderTargets(): void;
  149448. private _copyBonesTransformationMatrices;
  149449. }
  149450. }
  149451. declare module BABYLON {
  149452. interface Scene {
  149453. /** @hidden (Backing field) */
  149454. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149455. /**
  149456. * Gets or Sets the current geometry buffer associated to the scene.
  149457. */
  149458. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149459. /**
  149460. * Enables a GeometryBufferRender and associates it with the scene
  149461. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  149462. * @returns the GeometryBufferRenderer
  149463. */
  149464. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  149465. /**
  149466. * Disables the GeometryBufferRender associated with the scene
  149467. */
  149468. disableGeometryBufferRenderer(): void;
  149469. }
  149470. /**
  149471. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  149472. * in several rendering techniques.
  149473. */
  149474. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  149475. /**
  149476. * The component name helpful to identify the component in the list of scene components.
  149477. */
  149478. readonly name: string;
  149479. /**
  149480. * The scene the component belongs to.
  149481. */
  149482. scene: Scene;
  149483. /**
  149484. * Creates a new instance of the component for the given scene
  149485. * @param scene Defines the scene to register the component in
  149486. */
  149487. constructor(scene: Scene);
  149488. /**
  149489. * Registers the component in a given scene
  149490. */
  149491. register(): void;
  149492. /**
  149493. * Rebuilds the elements related to this component in case of
  149494. * context lost for instance.
  149495. */
  149496. rebuild(): void;
  149497. /**
  149498. * Disposes the component and the associated ressources
  149499. */
  149500. dispose(): void;
  149501. private _gatherRenderTargets;
  149502. }
  149503. }
  149504. declare module BABYLON {
  149505. /** @hidden */
  149506. export var motionBlurPixelShader: {
  149507. name: string;
  149508. shader: string;
  149509. };
  149510. }
  149511. declare module BABYLON {
  149512. /**
  149513. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  149514. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  149515. * As an example, all you have to do is to create the post-process:
  149516. * var mb = new BABYLON.MotionBlurPostProcess(
  149517. * 'mb', // The name of the effect.
  149518. * scene, // The scene containing the objects to blur according to their velocity.
  149519. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  149520. * camera // The camera to apply the render pass to.
  149521. * );
  149522. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  149523. */
  149524. export class MotionBlurPostProcess extends PostProcess {
  149525. /**
  149526. * Defines how much the image is blurred by the movement. Default value is equal to 1
  149527. */
  149528. motionStrength: number;
  149529. /**
  149530. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  149531. */
  149532. get motionBlurSamples(): number;
  149533. /**
  149534. * Sets the number of iterations to be used for motion blur quality
  149535. */
  149536. set motionBlurSamples(samples: number);
  149537. private _motionBlurSamples;
  149538. private _geometryBufferRenderer;
  149539. /**
  149540. * Gets a string identifying the name of the class
  149541. * @returns "MotionBlurPostProcess" string
  149542. */
  149543. getClassName(): string;
  149544. /**
  149545. * Creates a new instance MotionBlurPostProcess
  149546. * @param name The name of the effect.
  149547. * @param scene The scene containing the objects to blur according to their velocity.
  149548. * @param options The required width/height ratio to downsize to before computing the render pass.
  149549. * @param camera The camera to apply the render pass to.
  149550. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149551. * @param engine The engine which the post process will be applied. (default: current engine)
  149552. * @param reusable If the post process can be reused on the same frame. (default: false)
  149553. * @param textureType Type of textures used when performing the post process. (default: 0)
  149554. * @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)
  149555. */
  149556. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149557. /**
  149558. * Excludes the given skinned mesh from computing bones velocities.
  149559. * 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.
  149560. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  149561. */
  149562. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149563. /**
  149564. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  149565. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  149566. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  149567. */
  149568. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149569. /**
  149570. * Disposes the post process.
  149571. * @param camera The camera to dispose the post process on.
  149572. */
  149573. dispose(camera?: Camera): void;
  149574. /** @hidden */
  149575. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  149576. }
  149577. }
  149578. declare module BABYLON {
  149579. /** @hidden */
  149580. export var refractionPixelShader: {
  149581. name: string;
  149582. shader: string;
  149583. };
  149584. }
  149585. declare module BABYLON {
  149586. /**
  149587. * Post process which applies a refractin texture
  149588. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149589. */
  149590. export class RefractionPostProcess extends PostProcess {
  149591. private _refTexture;
  149592. private _ownRefractionTexture;
  149593. /** the base color of the refraction (used to taint the rendering) */
  149594. color: Color3;
  149595. /** simulated refraction depth */
  149596. depth: number;
  149597. /** the coefficient of the base color (0 to remove base color tainting) */
  149598. colorLevel: number;
  149599. /** Gets the url used to load the refraction texture */
  149600. refractionTextureUrl: string;
  149601. /**
  149602. * Gets or sets the refraction texture
  149603. * Please note that you are responsible for disposing the texture if you set it manually
  149604. */
  149605. get refractionTexture(): Texture;
  149606. set refractionTexture(value: Texture);
  149607. /**
  149608. * Gets a string identifying the name of the class
  149609. * @returns "RefractionPostProcess" string
  149610. */
  149611. getClassName(): string;
  149612. /**
  149613. * Initializes the RefractionPostProcess
  149614. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149615. * @param name The name of the effect.
  149616. * @param refractionTextureUrl Url of the refraction texture to use
  149617. * @param color the base color of the refraction (used to taint the rendering)
  149618. * @param depth simulated refraction depth
  149619. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  149620. * @param camera The camera to apply the render pass to.
  149621. * @param options The required width/height ratio to downsize to before computing the render pass.
  149622. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149623. * @param engine The engine which the post process will be applied. (default: current engine)
  149624. * @param reusable If the post process can be reused on the same frame. (default: false)
  149625. */
  149626. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149627. /**
  149628. * Disposes of the post process
  149629. * @param camera Camera to dispose post process on
  149630. */
  149631. dispose(camera: Camera): void;
  149632. /** @hidden */
  149633. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  149634. }
  149635. }
  149636. declare module BABYLON {
  149637. /** @hidden */
  149638. export var sharpenPixelShader: {
  149639. name: string;
  149640. shader: string;
  149641. };
  149642. }
  149643. declare module BABYLON {
  149644. /**
  149645. * The SharpenPostProcess applies a sharpen kernel to every pixel
  149646. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  149647. */
  149648. export class SharpenPostProcess extends PostProcess {
  149649. /**
  149650. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  149651. */
  149652. colorAmount: number;
  149653. /**
  149654. * How much sharpness should be applied (default: 0.3)
  149655. */
  149656. edgeAmount: number;
  149657. /**
  149658. * Gets a string identifying the name of the class
  149659. * @returns "SharpenPostProcess" string
  149660. */
  149661. getClassName(): string;
  149662. /**
  149663. * Creates a new instance ConvolutionPostProcess
  149664. * @param name The name of the effect.
  149665. * @param options The required width/height ratio to downsize to before computing the render pass.
  149666. * @param camera The camera to apply the render pass to.
  149667. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149668. * @param engine The engine which the post process will be applied. (default: current engine)
  149669. * @param reusable If the post process can be reused on the same frame. (default: false)
  149670. * @param textureType Type of textures used when performing the post process. (default: 0)
  149671. * @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)
  149672. */
  149673. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149674. /** @hidden */
  149675. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  149676. }
  149677. }
  149678. declare module BABYLON {
  149679. /**
  149680. * PostProcessRenderPipeline
  149681. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149682. */
  149683. export class PostProcessRenderPipeline {
  149684. private engine;
  149685. private _renderEffects;
  149686. private _renderEffectsForIsolatedPass;
  149687. /**
  149688. * List of inspectable custom properties (used by the Inspector)
  149689. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  149690. */
  149691. inspectableCustomProperties: IInspectable[];
  149692. /**
  149693. * @hidden
  149694. */
  149695. protected _cameras: Camera[];
  149696. /** @hidden */
  149697. _name: string;
  149698. /**
  149699. * Gets pipeline name
  149700. */
  149701. get name(): string;
  149702. /** Gets the list of attached cameras */
  149703. get cameras(): Camera[];
  149704. /**
  149705. * Initializes a PostProcessRenderPipeline
  149706. * @param engine engine to add the pipeline to
  149707. * @param name name of the pipeline
  149708. */
  149709. constructor(engine: Engine, name: string);
  149710. /**
  149711. * Gets the class name
  149712. * @returns "PostProcessRenderPipeline"
  149713. */
  149714. getClassName(): string;
  149715. /**
  149716. * If all the render effects in the pipeline are supported
  149717. */
  149718. get isSupported(): boolean;
  149719. /**
  149720. * Adds an effect to the pipeline
  149721. * @param renderEffect the effect to add
  149722. */
  149723. addEffect(renderEffect: PostProcessRenderEffect): void;
  149724. /** @hidden */
  149725. _rebuild(): void;
  149726. /** @hidden */
  149727. _enableEffect(renderEffectName: string, cameras: Camera): void;
  149728. /** @hidden */
  149729. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  149730. /** @hidden */
  149731. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149732. /** @hidden */
  149733. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149734. /** @hidden */
  149735. _attachCameras(cameras: Camera, unique: boolean): void;
  149736. /** @hidden */
  149737. _attachCameras(cameras: Camera[], unique: boolean): void;
  149738. /** @hidden */
  149739. _detachCameras(cameras: Camera): void;
  149740. /** @hidden */
  149741. _detachCameras(cameras: Nullable<Camera[]>): void;
  149742. /** @hidden */
  149743. _update(): void;
  149744. /** @hidden */
  149745. _reset(): void;
  149746. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  149747. /**
  149748. * Sets the required values to the prepass renderer.
  149749. * @param prePassRenderer defines the prepass renderer to setup.
  149750. * @returns true if the pre pass is needed.
  149751. */
  149752. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  149753. /**
  149754. * Disposes of the pipeline
  149755. */
  149756. dispose(): void;
  149757. }
  149758. }
  149759. declare module BABYLON {
  149760. /**
  149761. * PostProcessRenderPipelineManager class
  149762. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149763. */
  149764. export class PostProcessRenderPipelineManager {
  149765. private _renderPipelines;
  149766. /**
  149767. * Initializes a PostProcessRenderPipelineManager
  149768. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149769. */
  149770. constructor();
  149771. /**
  149772. * Gets the list of supported render pipelines
  149773. */
  149774. get supportedPipelines(): PostProcessRenderPipeline[];
  149775. /**
  149776. * Adds a pipeline to the manager
  149777. * @param renderPipeline The pipeline to add
  149778. */
  149779. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  149780. /**
  149781. * Attaches a camera to the pipeline
  149782. * @param renderPipelineName The name of the pipeline to attach to
  149783. * @param cameras the camera to attach
  149784. * @param unique if the camera can be attached multiple times to the pipeline
  149785. */
  149786. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  149787. /**
  149788. * Detaches a camera from the pipeline
  149789. * @param renderPipelineName The name of the pipeline to detach from
  149790. * @param cameras the camera to detach
  149791. */
  149792. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  149793. /**
  149794. * Enables an effect by name on a pipeline
  149795. * @param renderPipelineName the name of the pipeline to enable the effect in
  149796. * @param renderEffectName the name of the effect to enable
  149797. * @param cameras the cameras that the effect should be enabled on
  149798. */
  149799. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149800. /**
  149801. * Disables an effect by name on a pipeline
  149802. * @param renderPipelineName the name of the pipeline to disable the effect in
  149803. * @param renderEffectName the name of the effect to disable
  149804. * @param cameras the cameras that the effect should be disabled on
  149805. */
  149806. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149807. /**
  149808. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  149809. */
  149810. update(): void;
  149811. /** @hidden */
  149812. _rebuild(): void;
  149813. /**
  149814. * Disposes of the manager and pipelines
  149815. */
  149816. dispose(): void;
  149817. }
  149818. }
  149819. declare module BABYLON {
  149820. interface Scene {
  149821. /** @hidden (Backing field) */
  149822. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149823. /**
  149824. * Gets the postprocess render pipeline manager
  149825. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149826. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149827. */
  149828. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149829. }
  149830. /**
  149831. * Defines the Render Pipeline scene component responsible to rendering pipelines
  149832. */
  149833. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  149834. /**
  149835. * The component name helpfull to identify the component in the list of scene components.
  149836. */
  149837. readonly name: string;
  149838. /**
  149839. * The scene the component belongs to.
  149840. */
  149841. scene: Scene;
  149842. /**
  149843. * Creates a new instance of the component for the given scene
  149844. * @param scene Defines the scene to register the component in
  149845. */
  149846. constructor(scene: Scene);
  149847. /**
  149848. * Registers the component in a given scene
  149849. */
  149850. register(): void;
  149851. /**
  149852. * Rebuilds the elements related to this component in case of
  149853. * context lost for instance.
  149854. */
  149855. rebuild(): void;
  149856. /**
  149857. * Disposes the component and the associated ressources
  149858. */
  149859. dispose(): void;
  149860. private _gatherRenderTargets;
  149861. }
  149862. }
  149863. declare module BABYLON {
  149864. /**
  149865. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  149866. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149867. */
  149868. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  149869. private _scene;
  149870. private _camerasToBeAttached;
  149871. /**
  149872. * ID of the sharpen post process,
  149873. */
  149874. private readonly SharpenPostProcessId;
  149875. /**
  149876. * @ignore
  149877. * ID of the image processing post process;
  149878. */
  149879. readonly ImageProcessingPostProcessId: string;
  149880. /**
  149881. * @ignore
  149882. * ID of the Fast Approximate Anti-Aliasing post process;
  149883. */
  149884. readonly FxaaPostProcessId: string;
  149885. /**
  149886. * ID of the chromatic aberration post process,
  149887. */
  149888. private readonly ChromaticAberrationPostProcessId;
  149889. /**
  149890. * ID of the grain post process
  149891. */
  149892. private readonly GrainPostProcessId;
  149893. /**
  149894. * Sharpen post process which will apply a sharpen convolution to enhance edges
  149895. */
  149896. sharpen: SharpenPostProcess;
  149897. private _sharpenEffect;
  149898. private bloom;
  149899. /**
  149900. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  149901. */
  149902. depthOfField: DepthOfFieldEffect;
  149903. /**
  149904. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  149905. */
  149906. fxaa: FxaaPostProcess;
  149907. /**
  149908. * Image post processing pass used to perform operations such as tone mapping or color grading.
  149909. */
  149910. imageProcessing: ImageProcessingPostProcess;
  149911. /**
  149912. * Chromatic aberration post process which will shift rgb colors in the image
  149913. */
  149914. chromaticAberration: ChromaticAberrationPostProcess;
  149915. private _chromaticAberrationEffect;
  149916. /**
  149917. * Grain post process which add noise to the image
  149918. */
  149919. grain: GrainPostProcess;
  149920. private _grainEffect;
  149921. /**
  149922. * Glow post process which adds a glow to emissive areas of the image
  149923. */
  149924. private _glowLayer;
  149925. /**
  149926. * Animations which can be used to tweak settings over a period of time
  149927. */
  149928. animations: Animation[];
  149929. private _imageProcessingConfigurationObserver;
  149930. private _sharpenEnabled;
  149931. private _bloomEnabled;
  149932. private _depthOfFieldEnabled;
  149933. private _depthOfFieldBlurLevel;
  149934. private _fxaaEnabled;
  149935. private _imageProcessingEnabled;
  149936. private _defaultPipelineTextureType;
  149937. private _bloomScale;
  149938. private _chromaticAberrationEnabled;
  149939. private _grainEnabled;
  149940. private _buildAllowed;
  149941. /**
  149942. * Gets active scene
  149943. */
  149944. get scene(): Scene;
  149945. /**
  149946. * Enable or disable the sharpen process from the pipeline
  149947. */
  149948. set sharpenEnabled(enabled: boolean);
  149949. get sharpenEnabled(): boolean;
  149950. private _resizeObserver;
  149951. private _hardwareScaleLevel;
  149952. private _bloomKernel;
  149953. /**
  149954. * Specifies the size of the bloom blur kernel, relative to the final output size
  149955. */
  149956. get bloomKernel(): number;
  149957. set bloomKernel(value: number);
  149958. /**
  149959. * Specifies the weight of the bloom in the final rendering
  149960. */
  149961. private _bloomWeight;
  149962. /**
  149963. * Specifies the luma threshold for the area that will be blurred by the bloom
  149964. */
  149965. private _bloomThreshold;
  149966. private _hdr;
  149967. /**
  149968. * The strength of the bloom.
  149969. */
  149970. set bloomWeight(value: number);
  149971. get bloomWeight(): number;
  149972. /**
  149973. * The strength of the bloom.
  149974. */
  149975. set bloomThreshold(value: number);
  149976. get bloomThreshold(): number;
  149977. /**
  149978. * The scale of the bloom, lower value will provide better performance.
  149979. */
  149980. set bloomScale(value: number);
  149981. get bloomScale(): number;
  149982. /**
  149983. * Enable or disable the bloom from the pipeline
  149984. */
  149985. set bloomEnabled(enabled: boolean);
  149986. get bloomEnabled(): boolean;
  149987. private _rebuildBloom;
  149988. /**
  149989. * If the depth of field is enabled.
  149990. */
  149991. get depthOfFieldEnabled(): boolean;
  149992. set depthOfFieldEnabled(enabled: boolean);
  149993. /**
  149994. * Blur level of the depth of field effect. (Higher blur will effect performance)
  149995. */
  149996. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  149997. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  149998. /**
  149999. * If the anti aliasing is enabled.
  150000. */
  150001. set fxaaEnabled(enabled: boolean);
  150002. get fxaaEnabled(): boolean;
  150003. private _samples;
  150004. /**
  150005. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  150006. */
  150007. set samples(sampleCount: number);
  150008. get samples(): number;
  150009. /**
  150010. * If image processing is enabled.
  150011. */
  150012. set imageProcessingEnabled(enabled: boolean);
  150013. get imageProcessingEnabled(): boolean;
  150014. /**
  150015. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  150016. */
  150017. set glowLayerEnabled(enabled: boolean);
  150018. get glowLayerEnabled(): boolean;
  150019. /**
  150020. * Gets the glow layer (or null if not defined)
  150021. */
  150022. get glowLayer(): Nullable<GlowLayer>;
  150023. /**
  150024. * Enable or disable the chromaticAberration process from the pipeline
  150025. */
  150026. set chromaticAberrationEnabled(enabled: boolean);
  150027. get chromaticAberrationEnabled(): boolean;
  150028. /**
  150029. * Enable or disable the grain process from the pipeline
  150030. */
  150031. set grainEnabled(enabled: boolean);
  150032. get grainEnabled(): boolean;
  150033. /**
  150034. * @constructor
  150035. * @param name - The rendering pipeline name (default: "")
  150036. * @param hdr - If high dynamic range textures should be used (default: true)
  150037. * @param scene - The scene linked to this pipeline (default: the last created scene)
  150038. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  150039. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  150040. */
  150041. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  150042. /**
  150043. * Get the class name
  150044. * @returns "DefaultRenderingPipeline"
  150045. */
  150046. getClassName(): string;
  150047. /**
  150048. * Force the compilation of the entire pipeline.
  150049. */
  150050. prepare(): void;
  150051. private _hasCleared;
  150052. private _prevPostProcess;
  150053. private _prevPrevPostProcess;
  150054. private _setAutoClearAndTextureSharing;
  150055. private _depthOfFieldSceneObserver;
  150056. private _buildPipeline;
  150057. private _disposePostProcesses;
  150058. /**
  150059. * Adds a camera to the pipeline
  150060. * @param camera the camera to be added
  150061. */
  150062. addCamera(camera: Camera): void;
  150063. /**
  150064. * Removes a camera from the pipeline
  150065. * @param camera the camera to remove
  150066. */
  150067. removeCamera(camera: Camera): void;
  150068. /**
  150069. * Dispose of the pipeline and stop all post processes
  150070. */
  150071. dispose(): void;
  150072. /**
  150073. * Serialize the rendering pipeline (Used when exporting)
  150074. * @returns the serialized object
  150075. */
  150076. serialize(): any;
  150077. /**
  150078. * Parse the serialized pipeline
  150079. * @param source Source pipeline.
  150080. * @param scene The scene to load the pipeline to.
  150081. * @param rootUrl The URL of the serialized pipeline.
  150082. * @returns An instantiated pipeline from the serialized object.
  150083. */
  150084. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  150085. }
  150086. }
  150087. declare module BABYLON {
  150088. /** @hidden */
  150089. export var lensHighlightsPixelShader: {
  150090. name: string;
  150091. shader: string;
  150092. };
  150093. }
  150094. declare module BABYLON {
  150095. /** @hidden */
  150096. export var depthOfFieldPixelShader: {
  150097. name: string;
  150098. shader: string;
  150099. };
  150100. }
  150101. declare module BABYLON {
  150102. /**
  150103. * BABYLON.JS Chromatic Aberration GLSL Shader
  150104. * Author: Olivier Guyot
  150105. * Separates very slightly R, G and B colors on the edges of the screen
  150106. * Inspired by Francois Tarlier & Martins Upitis
  150107. */
  150108. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  150109. /**
  150110. * @ignore
  150111. * The chromatic aberration PostProcess id in the pipeline
  150112. */
  150113. LensChromaticAberrationEffect: string;
  150114. /**
  150115. * @ignore
  150116. * The highlights enhancing PostProcess id in the pipeline
  150117. */
  150118. HighlightsEnhancingEffect: string;
  150119. /**
  150120. * @ignore
  150121. * The depth-of-field PostProcess id in the pipeline
  150122. */
  150123. LensDepthOfFieldEffect: string;
  150124. private _scene;
  150125. private _depthTexture;
  150126. private _grainTexture;
  150127. private _chromaticAberrationPostProcess;
  150128. private _highlightsPostProcess;
  150129. private _depthOfFieldPostProcess;
  150130. private _edgeBlur;
  150131. private _grainAmount;
  150132. private _chromaticAberration;
  150133. private _distortion;
  150134. private _highlightsGain;
  150135. private _highlightsThreshold;
  150136. private _dofDistance;
  150137. private _dofAperture;
  150138. private _dofDarken;
  150139. private _dofPentagon;
  150140. private _blurNoise;
  150141. /**
  150142. * @constructor
  150143. *
  150144. * Effect parameters are as follow:
  150145. * {
  150146. * chromatic_aberration: number; // from 0 to x (1 for realism)
  150147. * edge_blur: number; // from 0 to x (1 for realism)
  150148. * distortion: number; // from 0 to x (1 for realism)
  150149. * grain_amount: number; // from 0 to 1
  150150. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  150151. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  150152. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  150153. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  150154. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  150155. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  150156. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  150157. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  150158. * }
  150159. * Note: if an effect parameter is unset, effect is disabled
  150160. *
  150161. * @param name The rendering pipeline name
  150162. * @param parameters - An object containing all parameters (see above)
  150163. * @param scene The scene linked to this pipeline
  150164. * @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)
  150165. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150166. */
  150167. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  150168. /**
  150169. * Get the class name
  150170. * @returns "LensRenderingPipeline"
  150171. */
  150172. getClassName(): string;
  150173. /**
  150174. * Gets associated scene
  150175. */
  150176. get scene(): Scene;
  150177. /**
  150178. * Gets or sets the edge blur
  150179. */
  150180. get edgeBlur(): number;
  150181. set edgeBlur(value: number);
  150182. /**
  150183. * Gets or sets the grain amount
  150184. */
  150185. get grainAmount(): number;
  150186. set grainAmount(value: number);
  150187. /**
  150188. * Gets or sets the chromatic aberration amount
  150189. */
  150190. get chromaticAberration(): number;
  150191. set chromaticAberration(value: number);
  150192. /**
  150193. * Gets or sets the depth of field aperture
  150194. */
  150195. get dofAperture(): number;
  150196. set dofAperture(value: number);
  150197. /**
  150198. * Gets or sets the edge distortion
  150199. */
  150200. get edgeDistortion(): number;
  150201. set edgeDistortion(value: number);
  150202. /**
  150203. * Gets or sets the depth of field distortion
  150204. */
  150205. get dofDistortion(): number;
  150206. set dofDistortion(value: number);
  150207. /**
  150208. * Gets or sets the darken out of focus amount
  150209. */
  150210. get darkenOutOfFocus(): number;
  150211. set darkenOutOfFocus(value: number);
  150212. /**
  150213. * Gets or sets a boolean indicating if blur noise is enabled
  150214. */
  150215. get blurNoise(): boolean;
  150216. set blurNoise(value: boolean);
  150217. /**
  150218. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  150219. */
  150220. get pentagonBokeh(): boolean;
  150221. set pentagonBokeh(value: boolean);
  150222. /**
  150223. * Gets or sets the highlight grain amount
  150224. */
  150225. get highlightsGain(): number;
  150226. set highlightsGain(value: number);
  150227. /**
  150228. * Gets or sets the highlight threshold
  150229. */
  150230. get highlightsThreshold(): number;
  150231. set highlightsThreshold(value: number);
  150232. /**
  150233. * Sets the amount of blur at the edges
  150234. * @param amount blur amount
  150235. */
  150236. setEdgeBlur(amount: number): void;
  150237. /**
  150238. * Sets edge blur to 0
  150239. */
  150240. disableEdgeBlur(): void;
  150241. /**
  150242. * Sets the amout of grain
  150243. * @param amount Amount of grain
  150244. */
  150245. setGrainAmount(amount: number): void;
  150246. /**
  150247. * Set grain amount to 0
  150248. */
  150249. disableGrain(): void;
  150250. /**
  150251. * Sets the chromatic aberration amount
  150252. * @param amount amount of chromatic aberration
  150253. */
  150254. setChromaticAberration(amount: number): void;
  150255. /**
  150256. * Sets chromatic aberration amount to 0
  150257. */
  150258. disableChromaticAberration(): void;
  150259. /**
  150260. * Sets the EdgeDistortion amount
  150261. * @param amount amount of EdgeDistortion
  150262. */
  150263. setEdgeDistortion(amount: number): void;
  150264. /**
  150265. * Sets edge distortion to 0
  150266. */
  150267. disableEdgeDistortion(): void;
  150268. /**
  150269. * Sets the FocusDistance amount
  150270. * @param amount amount of FocusDistance
  150271. */
  150272. setFocusDistance(amount: number): void;
  150273. /**
  150274. * Disables depth of field
  150275. */
  150276. disableDepthOfField(): void;
  150277. /**
  150278. * Sets the Aperture amount
  150279. * @param amount amount of Aperture
  150280. */
  150281. setAperture(amount: number): void;
  150282. /**
  150283. * Sets the DarkenOutOfFocus amount
  150284. * @param amount amount of DarkenOutOfFocus
  150285. */
  150286. setDarkenOutOfFocus(amount: number): void;
  150287. private _pentagonBokehIsEnabled;
  150288. /**
  150289. * Creates a pentagon bokeh effect
  150290. */
  150291. enablePentagonBokeh(): void;
  150292. /**
  150293. * Disables the pentagon bokeh effect
  150294. */
  150295. disablePentagonBokeh(): void;
  150296. /**
  150297. * Enables noise blur
  150298. */
  150299. enableNoiseBlur(): void;
  150300. /**
  150301. * Disables noise blur
  150302. */
  150303. disableNoiseBlur(): void;
  150304. /**
  150305. * Sets the HighlightsGain amount
  150306. * @param amount amount of HighlightsGain
  150307. */
  150308. setHighlightsGain(amount: number): void;
  150309. /**
  150310. * Sets the HighlightsThreshold amount
  150311. * @param amount amount of HighlightsThreshold
  150312. */
  150313. setHighlightsThreshold(amount: number): void;
  150314. /**
  150315. * Disables highlights
  150316. */
  150317. disableHighlights(): void;
  150318. /**
  150319. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  150320. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  150321. */
  150322. dispose(disableDepthRender?: boolean): void;
  150323. private _createChromaticAberrationPostProcess;
  150324. private _createHighlightsPostProcess;
  150325. private _createDepthOfFieldPostProcess;
  150326. private _createGrainTexture;
  150327. }
  150328. }
  150329. declare module BABYLON {
  150330. /** @hidden */
  150331. export var ssao2PixelShader: {
  150332. name: string;
  150333. shader: string;
  150334. };
  150335. }
  150336. declare module BABYLON {
  150337. /** @hidden */
  150338. export var ssaoCombinePixelShader: {
  150339. name: string;
  150340. shader: string;
  150341. };
  150342. }
  150343. declare module BABYLON {
  150344. /**
  150345. * Render pipeline to produce ssao effect
  150346. */
  150347. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  150348. /**
  150349. * @ignore
  150350. * The PassPostProcess id in the pipeline that contains the original scene color
  150351. */
  150352. SSAOOriginalSceneColorEffect: string;
  150353. /**
  150354. * @ignore
  150355. * The SSAO PostProcess id in the pipeline
  150356. */
  150357. SSAORenderEffect: string;
  150358. /**
  150359. * @ignore
  150360. * The horizontal blur PostProcess id in the pipeline
  150361. */
  150362. SSAOBlurHRenderEffect: string;
  150363. /**
  150364. * @ignore
  150365. * The vertical blur PostProcess id in the pipeline
  150366. */
  150367. SSAOBlurVRenderEffect: string;
  150368. /**
  150369. * @ignore
  150370. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150371. */
  150372. SSAOCombineRenderEffect: string;
  150373. /**
  150374. * The output strength of the SSAO post-process. Default value is 1.0.
  150375. */
  150376. totalStrength: number;
  150377. /**
  150378. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  150379. */
  150380. maxZ: number;
  150381. /**
  150382. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  150383. */
  150384. minZAspect: number;
  150385. private _samples;
  150386. /**
  150387. * Number of samples used for the SSAO calculations. Default value is 8
  150388. */
  150389. set samples(n: number);
  150390. get samples(): number;
  150391. private _textureSamples;
  150392. /**
  150393. * Number of samples to use for antialiasing
  150394. */
  150395. set textureSamples(n: number);
  150396. get textureSamples(): number;
  150397. /**
  150398. * Force rendering the geometry through geometry buffer
  150399. */
  150400. private _forceGeometryBuffer;
  150401. /**
  150402. * Ratio object used for SSAO ratio and blur ratio
  150403. */
  150404. private _ratio;
  150405. /**
  150406. * Dynamically generated sphere sampler.
  150407. */
  150408. private _sampleSphere;
  150409. /**
  150410. * Blur filter offsets
  150411. */
  150412. private _samplerOffsets;
  150413. private _expensiveBlur;
  150414. /**
  150415. * If bilateral blur should be used
  150416. */
  150417. set expensiveBlur(b: boolean);
  150418. get expensiveBlur(): boolean;
  150419. /**
  150420. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  150421. */
  150422. radius: number;
  150423. /**
  150424. * The base color of the SSAO post-process
  150425. * The final result is "base + ssao" between [0, 1]
  150426. */
  150427. base: number;
  150428. /**
  150429. * Support test.
  150430. */
  150431. static get IsSupported(): boolean;
  150432. private _scene;
  150433. private _randomTexture;
  150434. private _originalColorPostProcess;
  150435. private _ssaoPostProcess;
  150436. private _blurHPostProcess;
  150437. private _blurVPostProcess;
  150438. private _ssaoCombinePostProcess;
  150439. private _prePassRenderer;
  150440. /**
  150441. * Gets active scene
  150442. */
  150443. get scene(): Scene;
  150444. /**
  150445. * @constructor
  150446. * @param name The rendering pipeline name
  150447. * @param scene The scene linked to this pipeline
  150448. * @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 }
  150449. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150450. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  150451. */
  150452. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  150453. /**
  150454. * Get the class name
  150455. * @returns "SSAO2RenderingPipeline"
  150456. */
  150457. getClassName(): string;
  150458. /**
  150459. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150460. */
  150461. dispose(disableGeometryBufferRenderer?: boolean): void;
  150462. private _createBlurPostProcess;
  150463. /** @hidden */
  150464. _rebuild(): void;
  150465. private _bits;
  150466. private _radicalInverse_VdC;
  150467. private _hammersley;
  150468. private _hemisphereSample_uniform;
  150469. private _generateHemisphere;
  150470. private _getDefinesForSSAO;
  150471. private _createSSAOPostProcess;
  150472. private _createSSAOCombinePostProcess;
  150473. private _createRandomTexture;
  150474. /**
  150475. * Serialize the rendering pipeline (Used when exporting)
  150476. * @returns the serialized object
  150477. */
  150478. serialize(): any;
  150479. /**
  150480. * Parse the serialized pipeline
  150481. * @param source Source pipeline.
  150482. * @param scene The scene to load the pipeline to.
  150483. * @param rootUrl The URL of the serialized pipeline.
  150484. * @returns An instantiated pipeline from the serialized object.
  150485. */
  150486. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  150487. /**
  150488. * Sets the required values to the prepass renderer.
  150489. * @param prePassRenderer defines the prepass renderer to setup
  150490. * @returns true if the pre pass is needed.
  150491. */
  150492. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  150493. }
  150494. }
  150495. declare module BABYLON {
  150496. /** @hidden */
  150497. export var ssaoPixelShader: {
  150498. name: string;
  150499. shader: string;
  150500. };
  150501. }
  150502. declare module BABYLON {
  150503. /**
  150504. * Render pipeline to produce ssao effect
  150505. */
  150506. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  150507. /**
  150508. * @ignore
  150509. * The PassPostProcess id in the pipeline that contains the original scene color
  150510. */
  150511. SSAOOriginalSceneColorEffect: string;
  150512. /**
  150513. * @ignore
  150514. * The SSAO PostProcess id in the pipeline
  150515. */
  150516. SSAORenderEffect: string;
  150517. /**
  150518. * @ignore
  150519. * The horizontal blur PostProcess id in the pipeline
  150520. */
  150521. SSAOBlurHRenderEffect: string;
  150522. /**
  150523. * @ignore
  150524. * The vertical blur PostProcess id in the pipeline
  150525. */
  150526. SSAOBlurVRenderEffect: string;
  150527. /**
  150528. * @ignore
  150529. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150530. */
  150531. SSAOCombineRenderEffect: string;
  150532. /**
  150533. * The output strength of the SSAO post-process. Default value is 1.0.
  150534. */
  150535. totalStrength: number;
  150536. /**
  150537. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  150538. */
  150539. radius: number;
  150540. /**
  150541. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  150542. * Must not be equal to fallOff and superior to fallOff.
  150543. * Default value is 0.0075
  150544. */
  150545. area: number;
  150546. /**
  150547. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  150548. * Must not be equal to area and inferior to area.
  150549. * Default value is 0.000001
  150550. */
  150551. fallOff: number;
  150552. /**
  150553. * The base color of the SSAO post-process
  150554. * The final result is "base + ssao" between [0, 1]
  150555. */
  150556. base: number;
  150557. private _scene;
  150558. private _depthTexture;
  150559. private _randomTexture;
  150560. private _originalColorPostProcess;
  150561. private _ssaoPostProcess;
  150562. private _blurHPostProcess;
  150563. private _blurVPostProcess;
  150564. private _ssaoCombinePostProcess;
  150565. private _firstUpdate;
  150566. /**
  150567. * Gets active scene
  150568. */
  150569. get scene(): Scene;
  150570. /**
  150571. * @constructor
  150572. * @param name - The rendering pipeline name
  150573. * @param scene - The scene linked to this pipeline
  150574. * @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 }
  150575. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  150576. */
  150577. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  150578. /**
  150579. * Get the class name
  150580. * @returns "SSAORenderingPipeline"
  150581. */
  150582. getClassName(): string;
  150583. /**
  150584. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150585. */
  150586. dispose(disableDepthRender?: boolean): void;
  150587. private _createBlurPostProcess;
  150588. /** @hidden */
  150589. _rebuild(): void;
  150590. private _createSSAOPostProcess;
  150591. private _createSSAOCombinePostProcess;
  150592. private _createRandomTexture;
  150593. }
  150594. }
  150595. declare module BABYLON {
  150596. /** @hidden */
  150597. export var screenSpaceReflectionPixelShader: {
  150598. name: string;
  150599. shader: string;
  150600. };
  150601. }
  150602. declare module BABYLON {
  150603. /**
  150604. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  150605. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  150606. */
  150607. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  150608. /**
  150609. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  150610. */
  150611. threshold: number;
  150612. /**
  150613. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  150614. */
  150615. strength: number;
  150616. /**
  150617. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  150618. */
  150619. reflectionSpecularFalloffExponent: number;
  150620. /**
  150621. * 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]
  150622. */
  150623. step: number;
  150624. /**
  150625. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  150626. */
  150627. roughnessFactor: number;
  150628. private _geometryBufferRenderer;
  150629. private _enableSmoothReflections;
  150630. private _reflectionSamples;
  150631. private _smoothSteps;
  150632. /**
  150633. * Gets a string identifying the name of the class
  150634. * @returns "ScreenSpaceReflectionPostProcess" string
  150635. */
  150636. getClassName(): string;
  150637. /**
  150638. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  150639. * @param name The name of the effect.
  150640. * @param scene The scene containing the objects to calculate reflections.
  150641. * @param options The required width/height ratio to downsize to before computing the render pass.
  150642. * @param camera The camera to apply the render pass to.
  150643. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150644. * @param engine The engine which the post process will be applied. (default: current engine)
  150645. * @param reusable If the post process can be reused on the same frame. (default: false)
  150646. * @param textureType Type of textures used when performing the post process. (default: 0)
  150647. * @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)
  150648. */
  150649. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150650. /**
  150651. * Gets wether or not smoothing reflections is enabled.
  150652. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150653. */
  150654. get enableSmoothReflections(): boolean;
  150655. /**
  150656. * Sets wether or not smoothing reflections is enabled.
  150657. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150658. */
  150659. set enableSmoothReflections(enabled: boolean);
  150660. /**
  150661. * Gets the number of samples taken while computing reflections. More samples count is high,
  150662. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150663. */
  150664. get reflectionSamples(): number;
  150665. /**
  150666. * Sets the number of samples taken while computing reflections. More samples count is high,
  150667. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150668. */
  150669. set reflectionSamples(samples: number);
  150670. /**
  150671. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  150672. * more the post-process will require GPU power and can generate a drop in FPS.
  150673. * Default value (5.0) work pretty well in all cases but can be adjusted.
  150674. */
  150675. get smoothSteps(): number;
  150676. set smoothSteps(steps: number);
  150677. private _updateEffectDefines;
  150678. /** @hidden */
  150679. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  150680. }
  150681. }
  150682. declare module BABYLON {
  150683. /** @hidden */
  150684. export var standardPixelShader: {
  150685. name: string;
  150686. shader: string;
  150687. };
  150688. }
  150689. declare module BABYLON {
  150690. /**
  150691. * Standard rendering pipeline
  150692. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150693. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  150694. */
  150695. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  150696. /**
  150697. * Public members
  150698. */
  150699. /**
  150700. * Post-process which contains the original scene color before the pipeline applies all the effects
  150701. */
  150702. originalPostProcess: Nullable<PostProcess>;
  150703. /**
  150704. * Post-process used to down scale an image x4
  150705. */
  150706. downSampleX4PostProcess: Nullable<PostProcess>;
  150707. /**
  150708. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  150709. */
  150710. brightPassPostProcess: Nullable<PostProcess>;
  150711. /**
  150712. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  150713. */
  150714. blurHPostProcesses: PostProcess[];
  150715. /**
  150716. * Post-process array storing all the vertical blur post-processes used by the pipeline
  150717. */
  150718. blurVPostProcesses: PostProcess[];
  150719. /**
  150720. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  150721. */
  150722. textureAdderPostProcess: Nullable<PostProcess>;
  150723. /**
  150724. * Post-process used to create volumetric lighting effect
  150725. */
  150726. volumetricLightPostProcess: Nullable<PostProcess>;
  150727. /**
  150728. * Post-process used to smooth the previous volumetric light post-process on the X axis
  150729. */
  150730. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  150731. /**
  150732. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  150733. */
  150734. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  150735. /**
  150736. * Post-process used to merge the volumetric light effect and the real scene color
  150737. */
  150738. volumetricLightMergePostProces: Nullable<PostProcess>;
  150739. /**
  150740. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  150741. */
  150742. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  150743. /**
  150744. * Base post-process used to calculate the average luminance of the final image for HDR
  150745. */
  150746. luminancePostProcess: Nullable<PostProcess>;
  150747. /**
  150748. * Post-processes used to create down sample post-processes in order to get
  150749. * the average luminance of the final image for HDR
  150750. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  150751. */
  150752. luminanceDownSamplePostProcesses: PostProcess[];
  150753. /**
  150754. * Post-process used to create a HDR effect (light adaptation)
  150755. */
  150756. hdrPostProcess: Nullable<PostProcess>;
  150757. /**
  150758. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  150759. */
  150760. textureAdderFinalPostProcess: Nullable<PostProcess>;
  150761. /**
  150762. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  150763. */
  150764. lensFlareFinalPostProcess: Nullable<PostProcess>;
  150765. /**
  150766. * Post-process used to merge the final HDR post-process and the real scene color
  150767. */
  150768. hdrFinalPostProcess: Nullable<PostProcess>;
  150769. /**
  150770. * Post-process used to create a lens flare effect
  150771. */
  150772. lensFlarePostProcess: Nullable<PostProcess>;
  150773. /**
  150774. * Post-process that merges the result of the lens flare post-process and the real scene color
  150775. */
  150776. lensFlareComposePostProcess: Nullable<PostProcess>;
  150777. /**
  150778. * Post-process used to create a motion blur effect
  150779. */
  150780. motionBlurPostProcess: Nullable<PostProcess>;
  150781. /**
  150782. * Post-process used to create a depth of field effect
  150783. */
  150784. depthOfFieldPostProcess: Nullable<PostProcess>;
  150785. /**
  150786. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  150787. */
  150788. fxaaPostProcess: Nullable<FxaaPostProcess>;
  150789. /**
  150790. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  150791. */
  150792. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  150793. /**
  150794. * Represents the brightness threshold in order to configure the illuminated surfaces
  150795. */
  150796. brightThreshold: number;
  150797. /**
  150798. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  150799. */
  150800. blurWidth: number;
  150801. /**
  150802. * Sets if the blur for highlighted surfaces must be only horizontal
  150803. */
  150804. horizontalBlur: boolean;
  150805. /**
  150806. * Gets the overall exposure used by the pipeline
  150807. */
  150808. get exposure(): number;
  150809. /**
  150810. * Sets the overall exposure used by the pipeline
  150811. */
  150812. set exposure(value: number);
  150813. /**
  150814. * Texture used typically to simulate "dirty" on camera lens
  150815. */
  150816. lensTexture: Nullable<Texture>;
  150817. /**
  150818. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  150819. */
  150820. volumetricLightCoefficient: number;
  150821. /**
  150822. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  150823. */
  150824. volumetricLightPower: number;
  150825. /**
  150826. * Used the set the blur intensity to smooth the volumetric lights
  150827. */
  150828. volumetricLightBlurScale: number;
  150829. /**
  150830. * Light (spot or directional) used to generate the volumetric lights rays
  150831. * The source light must have a shadow generate so the pipeline can get its
  150832. * depth map
  150833. */
  150834. sourceLight: Nullable<SpotLight | DirectionalLight>;
  150835. /**
  150836. * For eye adaptation, represents the minimum luminance the eye can see
  150837. */
  150838. hdrMinimumLuminance: number;
  150839. /**
  150840. * For eye adaptation, represents the decrease luminance speed
  150841. */
  150842. hdrDecreaseRate: number;
  150843. /**
  150844. * For eye adaptation, represents the increase luminance speed
  150845. */
  150846. hdrIncreaseRate: number;
  150847. /**
  150848. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150849. */
  150850. get hdrAutoExposure(): boolean;
  150851. /**
  150852. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150853. */
  150854. set hdrAutoExposure(value: boolean);
  150855. /**
  150856. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  150857. */
  150858. lensColorTexture: Nullable<Texture>;
  150859. /**
  150860. * The overall strengh for the lens flare effect
  150861. */
  150862. lensFlareStrength: number;
  150863. /**
  150864. * Dispersion coefficient for lens flare ghosts
  150865. */
  150866. lensFlareGhostDispersal: number;
  150867. /**
  150868. * Main lens flare halo width
  150869. */
  150870. lensFlareHaloWidth: number;
  150871. /**
  150872. * Based on the lens distortion effect, defines how much the lens flare result
  150873. * is distorted
  150874. */
  150875. lensFlareDistortionStrength: number;
  150876. /**
  150877. * Configures the blur intensity used for for lens flare (halo)
  150878. */
  150879. lensFlareBlurWidth: number;
  150880. /**
  150881. * Lens star texture must be used to simulate rays on the flares and is available
  150882. * in the documentation
  150883. */
  150884. lensStarTexture: Nullable<Texture>;
  150885. /**
  150886. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  150887. * flare effect by taking account of the dirt texture
  150888. */
  150889. lensFlareDirtTexture: Nullable<Texture>;
  150890. /**
  150891. * Represents the focal length for the depth of field effect
  150892. */
  150893. depthOfFieldDistance: number;
  150894. /**
  150895. * Represents the blur intensity for the blurred part of the depth of field effect
  150896. */
  150897. depthOfFieldBlurWidth: number;
  150898. /**
  150899. * Gets how much the image is blurred by the movement while using the motion blur post-process
  150900. */
  150901. get motionStrength(): number;
  150902. /**
  150903. * Sets how much the image is blurred by the movement while using the motion blur post-process
  150904. */
  150905. set motionStrength(strength: number);
  150906. /**
  150907. * Gets wether or not the motion blur post-process is object based or screen based.
  150908. */
  150909. get objectBasedMotionBlur(): boolean;
  150910. /**
  150911. * Sets wether or not the motion blur post-process should be object based or screen based
  150912. */
  150913. set objectBasedMotionBlur(value: boolean);
  150914. /**
  150915. * List of animations for the pipeline (IAnimatable implementation)
  150916. */
  150917. animations: Animation[];
  150918. /**
  150919. * Private members
  150920. */
  150921. private _scene;
  150922. private _currentDepthOfFieldSource;
  150923. private _basePostProcess;
  150924. private _fixedExposure;
  150925. private _currentExposure;
  150926. private _hdrAutoExposure;
  150927. private _hdrCurrentLuminance;
  150928. private _motionStrength;
  150929. private _isObjectBasedMotionBlur;
  150930. private _floatTextureType;
  150931. private _camerasToBeAttached;
  150932. private _ratio;
  150933. private _bloomEnabled;
  150934. private _depthOfFieldEnabled;
  150935. private _vlsEnabled;
  150936. private _lensFlareEnabled;
  150937. private _hdrEnabled;
  150938. private _motionBlurEnabled;
  150939. private _fxaaEnabled;
  150940. private _screenSpaceReflectionsEnabled;
  150941. private _motionBlurSamples;
  150942. private _volumetricLightStepsCount;
  150943. private _samples;
  150944. /**
  150945. * @ignore
  150946. * Specifies if the bloom pipeline is enabled
  150947. */
  150948. get BloomEnabled(): boolean;
  150949. set BloomEnabled(enabled: boolean);
  150950. /**
  150951. * @ignore
  150952. * Specifies if the depth of field pipeline is enabed
  150953. */
  150954. get DepthOfFieldEnabled(): boolean;
  150955. set DepthOfFieldEnabled(enabled: boolean);
  150956. /**
  150957. * @ignore
  150958. * Specifies if the lens flare pipeline is enabed
  150959. */
  150960. get LensFlareEnabled(): boolean;
  150961. set LensFlareEnabled(enabled: boolean);
  150962. /**
  150963. * @ignore
  150964. * Specifies if the HDR pipeline is enabled
  150965. */
  150966. get HDREnabled(): boolean;
  150967. set HDREnabled(enabled: boolean);
  150968. /**
  150969. * @ignore
  150970. * Specifies if the volumetric lights scattering effect is enabled
  150971. */
  150972. get VLSEnabled(): boolean;
  150973. set VLSEnabled(enabled: boolean);
  150974. /**
  150975. * @ignore
  150976. * Specifies if the motion blur effect is enabled
  150977. */
  150978. get MotionBlurEnabled(): boolean;
  150979. set MotionBlurEnabled(enabled: boolean);
  150980. /**
  150981. * Specifies if anti-aliasing is enabled
  150982. */
  150983. get fxaaEnabled(): boolean;
  150984. set fxaaEnabled(enabled: boolean);
  150985. /**
  150986. * Specifies if screen space reflections are enabled.
  150987. */
  150988. get screenSpaceReflectionsEnabled(): boolean;
  150989. set screenSpaceReflectionsEnabled(enabled: boolean);
  150990. /**
  150991. * Specifies the number of steps used to calculate the volumetric lights
  150992. * Typically in interval [50, 200]
  150993. */
  150994. get volumetricLightStepsCount(): number;
  150995. set volumetricLightStepsCount(count: number);
  150996. /**
  150997. * Specifies the number of samples used for the motion blur effect
  150998. * Typically in interval [16, 64]
  150999. */
  151000. get motionBlurSamples(): number;
  151001. set motionBlurSamples(samples: number);
  151002. /**
  151003. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  151004. */
  151005. get samples(): number;
  151006. set samples(sampleCount: number);
  151007. /**
  151008. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  151009. * @constructor
  151010. * @param name The rendering pipeline name
  151011. * @param scene The scene linked to this pipeline
  151012. * @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)
  151013. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  151014. * @param cameras The array of cameras that the rendering pipeline will be attached to
  151015. */
  151016. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  151017. private _buildPipeline;
  151018. private _createDownSampleX4PostProcess;
  151019. private _createBrightPassPostProcess;
  151020. private _createBlurPostProcesses;
  151021. private _createTextureAdderPostProcess;
  151022. private _createVolumetricLightPostProcess;
  151023. private _createLuminancePostProcesses;
  151024. private _createHdrPostProcess;
  151025. private _createLensFlarePostProcess;
  151026. private _createDepthOfFieldPostProcess;
  151027. private _createMotionBlurPostProcess;
  151028. private _getDepthTexture;
  151029. private _disposePostProcesses;
  151030. /**
  151031. * Dispose of the pipeline and stop all post processes
  151032. */
  151033. dispose(): void;
  151034. /**
  151035. * Serialize the rendering pipeline (Used when exporting)
  151036. * @returns the serialized object
  151037. */
  151038. serialize(): any;
  151039. /**
  151040. * Parse the serialized pipeline
  151041. * @param source Source pipeline.
  151042. * @param scene The scene to load the pipeline to.
  151043. * @param rootUrl The URL of the serialized pipeline.
  151044. * @returns An instantiated pipeline from the serialized object.
  151045. */
  151046. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  151047. /**
  151048. * Luminance steps
  151049. */
  151050. static LuminanceSteps: number;
  151051. }
  151052. }
  151053. declare module BABYLON {
  151054. /** @hidden */
  151055. export var stereoscopicInterlacePixelShader: {
  151056. name: string;
  151057. shader: string;
  151058. };
  151059. }
  151060. declare module BABYLON {
  151061. /**
  151062. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  151063. */
  151064. export class StereoscopicInterlacePostProcessI extends PostProcess {
  151065. private _stepSize;
  151066. private _passedProcess;
  151067. /**
  151068. * Gets a string identifying the name of the class
  151069. * @returns "StereoscopicInterlacePostProcessI" string
  151070. */
  151071. getClassName(): string;
  151072. /**
  151073. * Initializes a StereoscopicInterlacePostProcessI
  151074. * @param name The name of the effect.
  151075. * @param rigCameras The rig cameras to be appled to the post process
  151076. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  151077. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  151078. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151079. * @param engine The engine which the post process will be applied. (default: current engine)
  151080. * @param reusable If the post process can be reused on the same frame. (default: false)
  151081. */
  151082. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151083. }
  151084. /**
  151085. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  151086. */
  151087. export class StereoscopicInterlacePostProcess extends PostProcess {
  151088. private _stepSize;
  151089. private _passedProcess;
  151090. /**
  151091. * Gets a string identifying the name of the class
  151092. * @returns "StereoscopicInterlacePostProcess" string
  151093. */
  151094. getClassName(): string;
  151095. /**
  151096. * Initializes a StereoscopicInterlacePostProcess
  151097. * @param name The name of the effect.
  151098. * @param rigCameras The rig cameras to be appled to the post process
  151099. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  151100. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151101. * @param engine The engine which the post process will be applied. (default: current engine)
  151102. * @param reusable If the post process can be reused on the same frame. (default: false)
  151103. */
  151104. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151105. }
  151106. }
  151107. declare module BABYLON {
  151108. /** @hidden */
  151109. export var tonemapPixelShader: {
  151110. name: string;
  151111. shader: string;
  151112. };
  151113. }
  151114. declare module BABYLON {
  151115. /** Defines operator used for tonemapping */
  151116. export enum TonemappingOperator {
  151117. /** Hable */
  151118. Hable = 0,
  151119. /** Reinhard */
  151120. Reinhard = 1,
  151121. /** HejiDawson */
  151122. HejiDawson = 2,
  151123. /** Photographic */
  151124. Photographic = 3
  151125. }
  151126. /**
  151127. * Defines a post process to apply tone mapping
  151128. */
  151129. export class TonemapPostProcess extends PostProcess {
  151130. private _operator;
  151131. /** Defines the required exposure adjustement */
  151132. exposureAdjustment: number;
  151133. /**
  151134. * Gets a string identifying the name of the class
  151135. * @returns "TonemapPostProcess" string
  151136. */
  151137. getClassName(): string;
  151138. /**
  151139. * Creates a new TonemapPostProcess
  151140. * @param name defines the name of the postprocess
  151141. * @param _operator defines the operator to use
  151142. * @param exposureAdjustment defines the required exposure adjustement
  151143. * @param camera defines the camera to use (can be null)
  151144. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  151145. * @param engine defines the hosting engine (can be ignore if camera is set)
  151146. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  151147. */
  151148. constructor(name: string, _operator: TonemappingOperator,
  151149. /** Defines the required exposure adjustement */
  151150. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  151151. }
  151152. }
  151153. declare module BABYLON {
  151154. /** @hidden */
  151155. export var volumetricLightScatteringPixelShader: {
  151156. name: string;
  151157. shader: string;
  151158. };
  151159. }
  151160. declare module BABYLON {
  151161. /** @hidden */
  151162. export var volumetricLightScatteringPassVertexShader: {
  151163. name: string;
  151164. shader: string;
  151165. };
  151166. }
  151167. declare module BABYLON {
  151168. /** @hidden */
  151169. export var volumetricLightScatteringPassPixelShader: {
  151170. name: string;
  151171. shader: string;
  151172. };
  151173. }
  151174. declare module BABYLON {
  151175. /**
  151176. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  151177. */
  151178. export class VolumetricLightScatteringPostProcess extends PostProcess {
  151179. private _volumetricLightScatteringPass;
  151180. private _volumetricLightScatteringRTT;
  151181. private _viewPort;
  151182. private _screenCoordinates;
  151183. private _cachedDefines;
  151184. /**
  151185. * If not undefined, the mesh position is computed from the attached node position
  151186. */
  151187. attachedNode: {
  151188. position: Vector3;
  151189. };
  151190. /**
  151191. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  151192. */
  151193. customMeshPosition: Vector3;
  151194. /**
  151195. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  151196. */
  151197. useCustomMeshPosition: boolean;
  151198. /**
  151199. * If the post-process should inverse the light scattering direction
  151200. */
  151201. invert: boolean;
  151202. /**
  151203. * The internal mesh used by the post-process
  151204. */
  151205. mesh: Mesh;
  151206. /**
  151207. * @hidden
  151208. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  151209. */
  151210. get useDiffuseColor(): boolean;
  151211. set useDiffuseColor(useDiffuseColor: boolean);
  151212. /**
  151213. * Array containing the excluded meshes not rendered in the internal pass
  151214. */
  151215. excludedMeshes: AbstractMesh[];
  151216. /**
  151217. * Controls the overall intensity of the post-process
  151218. */
  151219. exposure: number;
  151220. /**
  151221. * Dissipates each sample's contribution in range [0, 1]
  151222. */
  151223. decay: number;
  151224. /**
  151225. * Controls the overall intensity of each sample
  151226. */
  151227. weight: number;
  151228. /**
  151229. * Controls the density of each sample
  151230. */
  151231. density: number;
  151232. /**
  151233. * @constructor
  151234. * @param name The post-process name
  151235. * @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)
  151236. * @param camera The camera that the post-process will be attached to
  151237. * @param mesh The mesh used to create the light scattering
  151238. * @param samples The post-process quality, default 100
  151239. * @param samplingModeThe post-process filtering mode
  151240. * @param engine The babylon engine
  151241. * @param reusable If the post-process is reusable
  151242. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  151243. */
  151244. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  151245. /**
  151246. * Returns the string "VolumetricLightScatteringPostProcess"
  151247. * @returns "VolumetricLightScatteringPostProcess"
  151248. */
  151249. getClassName(): string;
  151250. private _isReady;
  151251. /**
  151252. * Sets the new light position for light scattering effect
  151253. * @param position The new custom light position
  151254. */
  151255. setCustomMeshPosition(position: Vector3): void;
  151256. /**
  151257. * Returns the light position for light scattering effect
  151258. * @return Vector3 The custom light position
  151259. */
  151260. getCustomMeshPosition(): Vector3;
  151261. /**
  151262. * Disposes the internal assets and detaches the post-process from the camera
  151263. */
  151264. dispose(camera: Camera): void;
  151265. /**
  151266. * Returns the render target texture used by the post-process
  151267. * @return the render target texture used by the post-process
  151268. */
  151269. getPass(): RenderTargetTexture;
  151270. private _meshExcluded;
  151271. private _createPass;
  151272. private _updateMeshScreenCoordinates;
  151273. /**
  151274. * Creates a default mesh for the Volumeric Light Scattering post-process
  151275. * @param name The mesh name
  151276. * @param scene The scene where to create the mesh
  151277. * @return the default mesh
  151278. */
  151279. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  151280. }
  151281. }
  151282. declare module BABYLON {
  151283. /** @hidden */
  151284. export var screenSpaceCurvaturePixelShader: {
  151285. name: string;
  151286. shader: string;
  151287. };
  151288. }
  151289. declare module BABYLON {
  151290. /**
  151291. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  151292. */
  151293. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  151294. /**
  151295. * Defines how much ridge the curvature effect displays.
  151296. */
  151297. ridge: number;
  151298. /**
  151299. * Defines how much valley the curvature effect displays.
  151300. */
  151301. valley: number;
  151302. private _geometryBufferRenderer;
  151303. /**
  151304. * Gets a string identifying the name of the class
  151305. * @returns "ScreenSpaceCurvaturePostProcess" string
  151306. */
  151307. getClassName(): string;
  151308. /**
  151309. * Creates a new instance ScreenSpaceCurvaturePostProcess
  151310. * @param name The name of the effect.
  151311. * @param scene The scene containing the objects to blur according to their velocity.
  151312. * @param options The required width/height ratio to downsize to before computing the render pass.
  151313. * @param camera The camera to apply the render pass to.
  151314. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151315. * @param engine The engine which the post process will be applied. (default: current engine)
  151316. * @param reusable If the post process can be reused on the same frame. (default: false)
  151317. * @param textureType Type of textures used when performing the post process. (default: 0)
  151318. * @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)
  151319. */
  151320. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  151321. /**
  151322. * Support test.
  151323. */
  151324. static get IsSupported(): boolean;
  151325. /** @hidden */
  151326. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  151327. }
  151328. }
  151329. declare module BABYLON {
  151330. interface Scene {
  151331. /** @hidden (Backing field) */
  151332. _boundingBoxRenderer: BoundingBoxRenderer;
  151333. /** @hidden (Backing field) */
  151334. _forceShowBoundingBoxes: boolean;
  151335. /**
  151336. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  151337. */
  151338. forceShowBoundingBoxes: boolean;
  151339. /**
  151340. * Gets the bounding box renderer associated with the scene
  151341. * @returns a BoundingBoxRenderer
  151342. */
  151343. getBoundingBoxRenderer(): BoundingBoxRenderer;
  151344. }
  151345. interface AbstractMesh {
  151346. /** @hidden (Backing field) */
  151347. _showBoundingBox: boolean;
  151348. /**
  151349. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  151350. */
  151351. showBoundingBox: boolean;
  151352. }
  151353. /**
  151354. * Component responsible of rendering the bounding box of the meshes in a scene.
  151355. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  151356. */
  151357. export class BoundingBoxRenderer implements ISceneComponent {
  151358. /**
  151359. * The component name helpfull to identify the component in the list of scene components.
  151360. */
  151361. readonly name: string;
  151362. /**
  151363. * The scene the component belongs to.
  151364. */
  151365. scene: Scene;
  151366. /**
  151367. * Color of the bounding box lines placed in front of an object
  151368. */
  151369. frontColor: Color3;
  151370. /**
  151371. * Color of the bounding box lines placed behind an object
  151372. */
  151373. backColor: Color3;
  151374. /**
  151375. * Defines if the renderer should show the back lines or not
  151376. */
  151377. showBackLines: boolean;
  151378. /**
  151379. * Observable raised before rendering a bounding box
  151380. */
  151381. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  151382. /**
  151383. * Observable raised after rendering a bounding box
  151384. */
  151385. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  151386. /**
  151387. * @hidden
  151388. */
  151389. renderList: SmartArray<BoundingBox>;
  151390. private _colorShader;
  151391. private _vertexBuffers;
  151392. private _indexBuffer;
  151393. private _fillIndexBuffer;
  151394. private _fillIndexData;
  151395. /**
  151396. * Instantiates a new bounding box renderer in a scene.
  151397. * @param scene the scene the renderer renders in
  151398. */
  151399. constructor(scene: Scene);
  151400. /**
  151401. * Registers the component in a given scene
  151402. */
  151403. register(): void;
  151404. private _evaluateSubMesh;
  151405. private _activeMesh;
  151406. private _prepareRessources;
  151407. private _createIndexBuffer;
  151408. /**
  151409. * Rebuilds the elements related to this component in case of
  151410. * context lost for instance.
  151411. */
  151412. rebuild(): void;
  151413. /**
  151414. * @hidden
  151415. */
  151416. reset(): void;
  151417. /**
  151418. * Render the bounding boxes of a specific rendering group
  151419. * @param renderingGroupId defines the rendering group to render
  151420. */
  151421. render(renderingGroupId: number): void;
  151422. /**
  151423. * In case of occlusion queries, we can render the occlusion bounding box through this method
  151424. * @param mesh Define the mesh to render the occlusion bounding box for
  151425. */
  151426. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  151427. /**
  151428. * Dispose and release the resources attached to this renderer.
  151429. */
  151430. dispose(): void;
  151431. }
  151432. }
  151433. declare module BABYLON {
  151434. interface Scene {
  151435. /** @hidden (Backing field) */
  151436. _depthRenderer: {
  151437. [id: string]: DepthRenderer;
  151438. };
  151439. /**
  151440. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  151441. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  151442. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  151443. * @returns the created depth renderer
  151444. */
  151445. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  151446. /**
  151447. * Disables a depth renderer for a given camera
  151448. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  151449. */
  151450. disableDepthRenderer(camera?: Nullable<Camera>): void;
  151451. }
  151452. /**
  151453. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  151454. * in several rendering techniques.
  151455. */
  151456. export class DepthRendererSceneComponent implements ISceneComponent {
  151457. /**
  151458. * The component name helpfull to identify the component in the list of scene components.
  151459. */
  151460. readonly name: string;
  151461. /**
  151462. * The scene the component belongs to.
  151463. */
  151464. scene: Scene;
  151465. /**
  151466. * Creates a new instance of the component for the given scene
  151467. * @param scene Defines the scene to register the component in
  151468. */
  151469. constructor(scene: Scene);
  151470. /**
  151471. * Registers the component in a given scene
  151472. */
  151473. register(): void;
  151474. /**
  151475. * Rebuilds the elements related to this component in case of
  151476. * context lost for instance.
  151477. */
  151478. rebuild(): void;
  151479. /**
  151480. * Disposes the component and the associated ressources
  151481. */
  151482. dispose(): void;
  151483. private _gatherRenderTargets;
  151484. private _gatherActiveCameraRenderTargets;
  151485. }
  151486. }
  151487. declare module BABYLON {
  151488. interface AbstractScene {
  151489. /** @hidden (Backing field) */
  151490. _prePassRenderer: Nullable<PrePassRenderer>;
  151491. /**
  151492. * Gets or Sets the current prepass renderer associated to the scene.
  151493. */
  151494. prePassRenderer: Nullable<PrePassRenderer>;
  151495. /**
  151496. * Enables the prepass and associates it with the scene
  151497. * @returns the PrePassRenderer
  151498. */
  151499. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  151500. /**
  151501. * Disables the prepass associated with the scene
  151502. */
  151503. disablePrePassRenderer(): void;
  151504. }
  151505. /**
  151506. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  151507. * in several rendering techniques.
  151508. */
  151509. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  151510. /**
  151511. * The component name helpful to identify the component in the list of scene components.
  151512. */
  151513. readonly name: string;
  151514. /**
  151515. * The scene the component belongs to.
  151516. */
  151517. scene: Scene;
  151518. /**
  151519. * Creates a new instance of the component for the given scene
  151520. * @param scene Defines the scene to register the component in
  151521. */
  151522. constructor(scene: Scene);
  151523. /**
  151524. * Registers the component in a given scene
  151525. */
  151526. register(): void;
  151527. private _beforeCameraDraw;
  151528. private _afterCameraDraw;
  151529. private _beforeClearStage;
  151530. /**
  151531. * Serializes the component data to the specified json object
  151532. * @param serializationObject The object to serialize to
  151533. */
  151534. serialize(serializationObject: any): void;
  151535. /**
  151536. * Adds all the elements from the container to the scene
  151537. * @param container the container holding the elements
  151538. */
  151539. addFromContainer(container: AbstractScene): void;
  151540. /**
  151541. * Removes all the elements in the container from the scene
  151542. * @param container contains the elements to remove
  151543. * @param dispose if the removed element should be disposed (default: false)
  151544. */
  151545. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  151546. /**
  151547. * Rebuilds the elements related to this component in case of
  151548. * context lost for instance.
  151549. */
  151550. rebuild(): void;
  151551. /**
  151552. * Disposes the component and the associated ressources
  151553. */
  151554. dispose(): void;
  151555. }
  151556. }
  151557. declare module BABYLON {
  151558. /** @hidden */
  151559. export var outlinePixelShader: {
  151560. name: string;
  151561. shader: string;
  151562. };
  151563. }
  151564. declare module BABYLON {
  151565. /** @hidden */
  151566. export var outlineVertexShader: {
  151567. name: string;
  151568. shader: string;
  151569. };
  151570. }
  151571. declare module BABYLON {
  151572. interface Scene {
  151573. /** @hidden */
  151574. _outlineRenderer: OutlineRenderer;
  151575. /**
  151576. * Gets the outline renderer associated with the scene
  151577. * @returns a OutlineRenderer
  151578. */
  151579. getOutlineRenderer(): OutlineRenderer;
  151580. }
  151581. interface AbstractMesh {
  151582. /** @hidden (Backing field) */
  151583. _renderOutline: boolean;
  151584. /**
  151585. * Gets or sets a boolean indicating if the outline must be rendered as well
  151586. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  151587. */
  151588. renderOutline: boolean;
  151589. /** @hidden (Backing field) */
  151590. _renderOverlay: boolean;
  151591. /**
  151592. * Gets or sets a boolean indicating if the overlay must be rendered as well
  151593. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  151594. */
  151595. renderOverlay: boolean;
  151596. }
  151597. /**
  151598. * This class is responsible to draw bothe outline/overlay of meshes.
  151599. * It should not be used directly but through the available method on mesh.
  151600. */
  151601. export class OutlineRenderer implements ISceneComponent {
  151602. /**
  151603. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  151604. */
  151605. private static _StencilReference;
  151606. /**
  151607. * The name of the component. Each component must have a unique name.
  151608. */
  151609. name: string;
  151610. /**
  151611. * The scene the component belongs to.
  151612. */
  151613. scene: Scene;
  151614. /**
  151615. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  151616. */
  151617. zOffset: number;
  151618. private _engine;
  151619. private _effect;
  151620. private _cachedDefines;
  151621. private _savedDepthWrite;
  151622. /**
  151623. * Instantiates a new outline renderer. (There could be only one per scene).
  151624. * @param scene Defines the scene it belongs to
  151625. */
  151626. constructor(scene: Scene);
  151627. /**
  151628. * Register the component to one instance of a scene.
  151629. */
  151630. register(): void;
  151631. /**
  151632. * Rebuilds the elements related to this component in case of
  151633. * context lost for instance.
  151634. */
  151635. rebuild(): void;
  151636. /**
  151637. * Disposes the component and the associated ressources.
  151638. */
  151639. dispose(): void;
  151640. /**
  151641. * Renders the outline in the canvas.
  151642. * @param subMesh Defines the sumesh to render
  151643. * @param batch Defines the batch of meshes in case of instances
  151644. * @param useOverlay Defines if the rendering is for the overlay or the outline
  151645. */
  151646. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  151647. /**
  151648. * Returns whether or not the outline renderer is ready for a given submesh.
  151649. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  151650. * @param subMesh Defines the submesh to check readyness for
  151651. * @param useInstances Defines wheter wee are trying to render instances or not
  151652. * @returns true if ready otherwise false
  151653. */
  151654. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  151655. private _beforeRenderingMesh;
  151656. private _afterRenderingMesh;
  151657. }
  151658. }
  151659. declare module BABYLON {
  151660. /**
  151661. * Defines the basic options interface of a Sprite Frame Source Size.
  151662. */
  151663. export interface ISpriteJSONSpriteSourceSize {
  151664. /**
  151665. * number of the original width of the Frame
  151666. */
  151667. w: number;
  151668. /**
  151669. * number of the original height of the Frame
  151670. */
  151671. h: number;
  151672. }
  151673. /**
  151674. * Defines the basic options interface of a Sprite Frame Data.
  151675. */
  151676. export interface ISpriteJSONSpriteFrameData {
  151677. /**
  151678. * number of the x offset of the Frame
  151679. */
  151680. x: number;
  151681. /**
  151682. * number of the y offset of the Frame
  151683. */
  151684. y: number;
  151685. /**
  151686. * number of the width of the Frame
  151687. */
  151688. w: number;
  151689. /**
  151690. * number of the height of the Frame
  151691. */
  151692. h: number;
  151693. }
  151694. /**
  151695. * Defines the basic options interface of a JSON Sprite.
  151696. */
  151697. export interface ISpriteJSONSprite {
  151698. /**
  151699. * string name of the Frame
  151700. */
  151701. filename: string;
  151702. /**
  151703. * ISpriteJSONSpriteFrame basic object of the frame data
  151704. */
  151705. frame: ISpriteJSONSpriteFrameData;
  151706. /**
  151707. * boolean to flag is the frame was rotated.
  151708. */
  151709. rotated: boolean;
  151710. /**
  151711. * boolean to flag is the frame was trimmed.
  151712. */
  151713. trimmed: boolean;
  151714. /**
  151715. * ISpriteJSONSpriteFrame basic object of the source data
  151716. */
  151717. spriteSourceSize: ISpriteJSONSpriteFrameData;
  151718. /**
  151719. * ISpriteJSONSpriteFrame basic object of the source data
  151720. */
  151721. sourceSize: ISpriteJSONSpriteSourceSize;
  151722. }
  151723. /**
  151724. * Defines the basic options interface of a JSON atlas.
  151725. */
  151726. export interface ISpriteJSONAtlas {
  151727. /**
  151728. * Array of objects that contain the frame data.
  151729. */
  151730. frames: Array<ISpriteJSONSprite>;
  151731. /**
  151732. * object basic object containing the sprite meta data.
  151733. */
  151734. meta?: object;
  151735. }
  151736. }
  151737. declare module BABYLON {
  151738. /** @hidden */
  151739. export var spriteMapPixelShader: {
  151740. name: string;
  151741. shader: string;
  151742. };
  151743. }
  151744. declare module BABYLON {
  151745. /** @hidden */
  151746. export var spriteMapVertexShader: {
  151747. name: string;
  151748. shader: string;
  151749. };
  151750. }
  151751. declare module BABYLON {
  151752. /**
  151753. * Defines the basic options interface of a SpriteMap
  151754. */
  151755. export interface ISpriteMapOptions {
  151756. /**
  151757. * Vector2 of the number of cells in the grid.
  151758. */
  151759. stageSize?: Vector2;
  151760. /**
  151761. * Vector2 of the size of the output plane in World Units.
  151762. */
  151763. outputSize?: Vector2;
  151764. /**
  151765. * Vector3 of the position of the output plane in World Units.
  151766. */
  151767. outputPosition?: Vector3;
  151768. /**
  151769. * Vector3 of the rotation of the output plane.
  151770. */
  151771. outputRotation?: Vector3;
  151772. /**
  151773. * number of layers that the system will reserve in resources.
  151774. */
  151775. layerCount?: number;
  151776. /**
  151777. * number of max animation frames a single cell will reserve in resources.
  151778. */
  151779. maxAnimationFrames?: number;
  151780. /**
  151781. * number cell index of the base tile when the system compiles.
  151782. */
  151783. baseTile?: number;
  151784. /**
  151785. * boolean flip the sprite after its been repositioned by the framing data.
  151786. */
  151787. flipU?: boolean;
  151788. /**
  151789. * Vector3 scalar of the global RGB values of the SpriteMap.
  151790. */
  151791. colorMultiply?: Vector3;
  151792. }
  151793. /**
  151794. * Defines the IDisposable interface in order to be cleanable from resources.
  151795. */
  151796. export interface ISpriteMap extends IDisposable {
  151797. /**
  151798. * String name of the SpriteMap.
  151799. */
  151800. name: string;
  151801. /**
  151802. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  151803. */
  151804. atlasJSON: ISpriteJSONAtlas;
  151805. /**
  151806. * Texture of the SpriteMap.
  151807. */
  151808. spriteSheet: Texture;
  151809. /**
  151810. * The parameters to initialize the SpriteMap with.
  151811. */
  151812. options: ISpriteMapOptions;
  151813. }
  151814. /**
  151815. * Class used to manage a grid restricted sprite deployment on an Output plane.
  151816. */
  151817. export class SpriteMap implements ISpriteMap {
  151818. /** The Name of the spriteMap */
  151819. name: string;
  151820. /** The JSON file with the frame and meta data */
  151821. atlasJSON: ISpriteJSONAtlas;
  151822. /** The systems Sprite Sheet Texture */
  151823. spriteSheet: Texture;
  151824. /** Arguments passed with the Constructor */
  151825. options: ISpriteMapOptions;
  151826. /** Public Sprite Storage array, parsed from atlasJSON */
  151827. sprites: Array<ISpriteJSONSprite>;
  151828. /** Returns the Number of Sprites in the System */
  151829. get spriteCount(): number;
  151830. /** Returns the Position of Output Plane*/
  151831. get position(): Vector3;
  151832. /** Returns the Position of Output Plane*/
  151833. set position(v: Vector3);
  151834. /** Returns the Rotation of Output Plane*/
  151835. get rotation(): Vector3;
  151836. /** Returns the Rotation of Output Plane*/
  151837. set rotation(v: Vector3);
  151838. /** Sets the AnimationMap*/
  151839. get animationMap(): RawTexture;
  151840. /** Sets the AnimationMap*/
  151841. set animationMap(v: RawTexture);
  151842. /** Scene that the SpriteMap was created in */
  151843. private _scene;
  151844. /** Texture Buffer of Float32 that holds tile frame data*/
  151845. private _frameMap;
  151846. /** Texture Buffers of Float32 that holds tileMap data*/
  151847. private _tileMaps;
  151848. /** Texture Buffer of Float32 that holds Animation Data*/
  151849. private _animationMap;
  151850. /** Custom ShaderMaterial Central to the System*/
  151851. private _material;
  151852. /** Custom ShaderMaterial Central to the System*/
  151853. private _output;
  151854. /** Systems Time Ticker*/
  151855. private _time;
  151856. /**
  151857. * Creates a new SpriteMap
  151858. * @param name defines the SpriteMaps Name
  151859. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  151860. * @param spriteSheet is the Texture that the Sprites are on.
  151861. * @param options a basic deployment configuration
  151862. * @param scene The Scene that the map is deployed on
  151863. */
  151864. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  151865. /**
  151866. * Returns tileID location
  151867. * @returns Vector2 the cell position ID
  151868. */
  151869. getTileID(): Vector2;
  151870. /**
  151871. * Gets the UV location of the mouse over the SpriteMap.
  151872. * @returns Vector2 the UV position of the mouse interaction
  151873. */
  151874. getMousePosition(): Vector2;
  151875. /**
  151876. * Creates the "frame" texture Buffer
  151877. * -------------------------------------
  151878. * Structure of frames
  151879. * "filename": "Falling-Water-2.png",
  151880. * "frame": {"x":69,"y":103,"w":24,"h":32},
  151881. * "rotated": true,
  151882. * "trimmed": true,
  151883. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  151884. * "sourceSize": {"w":32,"h":32}
  151885. * @returns RawTexture of the frameMap
  151886. */
  151887. private _createFrameBuffer;
  151888. /**
  151889. * Creates the tileMap texture Buffer
  151890. * @param buffer normally and array of numbers, or a false to generate from scratch
  151891. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  151892. * @returns RawTexture of the tileMap
  151893. */
  151894. private _createTileBuffer;
  151895. /**
  151896. * Modifies the data of the tileMaps
  151897. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  151898. * @param pos is the iVector2 Coordinates of the Tile
  151899. * @param tile The SpriteIndex of the new Tile
  151900. */
  151901. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  151902. /**
  151903. * Creates the animationMap texture Buffer
  151904. * @param buffer normally and array of numbers, or a false to generate from scratch
  151905. * @returns RawTexture of the animationMap
  151906. */
  151907. private _createTileAnimationBuffer;
  151908. /**
  151909. * Modifies the data of the animationMap
  151910. * @param cellID is the Index of the Sprite
  151911. * @param _frame is the target Animation frame
  151912. * @param toCell is the Target Index of the next frame of the animation
  151913. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  151914. * @param speed is a global scalar of the time variable on the map.
  151915. */
  151916. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  151917. /**
  151918. * Exports the .tilemaps file
  151919. */
  151920. saveTileMaps(): void;
  151921. /**
  151922. * Imports the .tilemaps file
  151923. * @param url of the .tilemaps file
  151924. */
  151925. loadTileMaps(url: string): void;
  151926. /**
  151927. * Release associated resources
  151928. */
  151929. dispose(): void;
  151930. }
  151931. }
  151932. declare module BABYLON {
  151933. /**
  151934. * Class used to manage multiple sprites of different sizes on the same spritesheet
  151935. * @see https://doc.babylonjs.com/babylon101/sprites
  151936. */
  151937. export class SpritePackedManager extends SpriteManager {
  151938. /** defines the packed manager's name */
  151939. name: string;
  151940. /**
  151941. * Creates a new sprite manager from a packed sprite sheet
  151942. * @param name defines the manager's name
  151943. * @param imgUrl defines the sprite sheet url
  151944. * @param capacity defines the maximum allowed number of sprites
  151945. * @param scene defines the hosting scene
  151946. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  151947. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  151948. * @param samplingMode defines the smapling mode to use with spritesheet
  151949. * @param fromPacked set to true; do not alter
  151950. */
  151951. constructor(
  151952. /** defines the packed manager's name */
  151953. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  151954. }
  151955. }
  151956. declare module BABYLON {
  151957. /**
  151958. * Defines the list of states available for a task inside a AssetsManager
  151959. */
  151960. export enum AssetTaskState {
  151961. /**
  151962. * Initialization
  151963. */
  151964. INIT = 0,
  151965. /**
  151966. * Running
  151967. */
  151968. RUNNING = 1,
  151969. /**
  151970. * Done
  151971. */
  151972. DONE = 2,
  151973. /**
  151974. * Error
  151975. */
  151976. ERROR = 3
  151977. }
  151978. /**
  151979. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  151980. */
  151981. export abstract class AbstractAssetTask {
  151982. /**
  151983. * Task name
  151984. */ name: string;
  151985. /**
  151986. * Callback called when the task is successful
  151987. */
  151988. onSuccess: (task: any) => void;
  151989. /**
  151990. * Callback called when the task is not successful
  151991. */
  151992. onError: (task: any, message?: string, exception?: any) => void;
  151993. /**
  151994. * Creates a new AssetsManager
  151995. * @param name defines the name of the task
  151996. */
  151997. constructor(
  151998. /**
  151999. * Task name
  152000. */ name: string);
  152001. private _isCompleted;
  152002. private _taskState;
  152003. private _errorObject;
  152004. /**
  152005. * Get if the task is completed
  152006. */
  152007. get isCompleted(): boolean;
  152008. /**
  152009. * Gets the current state of the task
  152010. */
  152011. get taskState(): AssetTaskState;
  152012. /**
  152013. * Gets the current error object (if task is in error)
  152014. */
  152015. get errorObject(): {
  152016. message?: string;
  152017. exception?: any;
  152018. };
  152019. /**
  152020. * Internal only
  152021. * @hidden
  152022. */
  152023. _setErrorObject(message?: string, exception?: any): void;
  152024. /**
  152025. * Execute the current task
  152026. * @param scene defines the scene where you want your assets to be loaded
  152027. * @param onSuccess is a callback called when the task is successfully executed
  152028. * @param onError is a callback called if an error occurs
  152029. */
  152030. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152031. /**
  152032. * Execute the current task
  152033. * @param scene defines the scene where you want your assets to be loaded
  152034. * @param onSuccess is a callback called when the task is successfully executed
  152035. * @param onError is a callback called if an error occurs
  152036. */
  152037. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152038. /**
  152039. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  152040. * This can be used with failed tasks that have the reason for failure fixed.
  152041. */
  152042. reset(): void;
  152043. private onErrorCallback;
  152044. private onDoneCallback;
  152045. }
  152046. /**
  152047. * Define the interface used by progress events raised during assets loading
  152048. */
  152049. export interface IAssetsProgressEvent {
  152050. /**
  152051. * Defines the number of remaining tasks to process
  152052. */
  152053. remainingCount: number;
  152054. /**
  152055. * Defines the total number of tasks
  152056. */
  152057. totalCount: number;
  152058. /**
  152059. * Defines the task that was just processed
  152060. */
  152061. task: AbstractAssetTask;
  152062. }
  152063. /**
  152064. * Class used to share progress information about assets loading
  152065. */
  152066. export class AssetsProgressEvent implements IAssetsProgressEvent {
  152067. /**
  152068. * Defines the number of remaining tasks to process
  152069. */
  152070. remainingCount: number;
  152071. /**
  152072. * Defines the total number of tasks
  152073. */
  152074. totalCount: number;
  152075. /**
  152076. * Defines the task that was just processed
  152077. */
  152078. task: AbstractAssetTask;
  152079. /**
  152080. * Creates a AssetsProgressEvent
  152081. * @param remainingCount defines the number of remaining tasks to process
  152082. * @param totalCount defines the total number of tasks
  152083. * @param task defines the task that was just processed
  152084. */
  152085. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  152086. }
  152087. /**
  152088. * Define a task used by AssetsManager to load assets into a container
  152089. */
  152090. export class ContainerAssetTask extends AbstractAssetTask {
  152091. /**
  152092. * Defines the name of the task
  152093. */
  152094. name: string;
  152095. /**
  152096. * Defines the list of mesh's names you want to load
  152097. */
  152098. meshesNames: any;
  152099. /**
  152100. * Defines the root url to use as a base to load your meshes and associated resources
  152101. */
  152102. rootUrl: string;
  152103. /**
  152104. * Defines the filename or File of the scene to load from
  152105. */
  152106. sceneFilename: string | File;
  152107. /**
  152108. * Get the loaded asset container
  152109. */
  152110. loadedContainer: AssetContainer;
  152111. /**
  152112. * Gets the list of loaded meshes
  152113. */
  152114. loadedMeshes: Array<AbstractMesh>;
  152115. /**
  152116. * Gets the list of loaded particle systems
  152117. */
  152118. loadedParticleSystems: Array<IParticleSystem>;
  152119. /**
  152120. * Gets the list of loaded skeletons
  152121. */
  152122. loadedSkeletons: Array<Skeleton>;
  152123. /**
  152124. * Gets the list of loaded animation groups
  152125. */
  152126. loadedAnimationGroups: Array<AnimationGroup>;
  152127. /**
  152128. * Callback called when the task is successful
  152129. */
  152130. onSuccess: (task: ContainerAssetTask) => void;
  152131. /**
  152132. * Callback called when the task is successful
  152133. */
  152134. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  152135. /**
  152136. * Creates a new ContainerAssetTask
  152137. * @param name defines the name of the task
  152138. * @param meshesNames defines the list of mesh's names you want to load
  152139. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152140. * @param sceneFilename defines the filename or File of the scene to load from
  152141. */
  152142. constructor(
  152143. /**
  152144. * Defines the name of the task
  152145. */
  152146. name: string,
  152147. /**
  152148. * Defines the list of mesh's names you want to load
  152149. */
  152150. meshesNames: any,
  152151. /**
  152152. * Defines the root url to use as a base to load your meshes and associated resources
  152153. */
  152154. rootUrl: string,
  152155. /**
  152156. * Defines the filename or File of the scene to load from
  152157. */
  152158. sceneFilename: string | File);
  152159. /**
  152160. * Execute the current task
  152161. * @param scene defines the scene where you want your assets to be loaded
  152162. * @param onSuccess is a callback called when the task is successfully executed
  152163. * @param onError is a callback called if an error occurs
  152164. */
  152165. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152166. }
  152167. /**
  152168. * Define a task used by AssetsManager to load meshes
  152169. */
  152170. export class MeshAssetTask extends AbstractAssetTask {
  152171. /**
  152172. * Defines the name of the task
  152173. */
  152174. name: string;
  152175. /**
  152176. * Defines the list of mesh's names you want to load
  152177. */
  152178. meshesNames: any;
  152179. /**
  152180. * Defines the root url to use as a base to load your meshes and associated resources
  152181. */
  152182. rootUrl: string;
  152183. /**
  152184. * Defines the filename or File of the scene to load from
  152185. */
  152186. sceneFilename: string | File;
  152187. /**
  152188. * Gets the list of loaded meshes
  152189. */
  152190. loadedMeshes: Array<AbstractMesh>;
  152191. /**
  152192. * Gets the list of loaded particle systems
  152193. */
  152194. loadedParticleSystems: Array<IParticleSystem>;
  152195. /**
  152196. * Gets the list of loaded skeletons
  152197. */
  152198. loadedSkeletons: Array<Skeleton>;
  152199. /**
  152200. * Gets the list of loaded animation groups
  152201. */
  152202. loadedAnimationGroups: Array<AnimationGroup>;
  152203. /**
  152204. * Callback called when the task is successful
  152205. */
  152206. onSuccess: (task: MeshAssetTask) => void;
  152207. /**
  152208. * Callback called when the task is successful
  152209. */
  152210. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  152211. /**
  152212. * Creates a new MeshAssetTask
  152213. * @param name defines the name of the task
  152214. * @param meshesNames defines the list of mesh's names you want to load
  152215. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152216. * @param sceneFilename defines the filename or File of the scene to load from
  152217. */
  152218. constructor(
  152219. /**
  152220. * Defines the name of the task
  152221. */
  152222. name: string,
  152223. /**
  152224. * Defines the list of mesh's names you want to load
  152225. */
  152226. meshesNames: any,
  152227. /**
  152228. * Defines the root url to use as a base to load your meshes and associated resources
  152229. */
  152230. rootUrl: string,
  152231. /**
  152232. * Defines the filename or File of the scene to load from
  152233. */
  152234. sceneFilename: string | File);
  152235. /**
  152236. * Execute the current task
  152237. * @param scene defines the scene where you want your assets to be loaded
  152238. * @param onSuccess is a callback called when the task is successfully executed
  152239. * @param onError is a callback called if an error occurs
  152240. */
  152241. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152242. }
  152243. /**
  152244. * Define a task used by AssetsManager to load text content
  152245. */
  152246. export class TextFileAssetTask extends AbstractAssetTask {
  152247. /**
  152248. * Defines the name of the task
  152249. */
  152250. name: string;
  152251. /**
  152252. * Defines the location of the file to load
  152253. */
  152254. url: string;
  152255. /**
  152256. * Gets the loaded text string
  152257. */
  152258. text: string;
  152259. /**
  152260. * Callback called when the task is successful
  152261. */
  152262. onSuccess: (task: TextFileAssetTask) => void;
  152263. /**
  152264. * Callback called when the task is successful
  152265. */
  152266. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  152267. /**
  152268. * Creates a new TextFileAssetTask object
  152269. * @param name defines the name of the task
  152270. * @param url defines the location of the file to load
  152271. */
  152272. constructor(
  152273. /**
  152274. * Defines the name of the task
  152275. */
  152276. name: string,
  152277. /**
  152278. * Defines the location of the file to load
  152279. */
  152280. url: string);
  152281. /**
  152282. * Execute the current task
  152283. * @param scene defines the scene where you want your assets to be loaded
  152284. * @param onSuccess is a callback called when the task is successfully executed
  152285. * @param onError is a callback called if an error occurs
  152286. */
  152287. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152288. }
  152289. /**
  152290. * Define a task used by AssetsManager to load binary data
  152291. */
  152292. export class BinaryFileAssetTask extends AbstractAssetTask {
  152293. /**
  152294. * Defines the name of the task
  152295. */
  152296. name: string;
  152297. /**
  152298. * Defines the location of the file to load
  152299. */
  152300. url: string;
  152301. /**
  152302. * Gets the lodaded data (as an array buffer)
  152303. */
  152304. data: ArrayBuffer;
  152305. /**
  152306. * Callback called when the task is successful
  152307. */
  152308. onSuccess: (task: BinaryFileAssetTask) => void;
  152309. /**
  152310. * Callback called when the task is successful
  152311. */
  152312. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  152313. /**
  152314. * Creates a new BinaryFileAssetTask object
  152315. * @param name defines the name of the new task
  152316. * @param url defines the location of the file to load
  152317. */
  152318. constructor(
  152319. /**
  152320. * Defines the name of the task
  152321. */
  152322. name: string,
  152323. /**
  152324. * Defines the location of the file to load
  152325. */
  152326. url: string);
  152327. /**
  152328. * Execute the current task
  152329. * @param scene defines the scene where you want your assets to be loaded
  152330. * @param onSuccess is a callback called when the task is successfully executed
  152331. * @param onError is a callback called if an error occurs
  152332. */
  152333. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152334. }
  152335. /**
  152336. * Define a task used by AssetsManager to load images
  152337. */
  152338. export class ImageAssetTask extends AbstractAssetTask {
  152339. /**
  152340. * Defines the name of the task
  152341. */
  152342. name: string;
  152343. /**
  152344. * Defines the location of the image to load
  152345. */
  152346. url: string;
  152347. /**
  152348. * Gets the loaded images
  152349. */
  152350. image: HTMLImageElement;
  152351. /**
  152352. * Callback called when the task is successful
  152353. */
  152354. onSuccess: (task: ImageAssetTask) => void;
  152355. /**
  152356. * Callback called when the task is successful
  152357. */
  152358. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  152359. /**
  152360. * Creates a new ImageAssetTask
  152361. * @param name defines the name of the task
  152362. * @param url defines the location of the image to load
  152363. */
  152364. constructor(
  152365. /**
  152366. * Defines the name of the task
  152367. */
  152368. name: string,
  152369. /**
  152370. * Defines the location of the image to load
  152371. */
  152372. url: string);
  152373. /**
  152374. * Execute the current task
  152375. * @param scene defines the scene where you want your assets to be loaded
  152376. * @param onSuccess is a callback called when the task is successfully executed
  152377. * @param onError is a callback called if an error occurs
  152378. */
  152379. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152380. }
  152381. /**
  152382. * Defines the interface used by texture loading tasks
  152383. */
  152384. export interface ITextureAssetTask<TEX extends BaseTexture> {
  152385. /**
  152386. * Gets the loaded texture
  152387. */
  152388. texture: TEX;
  152389. }
  152390. /**
  152391. * Define a task used by AssetsManager to load 2D textures
  152392. */
  152393. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  152394. /**
  152395. * Defines the name of the task
  152396. */
  152397. name: string;
  152398. /**
  152399. * Defines the location of the file to load
  152400. */
  152401. url: string;
  152402. /**
  152403. * Defines if mipmap should not be generated (default is false)
  152404. */
  152405. noMipmap?: boolean | undefined;
  152406. /**
  152407. * Defines if texture must be inverted on Y axis (default is true)
  152408. */
  152409. invertY: boolean;
  152410. /**
  152411. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152412. */
  152413. samplingMode: number;
  152414. /**
  152415. * Gets the loaded texture
  152416. */
  152417. texture: Texture;
  152418. /**
  152419. * Callback called when the task is successful
  152420. */
  152421. onSuccess: (task: TextureAssetTask) => void;
  152422. /**
  152423. * Callback called when the task is successful
  152424. */
  152425. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  152426. /**
  152427. * Creates a new TextureAssetTask object
  152428. * @param name defines the name of the task
  152429. * @param url defines the location of the file to load
  152430. * @param noMipmap defines if mipmap should not be generated (default is false)
  152431. * @param invertY defines if texture must be inverted on Y axis (default is true)
  152432. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152433. */
  152434. constructor(
  152435. /**
  152436. * Defines the name of the task
  152437. */
  152438. name: string,
  152439. /**
  152440. * Defines the location of the file to load
  152441. */
  152442. url: string,
  152443. /**
  152444. * Defines if mipmap should not be generated (default is false)
  152445. */
  152446. noMipmap?: boolean | undefined,
  152447. /**
  152448. * Defines if texture must be inverted on Y axis (default is true)
  152449. */
  152450. invertY?: boolean,
  152451. /**
  152452. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152453. */
  152454. samplingMode?: number);
  152455. /**
  152456. * Execute the current task
  152457. * @param scene defines the scene where you want your assets to be loaded
  152458. * @param onSuccess is a callback called when the task is successfully executed
  152459. * @param onError is a callback called if an error occurs
  152460. */
  152461. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152462. }
  152463. /**
  152464. * Define a task used by AssetsManager to load cube textures
  152465. */
  152466. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  152467. /**
  152468. * Defines the name of the task
  152469. */
  152470. name: string;
  152471. /**
  152472. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152473. */
  152474. url: string;
  152475. /**
  152476. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152477. */
  152478. extensions?: string[] | undefined;
  152479. /**
  152480. * Defines if mipmaps should not be generated (default is false)
  152481. */
  152482. noMipmap?: boolean | undefined;
  152483. /**
  152484. * Defines the explicit list of files (undefined by default)
  152485. */
  152486. files?: string[] | undefined;
  152487. /**
  152488. * Gets the loaded texture
  152489. */
  152490. texture: CubeTexture;
  152491. /**
  152492. * Callback called when the task is successful
  152493. */
  152494. onSuccess: (task: CubeTextureAssetTask) => void;
  152495. /**
  152496. * Callback called when the task is successful
  152497. */
  152498. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  152499. /**
  152500. * Creates a new CubeTextureAssetTask
  152501. * @param name defines the name of the task
  152502. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152503. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152504. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152505. * @param files defines the explicit list of files (undefined by default)
  152506. */
  152507. constructor(
  152508. /**
  152509. * Defines the name of the task
  152510. */
  152511. name: string,
  152512. /**
  152513. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152514. */
  152515. url: string,
  152516. /**
  152517. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152518. */
  152519. extensions?: string[] | undefined,
  152520. /**
  152521. * Defines if mipmaps should not be generated (default is false)
  152522. */
  152523. noMipmap?: boolean | undefined,
  152524. /**
  152525. * Defines the explicit list of files (undefined by default)
  152526. */
  152527. files?: string[] | undefined);
  152528. /**
  152529. * Execute the current task
  152530. * @param scene defines the scene where you want your assets to be loaded
  152531. * @param onSuccess is a callback called when the task is successfully executed
  152532. * @param onError is a callback called if an error occurs
  152533. */
  152534. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152535. }
  152536. /**
  152537. * Define a task used by AssetsManager to load HDR cube textures
  152538. */
  152539. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  152540. /**
  152541. * Defines the name of the task
  152542. */
  152543. name: string;
  152544. /**
  152545. * Defines the location of the file to load
  152546. */
  152547. url: string;
  152548. /**
  152549. * Defines the desired size (the more it increases the longer the generation will be)
  152550. */
  152551. size: number;
  152552. /**
  152553. * Defines if mipmaps should not be generated (default is false)
  152554. */
  152555. noMipmap: boolean;
  152556. /**
  152557. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152558. */
  152559. generateHarmonics: boolean;
  152560. /**
  152561. * 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)
  152562. */
  152563. gammaSpace: boolean;
  152564. /**
  152565. * Internal Use Only
  152566. */
  152567. reserved: boolean;
  152568. /**
  152569. * Gets the loaded texture
  152570. */
  152571. texture: HDRCubeTexture;
  152572. /**
  152573. * Callback called when the task is successful
  152574. */
  152575. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  152576. /**
  152577. * Callback called when the task is successful
  152578. */
  152579. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  152580. /**
  152581. * Creates a new HDRCubeTextureAssetTask object
  152582. * @param name defines the name of the task
  152583. * @param url defines the location of the file to load
  152584. * @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.
  152585. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152586. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152587. * @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)
  152588. * @param reserved Internal use only
  152589. */
  152590. constructor(
  152591. /**
  152592. * Defines the name of the task
  152593. */
  152594. name: string,
  152595. /**
  152596. * Defines the location of the file to load
  152597. */
  152598. url: string,
  152599. /**
  152600. * Defines the desired size (the more it increases the longer the generation will be)
  152601. */
  152602. size: number,
  152603. /**
  152604. * Defines if mipmaps should not be generated (default is false)
  152605. */
  152606. noMipmap?: boolean,
  152607. /**
  152608. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152609. */
  152610. generateHarmonics?: boolean,
  152611. /**
  152612. * 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)
  152613. */
  152614. gammaSpace?: boolean,
  152615. /**
  152616. * Internal Use Only
  152617. */
  152618. reserved?: boolean);
  152619. /**
  152620. * Execute the current task
  152621. * @param scene defines the scene where you want your assets to be loaded
  152622. * @param onSuccess is a callback called when the task is successfully executed
  152623. * @param onError is a callback called if an error occurs
  152624. */
  152625. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152626. }
  152627. /**
  152628. * Define a task used by AssetsManager to load Equirectangular cube textures
  152629. */
  152630. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  152631. /**
  152632. * Defines the name of the task
  152633. */
  152634. name: string;
  152635. /**
  152636. * Defines the location of the file to load
  152637. */
  152638. url: string;
  152639. /**
  152640. * Defines the desired size (the more it increases the longer the generation will be)
  152641. */
  152642. size: number;
  152643. /**
  152644. * Defines if mipmaps should not be generated (default is false)
  152645. */
  152646. noMipmap: boolean;
  152647. /**
  152648. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152649. * but the standard material would require them in Gamma space) (default is true)
  152650. */
  152651. gammaSpace: boolean;
  152652. /**
  152653. * Gets the loaded texture
  152654. */
  152655. texture: EquiRectangularCubeTexture;
  152656. /**
  152657. * Callback called when the task is successful
  152658. */
  152659. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  152660. /**
  152661. * Callback called when the task is successful
  152662. */
  152663. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  152664. /**
  152665. * Creates a new EquiRectangularCubeTextureAssetTask object
  152666. * @param name defines the name of the task
  152667. * @param url defines the location of the file to load
  152668. * @param size defines the desired size (the more it increases the longer the generation will be)
  152669. * If the size is omitted this implies you are using a preprocessed cubemap.
  152670. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152671. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  152672. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  152673. * (default is true)
  152674. */
  152675. constructor(
  152676. /**
  152677. * Defines the name of the task
  152678. */
  152679. name: string,
  152680. /**
  152681. * Defines the location of the file to load
  152682. */
  152683. url: string,
  152684. /**
  152685. * Defines the desired size (the more it increases the longer the generation will be)
  152686. */
  152687. size: number,
  152688. /**
  152689. * Defines if mipmaps should not be generated (default is false)
  152690. */
  152691. noMipmap?: boolean,
  152692. /**
  152693. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152694. * but the standard material would require them in Gamma space) (default is true)
  152695. */
  152696. gammaSpace?: boolean);
  152697. /**
  152698. * Execute the current task
  152699. * @param scene defines the scene where you want your assets to be loaded
  152700. * @param onSuccess is a callback called when the task is successfully executed
  152701. * @param onError is a callback called if an error occurs
  152702. */
  152703. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152704. }
  152705. /**
  152706. * This class can be used to easily import assets into a scene
  152707. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  152708. */
  152709. export class AssetsManager {
  152710. private _scene;
  152711. private _isLoading;
  152712. protected _tasks: AbstractAssetTask[];
  152713. protected _waitingTasksCount: number;
  152714. protected _totalTasksCount: number;
  152715. /**
  152716. * Callback called when all tasks are processed
  152717. */
  152718. onFinish: (tasks: AbstractAssetTask[]) => void;
  152719. /**
  152720. * Callback called when a task is successful
  152721. */
  152722. onTaskSuccess: (task: AbstractAssetTask) => void;
  152723. /**
  152724. * Callback called when a task had an error
  152725. */
  152726. onTaskError: (task: AbstractAssetTask) => void;
  152727. /**
  152728. * Callback called when a task is done (whatever the result is)
  152729. */
  152730. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  152731. /**
  152732. * Observable called when all tasks are processed
  152733. */
  152734. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  152735. /**
  152736. * Observable called when a task had an error
  152737. */
  152738. onTaskErrorObservable: Observable<AbstractAssetTask>;
  152739. /**
  152740. * Observable called when all tasks were executed
  152741. */
  152742. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  152743. /**
  152744. * Observable called when a task is done (whatever the result is)
  152745. */
  152746. onProgressObservable: Observable<IAssetsProgressEvent>;
  152747. /**
  152748. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  152749. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  152750. */
  152751. useDefaultLoadingScreen: boolean;
  152752. /**
  152753. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  152754. * when all assets have been downloaded.
  152755. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  152756. */
  152757. autoHideLoadingUI: boolean;
  152758. /**
  152759. * Creates a new AssetsManager
  152760. * @param scene defines the scene to work on
  152761. */
  152762. constructor(scene: Scene);
  152763. /**
  152764. * Add a ContainerAssetTask to the list of active tasks
  152765. * @param taskName defines the name of the new task
  152766. * @param meshesNames defines the name of meshes to load
  152767. * @param rootUrl defines the root url to use to locate files
  152768. * @param sceneFilename defines the filename of the scene file
  152769. * @returns a new ContainerAssetTask object
  152770. */
  152771. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  152772. /**
  152773. * Add a MeshAssetTask to the list of active tasks
  152774. * @param taskName defines the name of the new task
  152775. * @param meshesNames defines the name of meshes to load
  152776. * @param rootUrl defines the root url to use to locate files
  152777. * @param sceneFilename defines the filename of the scene file
  152778. * @returns a new MeshAssetTask object
  152779. */
  152780. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  152781. /**
  152782. * Add a TextFileAssetTask to the list of active tasks
  152783. * @param taskName defines the name of the new task
  152784. * @param url defines the url of the file to load
  152785. * @returns a new TextFileAssetTask object
  152786. */
  152787. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  152788. /**
  152789. * Add a BinaryFileAssetTask to the list of active tasks
  152790. * @param taskName defines the name of the new task
  152791. * @param url defines the url of the file to load
  152792. * @returns a new BinaryFileAssetTask object
  152793. */
  152794. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  152795. /**
  152796. * Add a ImageAssetTask to the list of active tasks
  152797. * @param taskName defines the name of the new task
  152798. * @param url defines the url of the file to load
  152799. * @returns a new ImageAssetTask object
  152800. */
  152801. addImageTask(taskName: string, url: string): ImageAssetTask;
  152802. /**
  152803. * Add a TextureAssetTask to the list of active tasks
  152804. * @param taskName defines the name of the new task
  152805. * @param url defines the url of the file to load
  152806. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152807. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  152808. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  152809. * @returns a new TextureAssetTask object
  152810. */
  152811. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  152812. /**
  152813. * Add a CubeTextureAssetTask to the list of active tasks
  152814. * @param taskName defines the name of the new task
  152815. * @param url defines the url of the file to load
  152816. * @param extensions defines the extension to use to load the cube map (can be null)
  152817. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152818. * @param files defines the list of files to load (can be null)
  152819. * @returns a new CubeTextureAssetTask object
  152820. */
  152821. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  152822. /**
  152823. *
  152824. * Add a HDRCubeTextureAssetTask to the list of active tasks
  152825. * @param taskName defines the name of the new task
  152826. * @param url defines the url of the file to load
  152827. * @param size defines the size you want for the cubemap (can be null)
  152828. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152829. * @param generateHarmonics defines if you want to automatically generate (true by default)
  152830. * @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)
  152831. * @param reserved Internal use only
  152832. * @returns a new HDRCubeTextureAssetTask object
  152833. */
  152834. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  152835. /**
  152836. *
  152837. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  152838. * @param taskName defines the name of the new task
  152839. * @param url defines the url of the file to load
  152840. * @param size defines the size you want for the cubemap (can be null)
  152841. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152842. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  152843. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  152844. * @returns a new EquiRectangularCubeTextureAssetTask object
  152845. */
  152846. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  152847. /**
  152848. * Remove a task from the assets manager.
  152849. * @param task the task to remove
  152850. */
  152851. removeTask(task: AbstractAssetTask): void;
  152852. private _decreaseWaitingTasksCount;
  152853. private _runTask;
  152854. /**
  152855. * Reset the AssetsManager and remove all tasks
  152856. * @return the current instance of the AssetsManager
  152857. */
  152858. reset(): AssetsManager;
  152859. /**
  152860. * Start the loading process
  152861. * @return the current instance of the AssetsManager
  152862. */
  152863. load(): AssetsManager;
  152864. /**
  152865. * Start the loading process as an async operation
  152866. * @return a promise returning the list of failed tasks
  152867. */
  152868. loadAsync(): Promise<void>;
  152869. }
  152870. }
  152871. declare module BABYLON {
  152872. /**
  152873. * Wrapper class for promise with external resolve and reject.
  152874. */
  152875. export class Deferred<T> {
  152876. /**
  152877. * The promise associated with this deferred object.
  152878. */
  152879. readonly promise: Promise<T>;
  152880. private _resolve;
  152881. private _reject;
  152882. /**
  152883. * The resolve method of the promise associated with this deferred object.
  152884. */
  152885. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  152886. /**
  152887. * The reject method of the promise associated with this deferred object.
  152888. */
  152889. get reject(): (reason?: any) => void;
  152890. /**
  152891. * Constructor for this deferred object.
  152892. */
  152893. constructor();
  152894. }
  152895. }
  152896. declare module BABYLON {
  152897. /**
  152898. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  152899. */
  152900. export class MeshExploder {
  152901. private _centerMesh;
  152902. private _meshes;
  152903. private _meshesOrigins;
  152904. private _toCenterVectors;
  152905. private _scaledDirection;
  152906. private _newPosition;
  152907. private _centerPosition;
  152908. /**
  152909. * Explodes meshes from a center mesh.
  152910. * @param meshes The meshes to explode.
  152911. * @param centerMesh The mesh to be center of explosion.
  152912. */
  152913. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  152914. private _setCenterMesh;
  152915. /**
  152916. * Get class name
  152917. * @returns "MeshExploder"
  152918. */
  152919. getClassName(): string;
  152920. /**
  152921. * "Exploded meshes"
  152922. * @returns Array of meshes with the centerMesh at index 0.
  152923. */
  152924. getMeshes(): Array<Mesh>;
  152925. /**
  152926. * Explodes meshes giving a specific direction
  152927. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  152928. */
  152929. explode(direction?: number): void;
  152930. }
  152931. }
  152932. declare module BABYLON {
  152933. /**
  152934. * Class used to help managing file picking and drag'n'drop
  152935. */
  152936. export class FilesInput {
  152937. /**
  152938. * List of files ready to be loaded
  152939. */
  152940. static get FilesToLoad(): {
  152941. [key: string]: File;
  152942. };
  152943. /**
  152944. * Callback called when a file is processed
  152945. */
  152946. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  152947. private _engine;
  152948. private _currentScene;
  152949. private _sceneLoadedCallback;
  152950. private _progressCallback;
  152951. private _additionalRenderLoopLogicCallback;
  152952. private _textureLoadingCallback;
  152953. private _startingProcessingFilesCallback;
  152954. private _onReloadCallback;
  152955. private _errorCallback;
  152956. private _elementToMonitor;
  152957. private _sceneFileToLoad;
  152958. private _filesToLoad;
  152959. /**
  152960. * Creates a new FilesInput
  152961. * @param engine defines the rendering engine
  152962. * @param scene defines the hosting scene
  152963. * @param sceneLoadedCallback callback called when scene is loaded
  152964. * @param progressCallback callback called to track progress
  152965. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  152966. * @param textureLoadingCallback callback called when a texture is loading
  152967. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  152968. * @param onReloadCallback callback called when a reload is requested
  152969. * @param errorCallback callback call if an error occurs
  152970. */
  152971. 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>);
  152972. private _dragEnterHandler;
  152973. private _dragOverHandler;
  152974. private _dropHandler;
  152975. /**
  152976. * Calls this function to listen to drag'n'drop events on a specific DOM element
  152977. * @param elementToMonitor defines the DOM element to track
  152978. */
  152979. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  152980. /** Gets the current list of files to load */
  152981. get filesToLoad(): File[];
  152982. /**
  152983. * Release all associated resources
  152984. */
  152985. dispose(): void;
  152986. private renderFunction;
  152987. private drag;
  152988. private drop;
  152989. private _traverseFolder;
  152990. private _processFiles;
  152991. /**
  152992. * Load files from a drop event
  152993. * @param event defines the drop event to use as source
  152994. */
  152995. loadFiles(event: any): void;
  152996. private _processReload;
  152997. /**
  152998. * Reload the current scene from the loaded files
  152999. */
  153000. reload(): void;
  153001. }
  153002. }
  153003. declare module BABYLON {
  153004. /**
  153005. * Defines the root class used to create scene optimization to use with SceneOptimizer
  153006. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153007. */
  153008. export class SceneOptimization {
  153009. /**
  153010. * Defines the priority of this optimization (0 by default which means first in the list)
  153011. */
  153012. priority: number;
  153013. /**
  153014. * Gets a string describing the action executed by the current optimization
  153015. * @returns description string
  153016. */
  153017. getDescription(): string;
  153018. /**
  153019. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153020. * @param scene defines the current scene where to apply this optimization
  153021. * @param optimizer defines the current optimizer
  153022. * @returns true if everything that can be done was applied
  153023. */
  153024. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153025. /**
  153026. * Creates the SceneOptimization object
  153027. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153028. * @param desc defines the description associated with the optimization
  153029. */
  153030. constructor(
  153031. /**
  153032. * Defines the priority of this optimization (0 by default which means first in the list)
  153033. */
  153034. priority?: number);
  153035. }
  153036. /**
  153037. * Defines an optimization used to reduce the size of render target textures
  153038. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153039. */
  153040. export class TextureOptimization extends SceneOptimization {
  153041. /**
  153042. * Defines the priority of this optimization (0 by default which means first in the list)
  153043. */
  153044. priority: number;
  153045. /**
  153046. * 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
  153047. */
  153048. maximumSize: number;
  153049. /**
  153050. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153051. */
  153052. step: number;
  153053. /**
  153054. * Gets a string describing the action executed by the current optimization
  153055. * @returns description string
  153056. */
  153057. getDescription(): string;
  153058. /**
  153059. * Creates the TextureOptimization object
  153060. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153061. * @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
  153062. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153063. */
  153064. constructor(
  153065. /**
  153066. * Defines the priority of this optimization (0 by default which means first in the list)
  153067. */
  153068. priority?: number,
  153069. /**
  153070. * 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
  153071. */
  153072. maximumSize?: number,
  153073. /**
  153074. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153075. */
  153076. step?: number);
  153077. /**
  153078. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153079. * @param scene defines the current scene where to apply this optimization
  153080. * @param optimizer defines the current optimizer
  153081. * @returns true if everything that can be done was applied
  153082. */
  153083. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153084. }
  153085. /**
  153086. * Defines an optimization used to increase or decrease the rendering resolution
  153087. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153088. */
  153089. export class HardwareScalingOptimization extends SceneOptimization {
  153090. /**
  153091. * Defines the priority of this optimization (0 by default which means first in the list)
  153092. */
  153093. priority: number;
  153094. /**
  153095. * Defines the maximum scale to use (2 by default)
  153096. */
  153097. maximumScale: number;
  153098. /**
  153099. * Defines the step to use between two passes (0.5 by default)
  153100. */
  153101. step: number;
  153102. private _currentScale;
  153103. private _directionOffset;
  153104. /**
  153105. * Gets a string describing the action executed by the current optimization
  153106. * @return description string
  153107. */
  153108. getDescription(): string;
  153109. /**
  153110. * Creates the HardwareScalingOptimization object
  153111. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153112. * @param maximumScale defines the maximum scale to use (2 by default)
  153113. * @param step defines the step to use between two passes (0.5 by default)
  153114. */
  153115. constructor(
  153116. /**
  153117. * Defines the priority of this optimization (0 by default which means first in the list)
  153118. */
  153119. priority?: number,
  153120. /**
  153121. * Defines the maximum scale to use (2 by default)
  153122. */
  153123. maximumScale?: number,
  153124. /**
  153125. * Defines the step to use between two passes (0.5 by default)
  153126. */
  153127. step?: number);
  153128. /**
  153129. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153130. * @param scene defines the current scene where to apply this optimization
  153131. * @param optimizer defines the current optimizer
  153132. * @returns true if everything that can be done was applied
  153133. */
  153134. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153135. }
  153136. /**
  153137. * Defines an optimization used to remove shadows
  153138. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153139. */
  153140. export class ShadowsOptimization extends SceneOptimization {
  153141. /**
  153142. * Gets a string describing the action executed by the current optimization
  153143. * @return description string
  153144. */
  153145. getDescription(): string;
  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 turn post-processes off
  153156. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153157. */
  153158. export class PostProcessesOptimization 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 lens flares off
  153174. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153175. */
  153176. export class LensFlaresOptimization 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 based on user defined callback.
  153192. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153193. */
  153194. export class CustomOptimization extends SceneOptimization {
  153195. /**
  153196. * Callback called to apply the custom optimization.
  153197. */
  153198. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  153199. /**
  153200. * Callback called to get custom description
  153201. */
  153202. onGetDescription: () => string;
  153203. /**
  153204. * Gets a string describing the action executed by the current optimization
  153205. * @returns description string
  153206. */
  153207. getDescription(): string;
  153208. /**
  153209. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153210. * @param scene defines the current scene where to apply this optimization
  153211. * @param optimizer defines the current optimizer
  153212. * @returns true if everything that can be done was applied
  153213. */
  153214. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153215. }
  153216. /**
  153217. * Defines an optimization used to turn particles off
  153218. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153219. */
  153220. export class ParticlesOptimization extends SceneOptimization {
  153221. /**
  153222. * Gets a string describing the action executed by the current optimization
  153223. * @return 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 render targets off
  153236. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153237. */
  153238. export class RenderTargetsOptimization 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 merge meshes with compatible materials
  153254. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153255. */
  153256. export class MergeMeshesOptimization extends SceneOptimization {
  153257. private static _UpdateSelectionTree;
  153258. /**
  153259. * Gets or sets a boolean which defines if optimization octree has to be updated
  153260. */
  153261. static get UpdateSelectionTree(): boolean;
  153262. /**
  153263. * Gets or sets a boolean which defines if optimization octree has to be updated
  153264. */
  153265. static set UpdateSelectionTree(value: boolean);
  153266. /**
  153267. * Gets a string describing the action executed by the current optimization
  153268. * @return description string
  153269. */
  153270. getDescription(): string;
  153271. private _canBeMerged;
  153272. /**
  153273. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153274. * @param scene defines the current scene where to apply this optimization
  153275. * @param optimizer defines the current optimizer
  153276. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  153277. * @returns true if everything that can be done was applied
  153278. */
  153279. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  153280. }
  153281. /**
  153282. * Defines a list of options used by SceneOptimizer
  153283. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153284. */
  153285. export class SceneOptimizerOptions {
  153286. /**
  153287. * Defines the target frame rate to reach (60 by default)
  153288. */
  153289. targetFrameRate: number;
  153290. /**
  153291. * Defines the interval between two checkes (2000ms by default)
  153292. */
  153293. trackerDuration: number;
  153294. /**
  153295. * Gets the list of optimizations to apply
  153296. */
  153297. optimizations: SceneOptimization[];
  153298. /**
  153299. * Creates a new list of options used by SceneOptimizer
  153300. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  153301. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  153302. */
  153303. constructor(
  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. * Add a new optimization
  153314. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  153315. * @returns the current SceneOptimizerOptions
  153316. */
  153317. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  153318. /**
  153319. * Add a new custom optimization
  153320. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  153321. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  153322. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153323. * @returns the current SceneOptimizerOptions
  153324. */
  153325. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  153326. /**
  153327. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  153328. * @param targetFrameRate defines the target frame rate (60 by default)
  153329. * @returns a SceneOptimizerOptions object
  153330. */
  153331. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153332. /**
  153333. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  153334. * @param targetFrameRate defines the target frame rate (60 by default)
  153335. * @returns a SceneOptimizerOptions object
  153336. */
  153337. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153338. /**
  153339. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  153340. * @param targetFrameRate defines the target frame rate (60 by default)
  153341. * @returns a SceneOptimizerOptions object
  153342. */
  153343. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153344. }
  153345. /**
  153346. * Class used to run optimizations in order to reach a target frame rate
  153347. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153348. */
  153349. export class SceneOptimizer implements IDisposable {
  153350. private _isRunning;
  153351. private _options;
  153352. private _scene;
  153353. private _currentPriorityLevel;
  153354. private _targetFrameRate;
  153355. private _trackerDuration;
  153356. private _currentFrameRate;
  153357. private _sceneDisposeObserver;
  153358. private _improvementMode;
  153359. /**
  153360. * Defines an observable called when the optimizer reaches the target frame rate
  153361. */
  153362. onSuccessObservable: Observable<SceneOptimizer>;
  153363. /**
  153364. * Defines an observable called when the optimizer enables an optimization
  153365. */
  153366. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  153367. /**
  153368. * Defines an observable called when the optimizer is not able to reach the target frame rate
  153369. */
  153370. onFailureObservable: Observable<SceneOptimizer>;
  153371. /**
  153372. * Gets a boolean indicating if the optimizer is in improvement mode
  153373. */
  153374. get isInImprovementMode(): boolean;
  153375. /**
  153376. * Gets the current priority level (0 at start)
  153377. */
  153378. get currentPriorityLevel(): number;
  153379. /**
  153380. * Gets the current frame rate checked by the SceneOptimizer
  153381. */
  153382. get currentFrameRate(): number;
  153383. /**
  153384. * Gets or sets the current target frame rate (60 by default)
  153385. */
  153386. get targetFrameRate(): number;
  153387. /**
  153388. * Gets or sets the current target frame rate (60 by default)
  153389. */
  153390. set targetFrameRate(value: number);
  153391. /**
  153392. * Gets or sets the current interval between two checks (every 2000ms by default)
  153393. */
  153394. get trackerDuration(): number;
  153395. /**
  153396. * Gets or sets the current interval between two checks (every 2000ms by default)
  153397. */
  153398. set trackerDuration(value: number);
  153399. /**
  153400. * Gets the list of active optimizations
  153401. */
  153402. get optimizations(): SceneOptimization[];
  153403. /**
  153404. * Creates a new SceneOptimizer
  153405. * @param scene defines the scene to work on
  153406. * @param options defines the options to use with the SceneOptimizer
  153407. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  153408. * @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)
  153409. */
  153410. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  153411. /**
  153412. * Stops the current optimizer
  153413. */
  153414. stop(): void;
  153415. /**
  153416. * Reset the optimizer to initial step (current priority level = 0)
  153417. */
  153418. reset(): void;
  153419. /**
  153420. * Start the optimizer. By default it will try to reach a specific framerate
  153421. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  153422. */
  153423. start(): void;
  153424. private _checkCurrentState;
  153425. /**
  153426. * Release all resources
  153427. */
  153428. dispose(): void;
  153429. /**
  153430. * Helper function to create a SceneOptimizer with one single line of code
  153431. * @param scene defines the scene to work on
  153432. * @param options defines the options to use with the SceneOptimizer
  153433. * @param onSuccess defines a callback to call on success
  153434. * @param onFailure defines a callback to call on failure
  153435. * @returns the new SceneOptimizer object
  153436. */
  153437. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  153438. }
  153439. }
  153440. declare module BABYLON {
  153441. /**
  153442. * Class used to serialize a scene into a string
  153443. */
  153444. export class SceneSerializer {
  153445. /**
  153446. * Clear cache used by a previous serialization
  153447. */
  153448. static ClearCache(): void;
  153449. /**
  153450. * Serialize a scene into a JSON compatible object
  153451. * @param scene defines the scene to serialize
  153452. * @returns a JSON compatible object
  153453. */
  153454. static Serialize(scene: Scene): any;
  153455. /**
  153456. * Serialize a mesh into a JSON compatible object
  153457. * @param toSerialize defines the mesh to serialize
  153458. * @param withParents defines if parents must be serialized as well
  153459. * @param withChildren defines if children must be serialized as well
  153460. * @returns a JSON compatible object
  153461. */
  153462. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  153463. }
  153464. }
  153465. declare module BABYLON {
  153466. /**
  153467. * Class used to host texture specific utilities
  153468. */
  153469. export class TextureTools {
  153470. /**
  153471. * Uses the GPU to create a copy texture rescaled at a given size
  153472. * @param texture Texture to copy from
  153473. * @param width defines the desired width
  153474. * @param height defines the desired height
  153475. * @param useBilinearMode defines if bilinear mode has to be used
  153476. * @return the generated texture
  153477. */
  153478. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  153479. }
  153480. }
  153481. declare module BABYLON {
  153482. /**
  153483. * This represents the different options available for the video capture.
  153484. */
  153485. export interface VideoRecorderOptions {
  153486. /** Defines the mime type of the video. */
  153487. mimeType: string;
  153488. /** Defines the FPS the video should be recorded at. */
  153489. fps: number;
  153490. /** Defines the chunk size for the recording data. */
  153491. recordChunckSize: number;
  153492. /** The audio tracks to attach to the recording. */
  153493. audioTracks?: MediaStreamTrack[];
  153494. }
  153495. /**
  153496. * This can help with recording videos from BabylonJS.
  153497. * This is based on the available WebRTC functionalities of the browser.
  153498. *
  153499. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  153500. */
  153501. export class VideoRecorder {
  153502. private static readonly _defaultOptions;
  153503. /**
  153504. * Returns whether or not the VideoRecorder is available in your browser.
  153505. * @param engine Defines the Babylon Engine.
  153506. * @returns true if supported otherwise false.
  153507. */
  153508. static IsSupported(engine: Engine): boolean;
  153509. private readonly _options;
  153510. private _canvas;
  153511. private _mediaRecorder;
  153512. private _recordedChunks;
  153513. private _fileName;
  153514. private _resolve;
  153515. private _reject;
  153516. /**
  153517. * True when a recording is already in progress.
  153518. */
  153519. get isRecording(): boolean;
  153520. /**
  153521. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  153522. * @param engine Defines the BabylonJS Engine you wish to record.
  153523. * @param options Defines options that can be used to customize the capture.
  153524. */
  153525. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  153526. /**
  153527. * Stops the current recording before the default capture timeout passed in the startRecording function.
  153528. */
  153529. stopRecording(): void;
  153530. /**
  153531. * Starts recording the canvas for a max duration specified in parameters.
  153532. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  153533. * If null no automatic download will start and you can rely on the promise to get the data back.
  153534. * @param maxDuration Defines the maximum recording time in seconds.
  153535. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  153536. * @return A promise callback at the end of the recording with the video data in Blob.
  153537. */
  153538. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  153539. /**
  153540. * Releases internal resources used during the recording.
  153541. */
  153542. dispose(): void;
  153543. private _handleDataAvailable;
  153544. private _handleError;
  153545. private _handleStop;
  153546. }
  153547. }
  153548. declare module BABYLON {
  153549. /**
  153550. * Class containing a set of static utilities functions for screenshots
  153551. */
  153552. export class ScreenshotTools {
  153553. /**
  153554. * Captures a screenshot of the current rendering
  153555. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153556. * @param engine defines the rendering engine
  153557. * @param camera defines the source camera
  153558. * @param size This parameter can be set to a single number or to an object with the
  153559. * following (optional) properties: precision, width, height. If a single number is passed,
  153560. * it will be used for both width and height. If an object is passed, the screenshot size
  153561. * will be derived from the parameters. The precision property is a multiplier allowing
  153562. * rendering at a higher or lower resolution
  153563. * @param successCallback defines the callback receives a single parameter which contains the
  153564. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153565. * src parameter of an <img> to display it
  153566. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153567. * Check your browser for supported MIME types
  153568. */
  153569. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  153570. /**
  153571. * Captures a screenshot of the current rendering
  153572. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153573. * @param engine defines the rendering engine
  153574. * @param camera defines the source camera
  153575. * @param size This parameter can be set to a single number or to an object with the
  153576. * following (optional) properties: precision, width, height. If a single number is passed,
  153577. * it will be used for both width and height. If an object is passed, the screenshot size
  153578. * will be derived from the parameters. The precision property is a multiplier allowing
  153579. * rendering at a higher or lower resolution
  153580. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153581. * Check your browser for supported MIME types
  153582. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153583. * to the src parameter of an <img> to display it
  153584. */
  153585. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  153586. /**
  153587. * Generates an image screenshot from the specified camera.
  153588. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153589. * @param engine The engine to use for rendering
  153590. * @param camera The camera to use for rendering
  153591. * @param size This parameter can be set to a single number or to an object with the
  153592. * following (optional) properties: precision, width, height. If a single number is passed,
  153593. * it will be used for both width and height. If an object is passed, the screenshot size
  153594. * will be derived from the parameters. The precision property is a multiplier allowing
  153595. * rendering at a higher or lower resolution
  153596. * @param successCallback The callback receives a single parameter which contains the
  153597. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153598. * src parameter of an <img> to display it
  153599. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153600. * Check your browser for supported MIME types
  153601. * @param samples Texture samples (default: 1)
  153602. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153603. * @param fileName A name for for the downloaded file.
  153604. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153605. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  153606. */
  153607. 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;
  153608. /**
  153609. * Generates an image screenshot from the specified camera.
  153610. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153611. * @param engine The engine to use for rendering
  153612. * @param camera The camera to use for rendering
  153613. * @param size This parameter can be set to a single number or to an object with the
  153614. * following (optional) properties: precision, width, height. If a single number is passed,
  153615. * it will be used for both width and height. If an object is passed, the screenshot size
  153616. * will be derived from the parameters. The precision property is a multiplier allowing
  153617. * rendering at a higher or lower resolution
  153618. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153619. * Check your browser for supported MIME types
  153620. * @param samples Texture samples (default: 1)
  153621. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153622. * @param fileName A name for for the downloaded file.
  153623. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153624. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153625. * to the src parameter of an <img> to display it
  153626. */
  153627. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  153628. /**
  153629. * Gets height and width for screenshot size
  153630. * @private
  153631. */
  153632. private static _getScreenshotSize;
  153633. }
  153634. }
  153635. declare module BABYLON {
  153636. /**
  153637. * Interface for a data buffer
  153638. */
  153639. export interface IDataBuffer {
  153640. /**
  153641. * Reads bytes from the data buffer.
  153642. * @param byteOffset The byte offset to read
  153643. * @param byteLength The byte length to read
  153644. * @returns A promise that resolves when the bytes are read
  153645. */
  153646. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  153647. /**
  153648. * The byte length of the buffer.
  153649. */
  153650. readonly byteLength: number;
  153651. }
  153652. /**
  153653. * Utility class for reading from a data buffer
  153654. */
  153655. export class DataReader {
  153656. /**
  153657. * The data buffer associated with this data reader.
  153658. */
  153659. readonly buffer: IDataBuffer;
  153660. /**
  153661. * The current byte offset from the beginning of the data buffer.
  153662. */
  153663. byteOffset: number;
  153664. private _dataView;
  153665. private _dataByteOffset;
  153666. /**
  153667. * Constructor
  153668. * @param buffer The buffer to read
  153669. */
  153670. constructor(buffer: IDataBuffer);
  153671. /**
  153672. * Loads the given byte length.
  153673. * @param byteLength The byte length to load
  153674. * @returns A promise that resolves when the load is complete
  153675. */
  153676. loadAsync(byteLength: number): Promise<void>;
  153677. /**
  153678. * Read a unsigned 32-bit integer from the currently loaded data range.
  153679. * @returns The 32-bit integer read
  153680. */
  153681. readUint32(): number;
  153682. /**
  153683. * Read a byte array from the currently loaded data range.
  153684. * @param byteLength The byte length to read
  153685. * @returns The byte array read
  153686. */
  153687. readUint8Array(byteLength: number): Uint8Array;
  153688. /**
  153689. * Read a string from the currently loaded data range.
  153690. * @param byteLength The byte length to read
  153691. * @returns The string read
  153692. */
  153693. readString(byteLength: number): string;
  153694. /**
  153695. * Skips the given byte length the currently loaded data range.
  153696. * @param byteLength The byte length to skip
  153697. */
  153698. skipBytes(byteLength: number): void;
  153699. }
  153700. }
  153701. declare module BABYLON {
  153702. /**
  153703. * Class for storing data to local storage if available or in-memory storage otherwise
  153704. */
  153705. export class DataStorage {
  153706. private static _Storage;
  153707. private static _GetStorage;
  153708. /**
  153709. * Reads a string from the data storage
  153710. * @param key The key to read
  153711. * @param defaultValue The value if the key doesn't exist
  153712. * @returns The string value
  153713. */
  153714. static ReadString(key: string, defaultValue: string): string;
  153715. /**
  153716. * Writes a string to the data storage
  153717. * @param key The key to write
  153718. * @param value The value to write
  153719. */
  153720. static WriteString(key: string, value: string): void;
  153721. /**
  153722. * Reads a boolean from the data storage
  153723. * @param key The key to read
  153724. * @param defaultValue The value if the key doesn't exist
  153725. * @returns The boolean value
  153726. */
  153727. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  153728. /**
  153729. * Writes a boolean to the data storage
  153730. * @param key The key to write
  153731. * @param value The value to write
  153732. */
  153733. static WriteBoolean(key: string, value: boolean): void;
  153734. /**
  153735. * Reads a number from the data storage
  153736. * @param key The key to read
  153737. * @param defaultValue The value if the key doesn't exist
  153738. * @returns The number value
  153739. */
  153740. static ReadNumber(key: string, defaultValue: number): number;
  153741. /**
  153742. * Writes a number to the data storage
  153743. * @param key The key to write
  153744. * @param value The value to write
  153745. */
  153746. static WriteNumber(key: string, value: number): void;
  153747. }
  153748. }
  153749. declare module BABYLON {
  153750. /**
  153751. * Class used to record delta files between 2 scene states
  153752. */
  153753. export class SceneRecorder {
  153754. private _trackedScene;
  153755. private _savedJSON;
  153756. /**
  153757. * Track a given scene. This means the current scene state will be considered the original state
  153758. * @param scene defines the scene to track
  153759. */
  153760. track(scene: Scene): void;
  153761. /**
  153762. * Get the delta between current state and original state
  153763. * @returns a string containing the delta
  153764. */
  153765. getDelta(): any;
  153766. private _compareArray;
  153767. private _compareObjects;
  153768. private _compareCollections;
  153769. private static GetShadowGeneratorById;
  153770. /**
  153771. * Apply a given delta to a given scene
  153772. * @param deltaJSON defines the JSON containing the delta
  153773. * @param scene defines the scene to apply the delta to
  153774. */
  153775. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  153776. private static _ApplyPropertiesToEntity;
  153777. private static _ApplyDeltaForEntity;
  153778. }
  153779. }
  153780. declare module BABYLON {
  153781. /**
  153782. * An interface for all Hit test features
  153783. */
  153784. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  153785. /**
  153786. * Triggered when new babylon (transformed) hit test results are available
  153787. */
  153788. onHitTestResultObservable: Observable<T[]>;
  153789. }
  153790. /**
  153791. * Options used for hit testing
  153792. */
  153793. export interface IWebXRLegacyHitTestOptions {
  153794. /**
  153795. * Only test when user interacted with the scene. Default - hit test every frame
  153796. */
  153797. testOnPointerDownOnly?: boolean;
  153798. /**
  153799. * The node to use to transform the local results to world coordinates
  153800. */
  153801. worldParentNode?: TransformNode;
  153802. }
  153803. /**
  153804. * Interface defining the babylon result of raycasting/hit-test
  153805. */
  153806. export interface IWebXRLegacyHitResult {
  153807. /**
  153808. * Transformation matrix that can be applied to a node that will put it in the hit point location
  153809. */
  153810. transformationMatrix: Matrix;
  153811. /**
  153812. * The native hit test result
  153813. */
  153814. xrHitResult: XRHitResult | XRHitTestResult;
  153815. }
  153816. /**
  153817. * The currently-working hit-test module.
  153818. * Hit test (or Ray-casting) is used to interact with the real world.
  153819. * For further information read here - https://github.com/immersive-web/hit-test
  153820. */
  153821. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  153822. /**
  153823. * options to use when constructing this feature
  153824. */
  153825. readonly options: IWebXRLegacyHitTestOptions;
  153826. private _direction;
  153827. private _mat;
  153828. private _onSelectEnabled;
  153829. private _origin;
  153830. /**
  153831. * The module's name
  153832. */
  153833. static readonly Name: string;
  153834. /**
  153835. * The (Babylon) version of this module.
  153836. * This is an integer representing the implementation version.
  153837. * This number does not correspond to the WebXR specs version
  153838. */
  153839. static readonly Version: number;
  153840. /**
  153841. * Populated with the last native XR Hit Results
  153842. */
  153843. lastNativeXRHitResults: XRHitResult[];
  153844. /**
  153845. * Triggered when new babylon (transformed) hit test results are available
  153846. */
  153847. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  153848. /**
  153849. * Creates a new instance of the (legacy version) hit test feature
  153850. * @param _xrSessionManager an instance of WebXRSessionManager
  153851. * @param options options to use when constructing this feature
  153852. */
  153853. constructor(_xrSessionManager: WebXRSessionManager,
  153854. /**
  153855. * options to use when constructing this feature
  153856. */
  153857. options?: IWebXRLegacyHitTestOptions);
  153858. /**
  153859. * execute a hit test with an XR Ray
  153860. *
  153861. * @param xrSession a native xrSession that will execute this hit test
  153862. * @param xrRay the ray (position and direction) to use for ray-casting
  153863. * @param referenceSpace native XR reference space to use for the hit-test
  153864. * @param filter filter function that will filter the results
  153865. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153866. */
  153867. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  153868. /**
  153869. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  153870. * @param event the (select) event to use to select with
  153871. * @param referenceSpace the reference space to use for this hit test
  153872. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153873. */
  153874. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  153875. /**
  153876. * attach this feature
  153877. * Will usually be called by the features manager
  153878. *
  153879. * @returns true if successful.
  153880. */
  153881. attach(): boolean;
  153882. /**
  153883. * detach this feature.
  153884. * Will usually be called by the features manager
  153885. *
  153886. * @returns true if successful.
  153887. */
  153888. detach(): boolean;
  153889. /**
  153890. * Dispose this feature and all of the resources attached
  153891. */
  153892. dispose(): void;
  153893. protected _onXRFrame(frame: XRFrame): void;
  153894. private _onHitTestResults;
  153895. private _onSelect;
  153896. }
  153897. }
  153898. declare module BABYLON {
  153899. /**
  153900. * Options used for hit testing (version 2)
  153901. */
  153902. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  153903. /**
  153904. * Do not create a permanent hit test. Will usually be used when only
  153905. * transient inputs are needed.
  153906. */
  153907. disablePermanentHitTest?: boolean;
  153908. /**
  153909. * Enable transient (for example touch-based) hit test inspections
  153910. */
  153911. enableTransientHitTest?: boolean;
  153912. /**
  153913. * Offset ray for the permanent hit test
  153914. */
  153915. offsetRay?: Vector3;
  153916. /**
  153917. * Offset ray for the transient hit test
  153918. */
  153919. transientOffsetRay?: Vector3;
  153920. /**
  153921. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  153922. */
  153923. useReferenceSpace?: boolean;
  153924. /**
  153925. * Override the default entity type(s) of the hit-test result
  153926. */
  153927. entityTypes?: XRHitTestTrackableType[];
  153928. }
  153929. /**
  153930. * Interface defining the babylon result of hit-test
  153931. */
  153932. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  153933. /**
  153934. * The input source that generated this hit test (if transient)
  153935. */
  153936. inputSource?: XRInputSource;
  153937. /**
  153938. * Is this a transient hit test
  153939. */
  153940. isTransient?: boolean;
  153941. /**
  153942. * Position of the hit test result
  153943. */
  153944. position: Vector3;
  153945. /**
  153946. * Rotation of the hit test result
  153947. */
  153948. rotationQuaternion: Quaternion;
  153949. /**
  153950. * The native hit test result
  153951. */
  153952. xrHitResult: XRHitTestResult;
  153953. }
  153954. /**
  153955. * The currently-working hit-test module.
  153956. * Hit test (or Ray-casting) is used to interact with the real world.
  153957. * For further information read here - https://github.com/immersive-web/hit-test
  153958. *
  153959. * Tested on chrome (mobile) 80.
  153960. */
  153961. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  153962. /**
  153963. * options to use when constructing this feature
  153964. */
  153965. readonly options: IWebXRHitTestOptions;
  153966. private _tmpMat;
  153967. private _tmpPos;
  153968. private _tmpQuat;
  153969. private _transientXrHitTestSource;
  153970. private _xrHitTestSource;
  153971. private initHitTestSource;
  153972. /**
  153973. * The module's name
  153974. */
  153975. static readonly Name: string;
  153976. /**
  153977. * The (Babylon) version of this module.
  153978. * This is an integer representing the implementation version.
  153979. * This number does not correspond to the WebXR specs version
  153980. */
  153981. static readonly Version: number;
  153982. /**
  153983. * When set to true, each hit test will have its own position/rotation objects
  153984. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  153985. * the developers will clone them or copy them as they see fit.
  153986. */
  153987. autoCloneTransformation: boolean;
  153988. /**
  153989. * Triggered when new babylon (transformed) hit test results are available
  153990. */
  153991. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  153992. /**
  153993. * Use this to temporarily pause hit test checks.
  153994. */
  153995. paused: boolean;
  153996. /**
  153997. * Creates a new instance of the hit test feature
  153998. * @param _xrSessionManager an instance of WebXRSessionManager
  153999. * @param options options to use when constructing this feature
  154000. */
  154001. constructor(_xrSessionManager: WebXRSessionManager,
  154002. /**
  154003. * options to use when constructing this feature
  154004. */
  154005. options?: IWebXRHitTestOptions);
  154006. /**
  154007. * attach this feature
  154008. * Will usually be called by the features manager
  154009. *
  154010. * @returns true if successful.
  154011. */
  154012. attach(): boolean;
  154013. /**
  154014. * detach this feature.
  154015. * Will usually be called by the features manager
  154016. *
  154017. * @returns true if successful.
  154018. */
  154019. detach(): boolean;
  154020. /**
  154021. * Dispose this feature and all of the resources attached
  154022. */
  154023. dispose(): void;
  154024. protected _onXRFrame(frame: XRFrame): void;
  154025. private _processWebXRHitTestResult;
  154026. }
  154027. }
  154028. declare module BABYLON {
  154029. /**
  154030. * Configuration options of the anchor system
  154031. */
  154032. export interface IWebXRAnchorSystemOptions {
  154033. /**
  154034. * a node that will be used to convert local to world coordinates
  154035. */
  154036. worldParentNode?: TransformNode;
  154037. /**
  154038. * If set to true a reference of the created anchors will be kept until the next session starts
  154039. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  154040. */
  154041. doNotRemoveAnchorsOnSessionEnded?: boolean;
  154042. }
  154043. /**
  154044. * A babylon container for an XR Anchor
  154045. */
  154046. export interface IWebXRAnchor {
  154047. /**
  154048. * A babylon-assigned ID for this anchor
  154049. */
  154050. id: number;
  154051. /**
  154052. * Transformation matrix to apply to an object attached to this anchor
  154053. */
  154054. transformationMatrix: Matrix;
  154055. /**
  154056. * The native anchor object
  154057. */
  154058. xrAnchor: XRAnchor;
  154059. /**
  154060. * if defined, this object will be constantly updated by the anchor's position and rotation
  154061. */
  154062. attachedNode?: TransformNode;
  154063. }
  154064. /**
  154065. * An implementation of the anchor system for WebXR.
  154066. * For further information see https://github.com/immersive-web/anchors/
  154067. */
  154068. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  154069. private _options;
  154070. private _lastFrameDetected;
  154071. private _trackedAnchors;
  154072. private _referenceSpaceForFrameAnchors;
  154073. private _futureAnchors;
  154074. /**
  154075. * The module's name
  154076. */
  154077. static readonly Name: string;
  154078. /**
  154079. * The (Babylon) version of this module.
  154080. * This is an integer representing the implementation version.
  154081. * This number does not correspond to the WebXR specs version
  154082. */
  154083. static readonly Version: number;
  154084. /**
  154085. * Observers registered here will be executed when a new anchor was added to the session
  154086. */
  154087. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  154088. /**
  154089. * Observers registered here will be executed when an anchor was removed from the session
  154090. */
  154091. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  154092. /**
  154093. * Observers registered here will be executed when an existing anchor updates
  154094. * This can execute N times every frame
  154095. */
  154096. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  154097. /**
  154098. * Set the reference space to use for anchor creation, when not using a hit test.
  154099. * Will default to the session's reference space if not defined
  154100. */
  154101. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  154102. /**
  154103. * constructs a new anchor system
  154104. * @param _xrSessionManager an instance of WebXRSessionManager
  154105. * @param _options configuration object for this feature
  154106. */
  154107. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  154108. private _tmpVector;
  154109. private _tmpQuaternion;
  154110. private _populateTmpTransformation;
  154111. /**
  154112. * Create a new anchor point using a hit test result at a specific point in the scene
  154113. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154114. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154115. *
  154116. * @param hitTestResult The hit test result to use for this anchor creation
  154117. * @param position an optional position offset for this anchor
  154118. * @param rotationQuaternion an optional rotation offset for this anchor
  154119. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154120. */
  154121. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  154122. /**
  154123. * Add a new anchor at a specific position and rotation
  154124. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  154125. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  154126. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154127. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154128. *
  154129. * @param position the position in which to add an anchor
  154130. * @param rotationQuaternion an optional rotation for the anchor transformation
  154131. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  154132. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154133. */
  154134. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  154135. /**
  154136. * detach this feature.
  154137. * Will usually be called by the features manager
  154138. *
  154139. * @returns true if successful.
  154140. */
  154141. detach(): boolean;
  154142. /**
  154143. * Dispose this feature and all of the resources attached
  154144. */
  154145. dispose(): void;
  154146. protected _onXRFrame(frame: XRFrame): void;
  154147. /**
  154148. * avoiding using Array.find for global support.
  154149. * @param xrAnchor the plane to find in the array
  154150. */
  154151. private _findIndexInAnchorArray;
  154152. private _updateAnchorWithXRFrame;
  154153. private _createAnchorAtTransformation;
  154154. }
  154155. }
  154156. declare module BABYLON {
  154157. /**
  154158. * Options used in the plane detector module
  154159. */
  154160. export interface IWebXRPlaneDetectorOptions {
  154161. /**
  154162. * The node to use to transform the local results to world coordinates
  154163. */
  154164. worldParentNode?: TransformNode;
  154165. /**
  154166. * If set to true a reference of the created planes will be kept until the next session starts
  154167. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  154168. */
  154169. doNotRemovePlanesOnSessionEnded?: boolean;
  154170. }
  154171. /**
  154172. * A babylon interface for a WebXR plane.
  154173. * A Plane is actually a polygon, built from N points in space
  154174. *
  154175. * Supported in chrome 79, not supported in canary 81 ATM
  154176. */
  154177. export interface IWebXRPlane {
  154178. /**
  154179. * a babylon-assigned ID for this polygon
  154180. */
  154181. id: number;
  154182. /**
  154183. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  154184. */
  154185. polygonDefinition: Array<Vector3>;
  154186. /**
  154187. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  154188. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  154189. */
  154190. transformationMatrix: Matrix;
  154191. /**
  154192. * the native xr-plane object
  154193. */
  154194. xrPlane: XRPlane;
  154195. }
  154196. /**
  154197. * The plane detector is used to detect planes in the real world when in AR
  154198. * For more information see https://github.com/immersive-web/real-world-geometry/
  154199. */
  154200. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  154201. private _options;
  154202. private _detectedPlanes;
  154203. private _enabled;
  154204. private _lastFrameDetected;
  154205. /**
  154206. * The module's name
  154207. */
  154208. static readonly Name: string;
  154209. /**
  154210. * The (Babylon) version of this module.
  154211. * This is an integer representing the implementation version.
  154212. * This number does not correspond to the WebXR specs version
  154213. */
  154214. static readonly Version: number;
  154215. /**
  154216. * Observers registered here will be executed when a new plane was added to the session
  154217. */
  154218. onPlaneAddedObservable: Observable<IWebXRPlane>;
  154219. /**
  154220. * Observers registered here will be executed when a plane is no longer detected in the session
  154221. */
  154222. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  154223. /**
  154224. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  154225. * This can execute N times every frame
  154226. */
  154227. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  154228. /**
  154229. * construct a new Plane Detector
  154230. * @param _xrSessionManager an instance of xr Session manager
  154231. * @param _options configuration to use when constructing this feature
  154232. */
  154233. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  154234. /**
  154235. * detach this feature.
  154236. * Will usually be called by the features manager
  154237. *
  154238. * @returns true if successful.
  154239. */
  154240. detach(): boolean;
  154241. /**
  154242. * Dispose this feature and all of the resources attached
  154243. */
  154244. dispose(): void;
  154245. protected _onXRFrame(frame: XRFrame): void;
  154246. private _init;
  154247. private _updatePlaneWithXRPlane;
  154248. /**
  154249. * avoiding using Array.find for global support.
  154250. * @param xrPlane the plane to find in the array
  154251. */
  154252. private findIndexInPlaneArray;
  154253. }
  154254. }
  154255. declare module BABYLON {
  154256. /**
  154257. * Options interface for the background remover plugin
  154258. */
  154259. export interface IWebXRBackgroundRemoverOptions {
  154260. /**
  154261. * Further background meshes to disable when entering AR
  154262. */
  154263. backgroundMeshes?: AbstractMesh[];
  154264. /**
  154265. * flags to configure the removal of the environment helper.
  154266. * If not set, the entire background will be removed. If set, flags should be set as well.
  154267. */
  154268. environmentHelperRemovalFlags?: {
  154269. /**
  154270. * Should the skybox be removed (default false)
  154271. */
  154272. skyBox?: boolean;
  154273. /**
  154274. * Should the ground be removed (default false)
  154275. */
  154276. ground?: boolean;
  154277. };
  154278. /**
  154279. * don't disable the environment helper
  154280. */
  154281. ignoreEnvironmentHelper?: boolean;
  154282. }
  154283. /**
  154284. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  154285. */
  154286. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  154287. /**
  154288. * read-only options to be used in this module
  154289. */
  154290. readonly options: IWebXRBackgroundRemoverOptions;
  154291. /**
  154292. * The module's name
  154293. */
  154294. static readonly Name: string;
  154295. /**
  154296. * The (Babylon) version of this module.
  154297. * This is an integer representing the implementation version.
  154298. * This number does not correspond to the WebXR specs version
  154299. */
  154300. static readonly Version: number;
  154301. /**
  154302. * registered observers will be triggered when the background state changes
  154303. */
  154304. onBackgroundStateChangedObservable: Observable<boolean>;
  154305. /**
  154306. * constructs a new background remover module
  154307. * @param _xrSessionManager the session manager for this module
  154308. * @param options read-only options to be used in this module
  154309. */
  154310. constructor(_xrSessionManager: WebXRSessionManager,
  154311. /**
  154312. * read-only options to be used in this module
  154313. */
  154314. options?: IWebXRBackgroundRemoverOptions);
  154315. /**
  154316. * attach this feature
  154317. * Will usually be called by the features manager
  154318. *
  154319. * @returns true if successful.
  154320. */
  154321. attach(): boolean;
  154322. /**
  154323. * detach this feature.
  154324. * Will usually be called by the features manager
  154325. *
  154326. * @returns true if successful.
  154327. */
  154328. detach(): boolean;
  154329. /**
  154330. * Dispose this feature and all of the resources attached
  154331. */
  154332. dispose(): void;
  154333. protected _onXRFrame(_xrFrame: XRFrame): void;
  154334. private _setBackgroundState;
  154335. }
  154336. }
  154337. declare module BABYLON {
  154338. /**
  154339. * Options for the controller physics feature
  154340. */
  154341. export class IWebXRControllerPhysicsOptions {
  154342. /**
  154343. * Should the headset get its own impostor
  154344. */
  154345. enableHeadsetImpostor?: boolean;
  154346. /**
  154347. * Optional parameters for the headset impostor
  154348. */
  154349. headsetImpostorParams?: {
  154350. /**
  154351. * The type of impostor to create. Default is sphere
  154352. */
  154353. impostorType: number;
  154354. /**
  154355. * the size of the impostor. Defaults to 10cm
  154356. */
  154357. impostorSize?: number | {
  154358. width: number;
  154359. height: number;
  154360. depth: number;
  154361. };
  154362. /**
  154363. * Friction definitions
  154364. */
  154365. friction?: number;
  154366. /**
  154367. * Restitution
  154368. */
  154369. restitution?: number;
  154370. };
  154371. /**
  154372. * The physics properties of the future impostors
  154373. */
  154374. physicsProperties?: {
  154375. /**
  154376. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  154377. * Note that this requires a physics engine that supports mesh impostors!
  154378. */
  154379. useControllerMesh?: boolean;
  154380. /**
  154381. * The type of impostor to create. Default is sphere
  154382. */
  154383. impostorType?: number;
  154384. /**
  154385. * the size of the impostor. Defaults to 10cm
  154386. */
  154387. impostorSize?: number | {
  154388. width: number;
  154389. height: number;
  154390. depth: number;
  154391. };
  154392. /**
  154393. * Friction definitions
  154394. */
  154395. friction?: number;
  154396. /**
  154397. * Restitution
  154398. */
  154399. restitution?: number;
  154400. };
  154401. /**
  154402. * the xr input to use with this pointer selection
  154403. */
  154404. xrInput: WebXRInput;
  154405. }
  154406. /**
  154407. * Add physics impostor to your webxr controllers,
  154408. * including naive calculation of their linear and angular velocity
  154409. */
  154410. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  154411. private readonly _options;
  154412. private _attachController;
  154413. private _controllers;
  154414. private _debugMode;
  154415. private _delta;
  154416. private _headsetImpostor?;
  154417. private _headsetMesh?;
  154418. private _lastTimestamp;
  154419. private _tmpQuaternion;
  154420. private _tmpVector;
  154421. /**
  154422. * The module's name
  154423. */
  154424. static readonly Name: string;
  154425. /**
  154426. * The (Babylon) version of this module.
  154427. * This is an integer representing the implementation version.
  154428. * This number does not correspond to the webxr specs version
  154429. */
  154430. static readonly Version: number;
  154431. /**
  154432. * Construct a new Controller Physics Feature
  154433. * @param _xrSessionManager the corresponding xr session manager
  154434. * @param _options options to create this feature with
  154435. */
  154436. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  154437. /**
  154438. * @hidden
  154439. * enable debugging - will show console outputs and the impostor mesh
  154440. */
  154441. _enablePhysicsDebug(): void;
  154442. /**
  154443. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  154444. * @param xrController the controller to add
  154445. */
  154446. addController(xrController: WebXRInputSource): void;
  154447. /**
  154448. * attach this feature
  154449. * Will usually be called by the features manager
  154450. *
  154451. * @returns true if successful.
  154452. */
  154453. attach(): boolean;
  154454. /**
  154455. * detach this feature.
  154456. * Will usually be called by the features manager
  154457. *
  154458. * @returns true if successful.
  154459. */
  154460. detach(): boolean;
  154461. /**
  154462. * Get the headset impostor, if enabled
  154463. * @returns the impostor
  154464. */
  154465. getHeadsetImpostor(): PhysicsImpostor | undefined;
  154466. /**
  154467. * Get the physics impostor of a specific controller.
  154468. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  154469. * @param controller the controller or the controller id of which to get the impostor
  154470. * @returns the impostor or null
  154471. */
  154472. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  154473. /**
  154474. * Update the physics properties provided in the constructor
  154475. * @param newProperties the new properties object
  154476. */
  154477. setPhysicsProperties(newProperties: {
  154478. impostorType?: number;
  154479. impostorSize?: number | {
  154480. width: number;
  154481. height: number;
  154482. depth: number;
  154483. };
  154484. friction?: number;
  154485. restitution?: number;
  154486. }): void;
  154487. protected _onXRFrame(_xrFrame: any): void;
  154488. private _detachController;
  154489. }
  154490. }
  154491. declare module BABYLON {
  154492. /**
  154493. * A babylon interface for a "WebXR" feature point.
  154494. * Represents the position and confidence value of a given feature point.
  154495. */
  154496. export interface IWebXRFeaturePoint {
  154497. /**
  154498. * Represents the position of the feature point in world space.
  154499. */
  154500. position: Vector3;
  154501. /**
  154502. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  154503. */
  154504. confidenceValue: number;
  154505. }
  154506. /**
  154507. * The feature point system is used to detect feature points from real world geometry.
  154508. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  154509. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  154510. */
  154511. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  154512. private _enabled;
  154513. private _featurePointCloud;
  154514. /**
  154515. * The module's name
  154516. */
  154517. static readonly Name: string;
  154518. /**
  154519. * The (Babylon) version of this module.
  154520. * This is an integer representing the implementation version.
  154521. * This number does not correspond to the WebXR specs version
  154522. */
  154523. static readonly Version: number;
  154524. /**
  154525. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  154526. * Will notify the observers about which feature points have been added.
  154527. */
  154528. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  154529. /**
  154530. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  154531. * Will notify the observers about which feature points have been updated.
  154532. */
  154533. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  154534. /**
  154535. * The current feature point cloud maintained across frames.
  154536. */
  154537. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  154538. /**
  154539. * construct the feature point system
  154540. * @param _xrSessionManager an instance of xr Session manager
  154541. */
  154542. constructor(_xrSessionManager: WebXRSessionManager);
  154543. /**
  154544. * Detach this feature.
  154545. * Will usually be called by the features manager
  154546. *
  154547. * @returns true if successful.
  154548. */
  154549. detach(): boolean;
  154550. /**
  154551. * Dispose this feature and all of the resources attached
  154552. */
  154553. dispose(): void;
  154554. /**
  154555. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  154556. */
  154557. protected _onXRFrame(frame: XRFrame): void;
  154558. /**
  154559. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  154560. */
  154561. private _init;
  154562. }
  154563. }
  154564. declare module BABYLON {
  154565. /**
  154566. * Configuration interface for the hand tracking feature
  154567. */
  154568. export interface IWebXRHandTrackingOptions {
  154569. /**
  154570. * The xrInput that will be used as source for new hands
  154571. */
  154572. xrInput: WebXRInput;
  154573. /**
  154574. * Configuration object for the joint meshes
  154575. */
  154576. jointMeshes?: {
  154577. /**
  154578. * Should the meshes created be invisible (defaults to false)
  154579. */
  154580. invisible?: boolean;
  154581. /**
  154582. * A source mesh to be used to create instances. Defaults to a sphere.
  154583. * This mesh will be the source for all other (25) meshes.
  154584. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  154585. */
  154586. sourceMesh?: Mesh;
  154587. /**
  154588. * Should the source mesh stay visible. Defaults to false
  154589. */
  154590. keepOriginalVisible?: boolean;
  154591. /**
  154592. * Scale factor for all instances (defaults to 2)
  154593. */
  154594. scaleFactor?: number;
  154595. /**
  154596. * Should each instance have its own physics impostor
  154597. */
  154598. enablePhysics?: boolean;
  154599. /**
  154600. * If enabled, override default physics properties
  154601. */
  154602. physicsProps?: {
  154603. friction?: number;
  154604. restitution?: number;
  154605. impostorType?: number;
  154606. };
  154607. /**
  154608. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  154609. */
  154610. handMesh?: AbstractMesh;
  154611. };
  154612. }
  154613. /**
  154614. * Parts of the hands divided to writs and finger names
  154615. */
  154616. export const enum HandPart {
  154617. /**
  154618. * HandPart - Wrist
  154619. */
  154620. WRIST = "wrist",
  154621. /**
  154622. * HandPart - The THumb
  154623. */
  154624. THUMB = "thumb",
  154625. /**
  154626. * HandPart - Index finger
  154627. */
  154628. INDEX = "index",
  154629. /**
  154630. * HandPart - Middle finger
  154631. */
  154632. MIDDLE = "middle",
  154633. /**
  154634. * HandPart - Ring finger
  154635. */
  154636. RING = "ring",
  154637. /**
  154638. * HandPart - Little finger
  154639. */
  154640. LITTLE = "little"
  154641. }
  154642. /**
  154643. * Representing a single hand (with its corresponding native XRHand object)
  154644. */
  154645. export class WebXRHand implements IDisposable {
  154646. /** the controller to which the hand correlates */
  154647. readonly xrController: WebXRInputSource;
  154648. /** the meshes to be used to track the hand joints */
  154649. readonly trackedMeshes: AbstractMesh[];
  154650. /**
  154651. * Hand-parts definition (key is HandPart)
  154652. */
  154653. static HandPartsDefinition: {
  154654. [key: string]: number[];
  154655. };
  154656. /**
  154657. * Populate the HandPartsDefinition object.
  154658. * This is called as a side effect since certain browsers don't have XRHand defined.
  154659. */
  154660. static _PopulateHandPartsDefinition(): void;
  154661. /**
  154662. * Construct a new hand object
  154663. * @param xrController the controller to which the hand correlates
  154664. * @param trackedMeshes the meshes to be used to track the hand joints
  154665. */
  154666. constructor(
  154667. /** the controller to which the hand correlates */
  154668. xrController: WebXRInputSource,
  154669. /** the meshes to be used to track the hand joints */
  154670. trackedMeshes: AbstractMesh[]);
  154671. /**
  154672. * Update this hand from the latest xr frame
  154673. * @param xrFrame xrFrame to update from
  154674. * @param referenceSpace The current viewer reference space
  154675. * @param scaleFactor optional scale factor for the meshes
  154676. */
  154677. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  154678. /**
  154679. * Get meshes of part of the hand
  154680. * @param part the part of hand to get
  154681. * @returns An array of meshes that correlate to the hand part requested
  154682. */
  154683. getHandPartMeshes(part: HandPart): AbstractMesh[];
  154684. /**
  154685. * Dispose this Hand object
  154686. */
  154687. dispose(): void;
  154688. }
  154689. /**
  154690. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  154691. */
  154692. export class WebXRHandTracking extends WebXRAbstractFeature {
  154693. /**
  154694. * options to use when constructing this feature
  154695. */
  154696. readonly options: IWebXRHandTrackingOptions;
  154697. private static _idCounter;
  154698. /**
  154699. * The module's name
  154700. */
  154701. static readonly Name: string;
  154702. /**
  154703. * The (Babylon) version of this module.
  154704. * This is an integer representing the implementation version.
  154705. * This number does not correspond to the WebXR specs version
  154706. */
  154707. static readonly Version: number;
  154708. /**
  154709. * This observable will notify registered observers when a new hand object was added and initialized
  154710. */
  154711. onHandAddedObservable: Observable<WebXRHand>;
  154712. /**
  154713. * This observable will notify its observers right before the hand object is disposed
  154714. */
  154715. onHandRemovedObservable: Observable<WebXRHand>;
  154716. private _hands;
  154717. /**
  154718. * Creates a new instance of the hit test feature
  154719. * @param _xrSessionManager an instance of WebXRSessionManager
  154720. * @param options options to use when constructing this feature
  154721. */
  154722. constructor(_xrSessionManager: WebXRSessionManager,
  154723. /**
  154724. * options to use when constructing this feature
  154725. */
  154726. options: IWebXRHandTrackingOptions);
  154727. /**
  154728. * Check if the needed objects are defined.
  154729. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  154730. */
  154731. isCompatible(): boolean;
  154732. /**
  154733. * attach this feature
  154734. * Will usually be called by the features manager
  154735. *
  154736. * @returns true if successful.
  154737. */
  154738. attach(): boolean;
  154739. /**
  154740. * detach this feature.
  154741. * Will usually be called by the features manager
  154742. *
  154743. * @returns true if successful.
  154744. */
  154745. detach(): boolean;
  154746. /**
  154747. * Dispose this feature and all of the resources attached
  154748. */
  154749. dispose(): void;
  154750. /**
  154751. * Get the hand object according to the controller id
  154752. * @param controllerId the controller id to which we want to get the hand
  154753. * @returns null if not found or the WebXRHand object if found
  154754. */
  154755. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  154756. /**
  154757. * Get a hand object according to the requested handedness
  154758. * @param handedness the handedness to request
  154759. * @returns null if not found or the WebXRHand object if found
  154760. */
  154761. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  154762. protected _onXRFrame(_xrFrame: XRFrame): void;
  154763. private _attachHand;
  154764. private _detachHand;
  154765. }
  154766. }
  154767. declare module BABYLON {
  154768. /**
  154769. * The motion controller class for all microsoft mixed reality controllers
  154770. */
  154771. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  154772. protected readonly _mapping: {
  154773. defaultButton: {
  154774. valueNodeName: string;
  154775. unpressedNodeName: string;
  154776. pressedNodeName: string;
  154777. };
  154778. defaultAxis: {
  154779. valueNodeName: string;
  154780. minNodeName: string;
  154781. maxNodeName: string;
  154782. };
  154783. buttons: {
  154784. "xr-standard-trigger": {
  154785. rootNodeName: string;
  154786. componentProperty: string;
  154787. states: string[];
  154788. };
  154789. "xr-standard-squeeze": {
  154790. rootNodeName: string;
  154791. componentProperty: string;
  154792. states: string[];
  154793. };
  154794. "xr-standard-touchpad": {
  154795. rootNodeName: string;
  154796. labelAnchorNodeName: string;
  154797. touchPointNodeName: string;
  154798. };
  154799. "xr-standard-thumbstick": {
  154800. rootNodeName: string;
  154801. componentProperty: string;
  154802. states: string[];
  154803. };
  154804. };
  154805. axes: {
  154806. "xr-standard-touchpad": {
  154807. "x-axis": {
  154808. rootNodeName: string;
  154809. };
  154810. "y-axis": {
  154811. rootNodeName: string;
  154812. };
  154813. };
  154814. "xr-standard-thumbstick": {
  154815. "x-axis": {
  154816. rootNodeName: string;
  154817. };
  154818. "y-axis": {
  154819. rootNodeName: string;
  154820. };
  154821. };
  154822. };
  154823. };
  154824. /**
  154825. * The base url used to load the left and right controller models
  154826. */
  154827. static MODEL_BASE_URL: string;
  154828. /**
  154829. * The name of the left controller model file
  154830. */
  154831. static MODEL_LEFT_FILENAME: string;
  154832. /**
  154833. * The name of the right controller model file
  154834. */
  154835. static MODEL_RIGHT_FILENAME: string;
  154836. profileId: string;
  154837. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154838. protected _getFilenameAndPath(): {
  154839. filename: string;
  154840. path: string;
  154841. };
  154842. protected _getModelLoadingConstraints(): boolean;
  154843. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154844. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154845. protected _updateModel(): void;
  154846. }
  154847. }
  154848. declare module BABYLON {
  154849. /**
  154850. * The motion controller class for oculus touch (quest, rift).
  154851. * This class supports legacy mapping as well the standard xr mapping
  154852. */
  154853. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  154854. private _forceLegacyControllers;
  154855. private _modelRootNode;
  154856. /**
  154857. * The base url used to load the left and right controller models
  154858. */
  154859. static MODEL_BASE_URL: string;
  154860. /**
  154861. * The name of the left controller model file
  154862. */
  154863. static MODEL_LEFT_FILENAME: string;
  154864. /**
  154865. * The name of the right controller model file
  154866. */
  154867. static MODEL_RIGHT_FILENAME: string;
  154868. /**
  154869. * Base Url for the Quest controller model.
  154870. */
  154871. static QUEST_MODEL_BASE_URL: string;
  154872. profileId: string;
  154873. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  154874. protected _getFilenameAndPath(): {
  154875. filename: string;
  154876. path: string;
  154877. };
  154878. protected _getModelLoadingConstraints(): boolean;
  154879. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154880. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154881. protected _updateModel(): void;
  154882. /**
  154883. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  154884. * between the touch and touch 2.
  154885. */
  154886. private _isQuest;
  154887. }
  154888. }
  154889. declare module BABYLON {
  154890. /**
  154891. * The motion controller class for the standard HTC-Vive controllers
  154892. */
  154893. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  154894. private _modelRootNode;
  154895. /**
  154896. * The base url used to load the left and right controller models
  154897. */
  154898. static MODEL_BASE_URL: string;
  154899. /**
  154900. * File name for the controller model.
  154901. */
  154902. static MODEL_FILENAME: string;
  154903. profileId: string;
  154904. /**
  154905. * Create a new Vive motion controller object
  154906. * @param scene the scene to use to create this controller
  154907. * @param gamepadObject the corresponding gamepad object
  154908. * @param handedness the handedness of the controller
  154909. */
  154910. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154911. protected _getFilenameAndPath(): {
  154912. filename: string;
  154913. path: string;
  154914. };
  154915. protected _getModelLoadingConstraints(): boolean;
  154916. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154917. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154918. protected _updateModel(): void;
  154919. }
  154920. }
  154921. declare module BABYLON {
  154922. /**
  154923. * A cursor which tracks a point on a path
  154924. */
  154925. export class PathCursor {
  154926. private path;
  154927. /**
  154928. * Stores path cursor callbacks for when an onchange event is triggered
  154929. */
  154930. private _onchange;
  154931. /**
  154932. * The value of the path cursor
  154933. */
  154934. value: number;
  154935. /**
  154936. * The animation array of the path cursor
  154937. */
  154938. animations: Animation[];
  154939. /**
  154940. * Initializes the path cursor
  154941. * @param path The path to track
  154942. */
  154943. constructor(path: Path2);
  154944. /**
  154945. * Gets the cursor point on the path
  154946. * @returns A point on the path cursor at the cursor location
  154947. */
  154948. getPoint(): Vector3;
  154949. /**
  154950. * Moves the cursor ahead by the step amount
  154951. * @param step The amount to move the cursor forward
  154952. * @returns This path cursor
  154953. */
  154954. moveAhead(step?: number): PathCursor;
  154955. /**
  154956. * Moves the cursor behind by the step amount
  154957. * @param step The amount to move the cursor back
  154958. * @returns This path cursor
  154959. */
  154960. moveBack(step?: number): PathCursor;
  154961. /**
  154962. * Moves the cursor by the step amount
  154963. * If the step amount is greater than one, an exception is thrown
  154964. * @param step The amount to move the cursor
  154965. * @returns This path cursor
  154966. */
  154967. move(step: number): PathCursor;
  154968. /**
  154969. * Ensures that the value is limited between zero and one
  154970. * @returns This path cursor
  154971. */
  154972. private ensureLimits;
  154973. /**
  154974. * Runs onchange callbacks on change (used by the animation engine)
  154975. * @returns This path cursor
  154976. */
  154977. private raiseOnChange;
  154978. /**
  154979. * Executes a function on change
  154980. * @param f A path cursor onchange callback
  154981. * @returns This path cursor
  154982. */
  154983. onchange(f: (cursor: PathCursor) => void): PathCursor;
  154984. }
  154985. }
  154986. declare module BABYLON {
  154987. /** @hidden */
  154988. export var blurPixelShader: {
  154989. name: string;
  154990. shader: string;
  154991. };
  154992. }
  154993. declare module BABYLON {
  154994. /** @hidden */
  154995. export var pointCloudVertexDeclaration: {
  154996. name: string;
  154997. shader: string;
  154998. };
  154999. }
  155000. // Mixins
  155001. interface Window {
  155002. mozIndexedDB: IDBFactory;
  155003. webkitIndexedDB: IDBFactory;
  155004. msIndexedDB: IDBFactory;
  155005. webkitURL: typeof URL;
  155006. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  155007. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  155008. WebGLRenderingContext: WebGLRenderingContext;
  155009. MSGesture: MSGesture;
  155010. CANNON: any;
  155011. AudioContext: AudioContext;
  155012. webkitAudioContext: AudioContext;
  155013. PointerEvent: any;
  155014. Math: Math;
  155015. Uint8Array: Uint8ArrayConstructor;
  155016. Float32Array: Float32ArrayConstructor;
  155017. mozURL: typeof URL;
  155018. msURL: typeof URL;
  155019. VRFrameData: any; // WebVR, from specs 1.1
  155020. DracoDecoderModule: any;
  155021. setImmediate(handler: (...args: any[]) => void): number;
  155022. }
  155023. interface HTMLCanvasElement {
  155024. requestPointerLock(): void;
  155025. msRequestPointerLock?(): void;
  155026. mozRequestPointerLock?(): void;
  155027. webkitRequestPointerLock?(): void;
  155028. /** Track wether a record is in progress */
  155029. isRecording: boolean;
  155030. /** Capture Stream method defined by some browsers */
  155031. captureStream(fps?: number): MediaStream;
  155032. }
  155033. interface CanvasRenderingContext2D {
  155034. msImageSmoothingEnabled: boolean;
  155035. }
  155036. interface MouseEvent {
  155037. mozMovementX: number;
  155038. mozMovementY: number;
  155039. webkitMovementX: number;
  155040. webkitMovementY: number;
  155041. msMovementX: number;
  155042. msMovementY: number;
  155043. }
  155044. interface Navigator {
  155045. mozGetVRDevices: (any: any) => any;
  155046. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155047. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155048. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155049. webkitGetGamepads(): Gamepad[];
  155050. msGetGamepads(): Gamepad[];
  155051. webkitGamepads(): Gamepad[];
  155052. }
  155053. interface HTMLVideoElement {
  155054. mozSrcObject: any;
  155055. }
  155056. interface Math {
  155057. fround(x: number): number;
  155058. imul(a: number, b: number): number;
  155059. }
  155060. interface WebGLRenderingContext {
  155061. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  155062. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  155063. vertexAttribDivisor(index: number, divisor: number): void;
  155064. createVertexArray(): any;
  155065. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  155066. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  155067. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  155068. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  155069. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  155070. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  155071. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  155072. // Queries
  155073. createQuery(): WebGLQuery;
  155074. deleteQuery(query: WebGLQuery): void;
  155075. beginQuery(target: number, query: WebGLQuery): void;
  155076. endQuery(target: number): void;
  155077. getQueryParameter(query: WebGLQuery, pname: number): any;
  155078. getQuery(target: number, pname: number): any;
  155079. MAX_SAMPLES: number;
  155080. RGBA8: number;
  155081. READ_FRAMEBUFFER: number;
  155082. DRAW_FRAMEBUFFER: number;
  155083. UNIFORM_BUFFER: number;
  155084. HALF_FLOAT_OES: number;
  155085. RGBA16F: number;
  155086. RGBA32F: number;
  155087. R32F: number;
  155088. RG32F: number;
  155089. RGB32F: number;
  155090. R16F: number;
  155091. RG16F: number;
  155092. RGB16F: number;
  155093. RED: number;
  155094. RG: number;
  155095. R8: number;
  155096. RG8: number;
  155097. UNSIGNED_INT_24_8: number;
  155098. DEPTH24_STENCIL8: number;
  155099. MIN: number;
  155100. MAX: number;
  155101. /* Multiple Render Targets */
  155102. drawBuffers(buffers: number[]): void;
  155103. readBuffer(src: number): void;
  155104. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  155105. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  155106. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  155107. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  155108. // Occlusion Query
  155109. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  155110. ANY_SAMPLES_PASSED: number;
  155111. QUERY_RESULT_AVAILABLE: number;
  155112. QUERY_RESULT: number;
  155113. }
  155114. interface WebGLProgram {
  155115. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  155116. }
  155117. interface EXT_disjoint_timer_query {
  155118. QUERY_COUNTER_BITS_EXT: number;
  155119. TIME_ELAPSED_EXT: number;
  155120. TIMESTAMP_EXT: number;
  155121. GPU_DISJOINT_EXT: number;
  155122. QUERY_RESULT_EXT: number;
  155123. QUERY_RESULT_AVAILABLE_EXT: number;
  155124. queryCounterEXT(query: WebGLQuery, target: number): void;
  155125. createQueryEXT(): WebGLQuery;
  155126. beginQueryEXT(target: number, query: WebGLQuery): void;
  155127. endQueryEXT(target: number): void;
  155128. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  155129. deleteQueryEXT(query: WebGLQuery): void;
  155130. }
  155131. interface WebGLUniformLocation {
  155132. _currentState: any;
  155133. }
  155134. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  155135. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  155136. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  155137. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155138. interface WebGLRenderingContext {
  155139. readonly RASTERIZER_DISCARD: number;
  155140. readonly DEPTH_COMPONENT24: number;
  155141. readonly TEXTURE_3D: number;
  155142. readonly TEXTURE_2D_ARRAY: number;
  155143. readonly TEXTURE_COMPARE_FUNC: number;
  155144. readonly TEXTURE_COMPARE_MODE: number;
  155145. readonly COMPARE_REF_TO_TEXTURE: number;
  155146. readonly TEXTURE_WRAP_R: number;
  155147. readonly HALF_FLOAT: number;
  155148. readonly RGB8: number;
  155149. readonly RED_INTEGER: number;
  155150. readonly RG_INTEGER: number;
  155151. readonly RGB_INTEGER: number;
  155152. readonly RGBA_INTEGER: number;
  155153. readonly R8_SNORM: number;
  155154. readonly RG8_SNORM: number;
  155155. readonly RGB8_SNORM: number;
  155156. readonly RGBA8_SNORM: number;
  155157. readonly R8I: number;
  155158. readonly RG8I: number;
  155159. readonly RGB8I: number;
  155160. readonly RGBA8I: number;
  155161. readonly R8UI: number;
  155162. readonly RG8UI: number;
  155163. readonly RGB8UI: number;
  155164. readonly RGBA8UI: number;
  155165. readonly R16I: number;
  155166. readonly RG16I: number;
  155167. readonly RGB16I: number;
  155168. readonly RGBA16I: number;
  155169. readonly R16UI: number;
  155170. readonly RG16UI: number;
  155171. readonly RGB16UI: number;
  155172. readonly RGBA16UI: number;
  155173. readonly R32I: number;
  155174. readonly RG32I: number;
  155175. readonly RGB32I: number;
  155176. readonly RGBA32I: number;
  155177. readonly R32UI: number;
  155178. readonly RG32UI: number;
  155179. readonly RGB32UI: number;
  155180. readonly RGBA32UI: number;
  155181. readonly RGB10_A2UI: number;
  155182. readonly R11F_G11F_B10F: number;
  155183. readonly RGB9_E5: number;
  155184. readonly RGB10_A2: number;
  155185. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  155186. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  155187. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  155188. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  155189. readonly DEPTH_COMPONENT32F: number;
  155190. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  155191. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  155192. 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;
  155193. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  155194. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  155195. readonly TRANSFORM_FEEDBACK: number;
  155196. readonly INTERLEAVED_ATTRIBS: number;
  155197. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  155198. createTransformFeedback(): WebGLTransformFeedback;
  155199. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  155200. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  155201. beginTransformFeedback(primitiveMode: number): void;
  155202. endTransformFeedback(): void;
  155203. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  155204. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155205. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155206. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155207. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  155208. }
  155209. interface ImageBitmap {
  155210. readonly width: number;
  155211. readonly height: number;
  155212. close(): void;
  155213. }
  155214. interface WebGLQuery extends WebGLObject {
  155215. }
  155216. declare var WebGLQuery: {
  155217. prototype: WebGLQuery;
  155218. new(): WebGLQuery;
  155219. };
  155220. interface WebGLSampler extends WebGLObject {
  155221. }
  155222. declare var WebGLSampler: {
  155223. prototype: WebGLSampler;
  155224. new(): WebGLSampler;
  155225. };
  155226. interface WebGLSync extends WebGLObject {
  155227. }
  155228. declare var WebGLSync: {
  155229. prototype: WebGLSync;
  155230. new(): WebGLSync;
  155231. };
  155232. interface WebGLTransformFeedback extends WebGLObject {
  155233. }
  155234. declare var WebGLTransformFeedback: {
  155235. prototype: WebGLTransformFeedback;
  155236. new(): WebGLTransformFeedback;
  155237. };
  155238. interface WebGLVertexArrayObject extends WebGLObject {
  155239. }
  155240. declare var WebGLVertexArrayObject: {
  155241. prototype: WebGLVertexArrayObject;
  155242. new(): WebGLVertexArrayObject;
  155243. };
  155244. // Type definitions for WebVR API
  155245. // Project: https://w3c.github.io/webvr/
  155246. // Definitions by: six a <https://github.com/lostfictions>
  155247. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155248. interface VRDisplay extends EventTarget {
  155249. /**
  155250. * Dictionary of capabilities describing the VRDisplay.
  155251. */
  155252. readonly capabilities: VRDisplayCapabilities;
  155253. /**
  155254. * z-depth defining the far plane of the eye view frustum
  155255. * enables mapping of values in the render target depth
  155256. * attachment to scene coordinates. Initially set to 10000.0.
  155257. */
  155258. depthFar: number;
  155259. /**
  155260. * z-depth defining the near plane of the eye view frustum
  155261. * enables mapping of values in the render target depth
  155262. * attachment to scene coordinates. Initially set to 0.01.
  155263. */
  155264. depthNear: number;
  155265. /**
  155266. * An identifier for this distinct VRDisplay. Used as an
  155267. * association point in the Gamepad API.
  155268. */
  155269. readonly displayId: number;
  155270. /**
  155271. * A display name, a user-readable name identifying it.
  155272. */
  155273. readonly displayName: string;
  155274. readonly isConnected: boolean;
  155275. readonly isPresenting: boolean;
  155276. /**
  155277. * If this VRDisplay supports room-scale experiences, the optional
  155278. * stage attribute contains details on the room-scale parameters.
  155279. */
  155280. readonly stageParameters: VRStageParameters | null;
  155281. /**
  155282. * Passing the value returned by `requestAnimationFrame` to
  155283. * `cancelAnimationFrame` will unregister the callback.
  155284. * @param handle Define the hanle of the request to cancel
  155285. */
  155286. cancelAnimationFrame(handle: number): void;
  155287. /**
  155288. * Stops presenting to the VRDisplay.
  155289. * @returns a promise to know when it stopped
  155290. */
  155291. exitPresent(): Promise<void>;
  155292. /**
  155293. * Return the current VREyeParameters for the given eye.
  155294. * @param whichEye Define the eye we want the parameter for
  155295. * @returns the eye parameters
  155296. */
  155297. getEyeParameters(whichEye: string): VREyeParameters;
  155298. /**
  155299. * Populates the passed VRFrameData with the information required to render
  155300. * the current frame.
  155301. * @param frameData Define the data structure to populate
  155302. * @returns true if ok otherwise false
  155303. */
  155304. getFrameData(frameData: VRFrameData): boolean;
  155305. /**
  155306. * Get the layers currently being presented.
  155307. * @returns the list of VR layers
  155308. */
  155309. getLayers(): VRLayer[];
  155310. /**
  155311. * Return a VRPose containing the future predicted pose of the VRDisplay
  155312. * when the current frame will be presented. The value returned will not
  155313. * change until JavaScript has returned control to the browser.
  155314. *
  155315. * The VRPose will contain the position, orientation, velocity,
  155316. * and acceleration of each of these properties.
  155317. * @returns the pose object
  155318. */
  155319. getPose(): VRPose;
  155320. /**
  155321. * Return the current instantaneous pose of the VRDisplay, with no
  155322. * prediction applied.
  155323. * @returns the current instantaneous pose
  155324. */
  155325. getImmediatePose(): VRPose;
  155326. /**
  155327. * The callback passed to `requestAnimationFrame` will be called
  155328. * any time a new frame should be rendered. When the VRDisplay is
  155329. * presenting the callback will be called at the native refresh
  155330. * rate of the HMD. When not presenting this function acts
  155331. * identically to how window.requestAnimationFrame acts. Content should
  155332. * make no assumptions of frame rate or vsync behavior as the HMD runs
  155333. * asynchronously from other displays and at differing refresh rates.
  155334. * @param callback Define the eaction to run next frame
  155335. * @returns the request handle it
  155336. */
  155337. requestAnimationFrame(callback: FrameRequestCallback): number;
  155338. /**
  155339. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  155340. * Repeat calls while already presenting will update the VRLayers being displayed.
  155341. * @param layers Define the list of layer to present
  155342. * @returns a promise to know when the request has been fulfilled
  155343. */
  155344. requestPresent(layers: VRLayer[]): Promise<void>;
  155345. /**
  155346. * Reset the pose for this display, treating its current position and
  155347. * orientation as the "origin/zero" values. VRPose.position,
  155348. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  155349. * updated when calling resetPose(). This should be called in only
  155350. * sitting-space experiences.
  155351. */
  155352. resetPose(): void;
  155353. /**
  155354. * The VRLayer provided to the VRDisplay will be captured and presented
  155355. * in the HMD. Calling this function has the same effect on the source
  155356. * canvas as any other operation that uses its source image, and canvases
  155357. * created without preserveDrawingBuffer set to true will be cleared.
  155358. * @param pose Define the pose to submit
  155359. */
  155360. submitFrame(pose?: VRPose): void;
  155361. }
  155362. declare var VRDisplay: {
  155363. prototype: VRDisplay;
  155364. new(): VRDisplay;
  155365. };
  155366. interface VRLayer {
  155367. leftBounds?: number[] | Float32Array | null;
  155368. rightBounds?: number[] | Float32Array | null;
  155369. source?: HTMLCanvasElement | null;
  155370. }
  155371. interface VRDisplayCapabilities {
  155372. readonly canPresent: boolean;
  155373. readonly hasExternalDisplay: boolean;
  155374. readonly hasOrientation: boolean;
  155375. readonly hasPosition: boolean;
  155376. readonly maxLayers: number;
  155377. }
  155378. interface VREyeParameters {
  155379. /** @deprecated */
  155380. readonly fieldOfView: VRFieldOfView;
  155381. readonly offset: Float32Array;
  155382. readonly renderHeight: number;
  155383. readonly renderWidth: number;
  155384. }
  155385. interface VRFieldOfView {
  155386. readonly downDegrees: number;
  155387. readonly leftDegrees: number;
  155388. readonly rightDegrees: number;
  155389. readonly upDegrees: number;
  155390. }
  155391. interface VRFrameData {
  155392. readonly leftProjectionMatrix: Float32Array;
  155393. readonly leftViewMatrix: Float32Array;
  155394. readonly pose: VRPose;
  155395. readonly rightProjectionMatrix: Float32Array;
  155396. readonly rightViewMatrix: Float32Array;
  155397. readonly timestamp: number;
  155398. }
  155399. interface VRPose {
  155400. readonly angularAcceleration: Float32Array | null;
  155401. readonly angularVelocity: Float32Array | null;
  155402. readonly linearAcceleration: Float32Array | null;
  155403. readonly linearVelocity: Float32Array | null;
  155404. readonly orientation: Float32Array | null;
  155405. readonly position: Float32Array | null;
  155406. readonly timestamp: number;
  155407. }
  155408. interface VRStageParameters {
  155409. sittingToStandingTransform?: Float32Array;
  155410. sizeX?: number;
  155411. sizeY?: number;
  155412. }
  155413. interface Navigator {
  155414. getVRDisplays(): Promise<VRDisplay[]>;
  155415. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  155416. }
  155417. interface Window {
  155418. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  155419. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  155420. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  155421. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155422. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155423. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  155424. }
  155425. interface Gamepad {
  155426. readonly displayId: number;
  155427. }
  155428. type XRSessionMode = "inline" | "immersive-vr" | "immersive-ar";
  155429. type XRReferenceSpaceType = "viewer" | "local" | "local-floor" | "bounded-floor" | "unbounded";
  155430. type XREnvironmentBlendMode = "opaque" | "additive" | "alpha-blend";
  155431. type XRVisibilityState = "visible" | "visible-blurred" | "hidden";
  155432. type XRHandedness = "none" | "left" | "right";
  155433. type XRTargetRayMode = "gaze" | "tracked-pointer" | "screen";
  155434. type XREye = "none" | "left" | "right";
  155435. type XREventType = "devicechange" | "visibilitychange" | "end" | "inputsourceschange" | "select" | "selectstart" | "selectend" | "squeeze" | "squeezestart" | "squeezeend" | "reset";
  155436. interface XRSpace extends EventTarget {}
  155437. interface XRRenderState {
  155438. depthNear?: number;
  155439. depthFar?: number;
  155440. inlineVerticalFieldOfView?: number;
  155441. baseLayer?: XRWebGLLayer;
  155442. }
  155443. interface XRInputSource {
  155444. handedness: XRHandedness;
  155445. targetRayMode: XRTargetRayMode;
  155446. targetRaySpace: XRSpace;
  155447. gripSpace: XRSpace | undefined;
  155448. gamepad: Gamepad | undefined;
  155449. profiles: Array<string>;
  155450. hand: XRHand | undefined;
  155451. }
  155452. interface XRSessionInit {
  155453. optionalFeatures?: string[];
  155454. requiredFeatures?: string[];
  155455. }
  155456. interface XRSession {
  155457. addEventListener: Function;
  155458. removeEventListener: Function;
  155459. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  155460. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  155461. requestAnimationFrame: Function;
  155462. end(): Promise<void>;
  155463. renderState: XRRenderState;
  155464. inputSources: Array<XRInputSource>;
  155465. // hit test
  155466. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  155467. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  155468. // legacy AR hit test
  155469. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  155470. // legacy plane detection
  155471. updateWorldTrackingState(options: { planeDetectionState?: { enabled: boolean } }): void;
  155472. }
  155473. interface XRReferenceSpace extends XRSpace {
  155474. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  155475. onreset: any;
  155476. }
  155477. type XRPlaneSet = Set<XRPlane>;
  155478. type XRAnchorSet = Set<XRAnchor>;
  155479. interface XRFrame {
  155480. session: XRSession;
  155481. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  155482. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  155483. // AR
  155484. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult>;
  155485. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  155486. // Anchors
  155487. trackedAnchors?: XRAnchorSet;
  155488. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  155489. // Planes
  155490. worldInformation: {
  155491. detectedPlanes?: XRPlaneSet;
  155492. };
  155493. // Hand tracking
  155494. getJointPose(joint: XRJointSpace, baseSpace: XRSpace): XRJointPose;
  155495. }
  155496. interface XRViewerPose extends XRPose {
  155497. views: Array<XRView>;
  155498. }
  155499. interface XRPose {
  155500. transform: XRRigidTransform;
  155501. emulatedPosition: boolean;
  155502. }
  155503. interface XRWebGLLayerOptions {
  155504. antialias?: boolean;
  155505. depth?: boolean;
  155506. stencil?: boolean;
  155507. alpha?: boolean;
  155508. multiview?: boolean;
  155509. framebufferScaleFactor?: number;
  155510. }
  155511. declare var XRWebGLLayer: {
  155512. prototype: XRWebGLLayer;
  155513. new (session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  155514. };
  155515. interface XRWebGLLayer {
  155516. framebuffer: WebGLFramebuffer;
  155517. framebufferWidth: number;
  155518. framebufferHeight: number;
  155519. getViewport: Function;
  155520. }
  155521. declare class XRRigidTransform {
  155522. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  155523. position: DOMPointReadOnly;
  155524. orientation: DOMPointReadOnly;
  155525. matrix: Float32Array;
  155526. inverse: XRRigidTransform;
  155527. }
  155528. interface XRView {
  155529. eye: XREye;
  155530. projectionMatrix: Float32Array;
  155531. transform: XRRigidTransform;
  155532. }
  155533. interface XRInputSourceChangeEvent {
  155534. session: XRSession;
  155535. removed: Array<XRInputSource>;
  155536. added: Array<XRInputSource>;
  155537. }
  155538. interface XRInputSourceEvent extends Event {
  155539. readonly frame: XRFrame;
  155540. readonly inputSource: XRInputSource;
  155541. }
  155542. // Experimental(er) features
  155543. declare class XRRay {
  155544. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  155545. origin: DOMPointReadOnly;
  155546. direction: DOMPointReadOnly;
  155547. matrix: Float32Array;
  155548. }
  155549. declare enum XRHitTestTrackableType {
  155550. "point",
  155551. "plane",
  155552. "mesh",
  155553. }
  155554. interface XRHitResult {
  155555. hitMatrix: Float32Array;
  155556. }
  155557. interface XRTransientInputHitTestResult {
  155558. readonly inputSource: XRInputSource;
  155559. readonly results: Array<XRHitTestResult>;
  155560. }
  155561. interface XRHitTestResult {
  155562. getPose(baseSpace: XRSpace): XRPose | undefined;
  155563. // When anchor system is enabled
  155564. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  155565. }
  155566. interface XRHitTestSource {
  155567. cancel(): void;
  155568. }
  155569. interface XRTransientInputHitTestSource {
  155570. cancel(): void;
  155571. }
  155572. interface XRHitTestOptionsInit {
  155573. space: XRSpace;
  155574. entityTypes?: Array<XRHitTestTrackableType>;
  155575. offsetRay?: XRRay;
  155576. }
  155577. interface XRTransientInputHitTestOptionsInit {
  155578. profile: string;
  155579. entityTypes?: Array<XRHitTestTrackableType>;
  155580. offsetRay?: XRRay;
  155581. }
  155582. interface XRAnchor {
  155583. anchorSpace: XRSpace;
  155584. delete(): void;
  155585. }
  155586. interface XRPlane {
  155587. orientation: "Horizontal" | "Vertical";
  155588. planeSpace: XRSpace;
  155589. polygon: Array<DOMPointReadOnly>;
  155590. lastChangedTime: number;
  155591. }
  155592. interface XRJointSpace extends XRSpace {}
  155593. interface XRJointPose extends XRPose {
  155594. radius: number | undefined;
  155595. }
  155596. declare class XRHand extends Array<XRJointSpace> {
  155597. readonly length: number;
  155598. static readonly WRIST = 0;
  155599. static readonly THUMB_METACARPAL = 1;
  155600. static readonly THUMB_PHALANX_PROXIMAL = 2;
  155601. static readonly THUMB_PHALANX_DISTAL = 3;
  155602. static readonly THUMB_PHALANX_TIP = 4;
  155603. static readonly INDEX_METACARPAL = 5;
  155604. static readonly INDEX_PHALANX_PROXIMAL = 6;
  155605. static readonly INDEX_PHALANX_INTERMEDIATE = 7;
  155606. static readonly INDEX_PHALANX_DISTAL = 8;
  155607. static readonly INDEX_PHALANX_TIP = 9;
  155608. static readonly MIDDLE_METACARPAL = 10;
  155609. static readonly MIDDLE_PHALANX_PROXIMAL = 11;
  155610. static readonly MIDDLE_PHALANX_INTERMEDIATE = 12;
  155611. static readonly MIDDLE_PHALANX_DISTAL = 13;
  155612. static readonly MIDDLE_PHALANX_TIP = 14;
  155613. static readonly RING_METACARPAL = 15;
  155614. static readonly RING_PHALANX_PROXIMAL = 16;
  155615. static readonly RING_PHALANX_INTERMEDIATE = 17;
  155616. static readonly RING_PHALANX_DISTAL = 18;
  155617. static readonly RING_PHALANX_TIP = 19;
  155618. static readonly LITTLE_METACARPAL = 20;
  155619. static readonly LITTLE_PHALANX_PROXIMAL = 21;
  155620. static readonly LITTLE_PHALANX_INTERMEDIATE = 22;
  155621. static readonly LITTLE_PHALANX_DISTAL = 23;
  155622. static readonly LITTLE_PHALANX_TIP = 24;
  155623. }
  155624. // This file contains native only extensions for WebXR These APIs are not supported in the browser yet.
  155625. // They are intended for use with either Babylon Native https://github.com/BabylonJS/BabylonNative or
  155626. // Babylon React Native: https://github.com/BabylonJS/BabylonReactNative
  155627. interface XRSession {
  155628. trySetFeaturePointCloudEnabled(enabled: boolean): boolean;
  155629. }
  155630. interface XRFrame {
  155631. featurePointCloud? : Array<number>;
  155632. }